Skip to content

A pytest plugin that allows for the testing of C extension modules for Python, specifically created through cython

License

Notifications You must be signed in to change notification settings

lgpage/pytest-cython

Repository files navigation

Overview

PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations Conda Version Conda Downloads

CI Check Status CI Tests Status Documentation Status

This pytest plugin allows for the doctesting of C extension modules for Python, specifically created through cython.

Installation

You can install "pytest-cython" via pip from PyPI:

pip install pytest-cython

Usage

Basic usage:

pytest --doctest-cython

You can also run the doctests for a single .pyx file as such:

pytest --doctest-cython path/to/module.pyx

Note

It is assumed that the C extension modules have been build in place before running py.test and there is a matching Cython .pyx file

Compatibility

The following table describes the versions of Pytest and Cython the each version of the pytest-cython plugin is compatible with.

Version Pytest Cython
0.3.x 8 0.29, 3
0.2.x 6, 7 0.29, 3

Issues

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

Acknowledgements

This pytest plugin was generated with cookiecutter along with @hackebrot's cookiecutter-pytest-plugin and @ionelmc's cookiecutter-pylibrary templates.

About

A pytest plugin that allows for the testing of C extension modules for Python, specifically created through cython

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages