PYTEST OBJECT GETTER

A Pytest Plugin providing the get_object fixture.

GitHub commits since tagged version (branch)

GitHub commits since latest release (by SemVer)

Code: https://github.com/boromir674/pytest-object-getter
Docs: https://pytest-object-getter.readthedocs.io/en/master/
PyPI: https://pypi.org/project/pytest-object-getter/
CI: https://github.com/boromir674/pytest-object-getter/actions/

Highlights

pytest_object_getter python package, hosted on pypi.org
- Installable with pip
- get_object fixture available to your tests
  1. Dynamically import an object from a module
  2. Optionally mock any object that is present in the module’s namespace
  3. Construct the mock object at runtime
  4. Alter the bahaviour of an object at runtime
Tested against multiple platforms and python versions
- platforms: Ubuntu, MacOS
- python: 3.6, 3.7, 3.8, 3.9, 3.10

For more, see the CI Pipeline and the Test workflow, defined in test.yaml.

You can read more on pytest and fixtures in pytest latest documentation.

Quickstart

Prerequisites

You need to have Python installed.

Installing

Using pip is the approved way for installing pytest_object_getter.

python3 -m pip install pytest_object_getter

After installation the get_object pytest fixture should be available in your tests.

A Use Case

Let’s see how to write a test and use the ‘get_object’ fixture to mock the requests.get method to avoid actual network communication:

python3 -m pip install ask-pypi

import pytest

@pytest.fixture
def mock_response():
    def init(self, package_name: str):
        self.status_code = 200 if package_name == 'existing-package' else 404
    return type('MockResponse', (), {
        '__init__': init
    })

@pytest.fixture
def create_mock_requests(mock_response):
    def _create_mock_requests():
        def mock_get(*args, **kwargs):
            package_name = args[0].split('/')[-1]
            return mock_response(package_name)
        return type('MockRequests', (), {
            'get': mock_get,
        })
    return _create_mock_requests

def test_fixture(get_object, create_mock_requests):

    from ask_pypi import is_pypi_project

    assert is_pypi_project('numpy') == True
    assert is_pypi_project('pandas') == True
    assert is_pypi_project('existing-package') == False

    get_object('is_project', 'ask_pypi.pypi_project',
        overrides={'requests': lambda: create_mock_requests()})

    assert is_pypi_project('existing-package') == True

    assert is_pypi_project('numpy') == False
    assert is_pypi_project('pandas') == False
    assert is_pypi_project('so-magic') == False

License

Free software:

GNU Affero General Public License v3.0

Development

Here are some useful notes related to doing development on this project.

Test Suite, using pytest, located in tests dir
Parallel Execution of Unit Tests, on multiple cpu’s
Documentation Pages, hosted on readthedocs server, located in docs dir
Automation, using tox, driven by single tox.ini file
1. Code Coverage measuring
2. Build Command, using the build python package
3. Pypi Deploy Command, supporting upload to both pypi.org and test.pypi.org servers
4. Type Check Command, using mypy
5. Lint Check and Apply commands, using isort and black
CI Pipeline, running on Github Actions, defined in .github/
1. Job Matrix, spanning different platform’s and python version’s
  1. Platforms: ubuntu-latest, macos-latest
  2. Python Interpreters: 3.6, 3.7, 3.8, 3.9, 3.10
2. Parallel Job execution, generated from the matrix, that runs the Test Suite

Release files for pytest-object-getter 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-object-getter 1.0.2
File	Size	Uploaded
pytest_object_getter-1.0.2.tar.gz	28.0 kB	Jul 31, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for pytest-object-getter 1.0.2
File	Interpreter	ABI	Platform	Reset
pytest_object_getter-1.0.2-py3-none-any.whl 19.4 kB Jul 31, 2022	Python 3	none	any	Details

Total release size: 47.4 kB

Release files / pytest_object_getter-1.0.2.tar.gz

Download URL	pytest_object_getter-1.0.2.tar.gz
Size	28.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`482c6e407d3e67a0de977437434f923a5fcd02503663c19bfccda9985b9d0649`
BLAKE2b-256 checksum How to use checksums	`02fed80930717c5e71028c9fd245cbf647da2062994d49d627c0b3147309abf6`
Upload date	Jul 31, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.0 importlib_metadata/4.11.4 packaging/21.3 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.10`

Release files / pytest_object_getter-1.0.2-py3-none-any.whl

Download URL	pytest_object_getter-1.0.2-py3-none-any.whl
Size	19.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1ca9f06f6827ceeb1621e49e9095401130ae051b45beb516882ca1b4af598dd7`
BLAKE2b-256 checksum How to use checksums	`d67346e99f3099f325310261482f9342c9cd719b08c78e23e83615cf464fa20f`
Upload date	Jul 31, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.0 importlib_metadata/4.11.4 packaging/21.3 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.10`