pytest-helpers-namespace 2021.3.24

Pytest Helpers Namespace Plugin

Pytest Helpers Namespace

This plugin does not provide any helpers to pytest, it does, however, provide a helpers namespace in pytest which enables you to register helper functions in your conftest.py to be used within your tests without having to import them.

Features

• Provides a helpers pytest namespace which can be used to register helper functions without requiring you to import them on your actual tests to use them.

Requirements

• None!

Installation

You can install “pytest-helpers-namespace” via pip from PyPI:

$ pip install pytest-helpers-namespace

Usage

Consider the following conftest.py file:

import pytest

@pytest.helpers.register
def foo(bar):
    '''
    this dumb helper function will just return what you pass to it
    '''
    return bar

And now consider the following test case:

def test_helper_namespace():
    assert pytest.helpers.foo(True) is True

Pretty simple right?!

You can even nest namespaces. Consider the following conftest.py file:

pytest_plugins = ['helpers_namespace']

import pytest

@pytest.helpers.can.haz.register
def foo(bar):
    '''
    this dumb helper function will just return what you pass to it
    '''
    return bar

And now consider the following test case:

def test_helper_namespace():
    assert pytest.helpers.can.haz.foo(True) is True

You can even pass a name to the register function and that will be the helper function name.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the Apache Software License 2.0 license, “pytest-helpers-namespace” is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Changelog

v2021.3.24

• Switched project to a src layout.

• Switched project to a declarative setuptools approach

• Added support to check if a helper has been registered

v2019.1.8

• Patch PyTest before any conftest.py file is processed.

v2019.1.7

• Support PyTest >= 4.1

v2019.1.6.post1

• No changes were made besides locking to PyTest < 4.0

v2019.1.6

• No changes were made besides locking to PyTest < 4.1

v2017.11.11

• Allow passing a string to the register function which will be the helper name

v2016.7.10

• Allow a registered function to contibue to behave as a regular function. #4.

v2016.4.15

• Hide the FuncWrapper traceback in pytest failures. #3. Thanks Logan Glickfield(@lsglick)

v2016.4.5

• Use a wrapper class instead of adding an attribute to a function.

v2016.4.3

• Provide proper errors when helper functions or namespaces are being overridden. #1

v2016.3.2

• First working release

---

This Pytest plugin was generated with Cookiecutter along with @hackebrot’s Cookiecutter-pytest-plugin template.