Skip to main content

Import any object from a 3rd party module while mocking its namespace on demand.

Project description

PYTEST OBJECT GETTER

A Pytest Plugin providing the get_object fixture.

GitHub Workflow Status (branch) Read the Docs (version) Codecov Code Climate Maintainability Better Code Hub Technical Debt
Production Version PyPI - Wheel Supported Python versions GitHub GitHub commits since tagged version (branch) GitHub commits since latest release (by SemVer)

Highlights

  1. 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

  2. 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:

GitHub

Development

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

  1. Test Suite, using pytest, located in tests dir

  2. Parallel Execution of Unit Tests, on multiple cpu’s

  3. Documentation Pages, hosted on readthedocs server, located in docs dir

  4. 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

  5. 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_object_getter-1.0.2.tar.gz (28.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page