Skip to main content

PyTest Helpers Namespace

Project description

See Build Status on Travis CI See Build Status on AppVeyor Code Coverage PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations

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:

pytest_plugins = ['helpers_namespace']

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

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.

Project details


Download files

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

Source Distribution

pytest-helpers-namespace-2019.1.7.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

pytest_helpers_namespace-2019.1.7-py2.py3-none-any.whl (15.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-helpers-namespace-2019.1.7.tar.gz.

File metadata

  • Download URL: pytest-helpers-namespace-2019.1.7.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.6.8

File hashes

Hashes for pytest-helpers-namespace-2019.1.7.tar.gz
Algorithm Hash digest
SHA256 9db8a29d1d8c83250bf51ff7bf4853347a69e2aa91d55c12bcda05aaab4a5260
MD5 adb225cd68c42a0aad73e358c30114de
BLAKE2b-256 99804d290e0a0a115edd0aeb605a19dc73fb0e6185bc7112a2db3463808cbb43

See more details on using hashes here.

File details

Details for the file pytest_helpers_namespace-2019.1.7-py2.py3-none-any.whl.

File metadata

  • Download URL: pytest_helpers_namespace-2019.1.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.6.8

File hashes

Hashes for pytest_helpers_namespace-2019.1.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b646ef9ddcabe00f3eaa5bd23ccacd4327877ca2c91d6cf56077b3f03a6af026
MD5 32c79bc28b79340eaa16fc858015deda
BLAKE2b-256 1e63563d69d31e1a5316c098b517d3b262a3ce0ff8532d002d50b60fb90af77d

See more details on using hashes here.

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