pytest-cython¶
Overview¶
docs |
|
---|---|
tests |
|
package |
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 like:
pytest --doctest-cython path/to/module.pyx
Note¶
It is assumed that the C extension modules have been build inplace before running
py.test
and there is a matching Cython.pyx
file
License¶
Free software: MIT license
Distributed under the terms of the MIT license, “pytest-cython” is free and open source software
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.
Changelog¶
0.2.0¶
The full list of merged PRs is:
PR #15, #17: Dropped support for Python 2, added support for Python 3.6+
PR #18: New patched pyimport implementation, maintaining better compatibility with the installed pytest version
PR #19: Rework how test collection works, making it possible to directly specify .pyx files to run, and reporting tests as being from the .pyx files as opposed to the compiled extension modules
PR #20: Fix handling of Cython-generated autotestdicts; prevents running the same tests repeatedly, and adds better reporting of test line numbers
PR #21: Add CI job with Windows
PR #22: Various documentation improvements
0.1.1¶
The full list of merged PRs is:
PR #5: Fix DoctestModule deprecated error
PR #6: Fix typo from PR #5
PR #7: Fix support for relative imports
PR #9: Maintain backwards compatibility for pytest 4.x
Thanks to the following contributors who submitted PRs or reported issues that were merged/closed for this release:
embray
thrasibule
0.1.0¶
First release on PyPI (2016-04-17).
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When reporting a bug please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Documentation improvements¶
pytest-cython could always use more documentation, whether as part of the official pytest-cython docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/lgpage/pytest-cython/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that code contributions are welcome :)
Development¶
To set up pytest-cython
for local development:
Fork pytest-cython (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:your_name_here/pytest-cython.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, run all the checks, doc builder and spell checker with the tox command:
tox
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
Include passing tests (run
tox
) [1].Update documentation when there’s new API, functionality etc.
Add a note to
CHANGELOG.rst
about the changes.Add yourself to
AUTHORS.rst
.
Tips¶
To run a subset of tests:
tox -e envname -- py.test -k test_myfeature
To run all the test environments in parallel (you need to
pip install detox
):
detox