1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# Overview
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://anaconda.org/conda-forge/pytest-cython)
[](https://anaconda.org/conda-forge/pytest-cython)
[](https://github.com/lgpage/pytest-cython/actions/workflows/python-check.yml?query=branch%3Amain)
[](https://github.com/lgpage/pytest-cython/actions/workflows/python-test.yml?query=branch%3Amain)
[](https://readthedocs.org/projects/pytest-cython)
This [pytest](https://github.com/pytest-dev/pytest) plugin allows for the doctesting of C extension modules for
Python, specifically created through [cython](https://cython.org/).
## Installation
You can install "pytest-cython" via [pip](https://pypi.org/project/pip/) from [PyPI](https://pypi.org):
``` shell
pip install pytest-cython
```
## Usage
Basic usage:
``` shell
pytest --doctest-cython
```
You can also run the doctests for a single `.pyx` file as such:
``` shell
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](https://github.com/lgpage/pytest-cython/issues) along with a
detailed description.
## Acknowledgements
This [pytest](https://github.com/pytest-dev/pytest) plugin was generated with
[cookiecutter](https://github.com/cookiecutter/cookiecutter) along with [\@hackebrot](https://github.com/hackebrot)'s
[cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin) and
[\@ionelmc](https://github.com/ionelmc)'s [cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary)
templates.
|
