Skip to content

Latest commit

 

History

History
113 lines (78 loc) · 3.93 KB

README.md

File metadata and controls

113 lines (78 loc) · 3.93 KB
Raw

pytest-pt: pytest plugin to use *.pt files as tests

This pytest plugin will collect *.pt files as test modules. It uses a custom module loader that always uses importlib (like specifying importmode=importlib to the standard pytest loader) and generates a module name ending in ~pt to prevent namespace collisions.

Installation and Activiation

Normally just install this with Pip or similar: pip install pytest-pt. However, you may also simply deposit the single file src/pytest_pt.py in any directory where it will be found as the code for a (top-level) module.

To activate it, you may simply add -p pytest_pt to your pytest command line, but normally you will want to activate it automatically via one of the following methods:

  1. In your pyproject.toml:

     [tool.pytest.ini_options]
 addopts   = ['-p pytest_pt']

  2. In your pytest.ini file:

     [pytest]
 addopts = -p pytest_pt

  3. Import it in a conftest.py in one or more directories under which you want to collect *.pt files:

     from pytest_pt import *     # Plugin to find/execute .pt files as tests

For further information on pytest configuration, see the Configuration section of the pytest documentation.

Versions Supported

This supports only pytest 5, 7 and 8; pytest 6 doesn't seem worth supporting because we have no legacy users of it. (This could be added if there is any demand for it.)

  • Python 3.6 probably works, but is not tested due to tox being unhappy about using it.
  • pytest 5 is supported on versions of Python up to 3.9, but not on 3.10 and above.
  • pytest 7 and 8 are tested on Pythons up to 3.12, and will probably work on newer versions of Python when they are released.

Testing

The top-level ./Test script runs tests for all supported versions of Python and pytest. You do not need tox installed (or even pip or virtualenv); the script will take care of bootstrapping those into a local virtualenv using pactivate.

The script installs and uses pythonz to supply the various versions of Python this is tested with. You should run it the first time with -B as the first option to ./Test to install/update pythonz and build the versions of Python that tox will need to run the tests. (The tests are for each minor release from 3.7 to 3.12; pythonz will be asked to build the latest patch release for each of those.)

The test script could be updated to use Pythons from other sources, if there is any call for it.

Tox Arguments

Any command line arguments given to ./Test (with the exception of an initial -B—see above) will be passed on to tox. So, e.g., ./Test -h will make tox print its help message. Typical arguments you might want to pass through ./Test to tox include: use include:

  • run -h: Print help for the tox run command.

  • -a: Print a list of all environments in the default list to be tested. This can be useful for finding an envirionment name for use in the run command below.

  • run -e py3.11-pytest8: Run just a specific tox environment (or multiple ones separated by commas) rather than all environment.

  • config: Print the tox configuration.

Release Process

See cynic-net/pypi-release on GitHub.

Further Documentation

This documentation should be expanded to explain more about the purpose of this, how it works, and how the tests (run with ./Test) work. Contact the author if you're needing further documentation or help: Curt J. Sampson cjs@cynic.net.