pytest-cython

Contents

• pytest-cython

  • Overview

  • Changelog

  • Contributing

Overview

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

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.1

The full list of merged changes is:

• #26: fix: pytest_collect_file to take into account pytest fspath deprecation in Node constructors

• #29: chore: use GitHub actions instead of Travis

Special thanks to the following contributors that made this release possible:

• @AlenkaF

• @shvenkat

0.2.0

The full list of merged changes is:

• #11: Update tests

• #15, #17: Dropped support for Python 2, added support for Python 3.6+

• #18: New patched pyimport implementation, maintaining better compatibility with the installed pytest version

• #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

• #20: Fix handling of cython generated autotestdicts; prevents running the same tests repeatedly, and adds better reporting of test line numbers

• #21: Add CI job with Windows

• #22: Various documentation improvements

Special thanks to the following contributors that made this release possible:

• @embray

0.1.1

The full list of merged changes is:

• #5: Fix DoctestModule deprecated error

• #6: Fix typo from #5

• #7: Fix support for relative imports

• #9: Maintain backwards compatibility for pytest 4.x

Special thanks to the following contributors that made this release possible:

• @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.

• The cython and pytest versions you are using

• Detailed steps to reproduce the bug.

• Any other details about your local setup that might be helpful in troubleshooting.

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. If you are proposing a new 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:

1. Fork pytest-cython (look for the “fork” button).

2. Clone your fork locally:

   git clone git@github.com:your_name_here/pytest-cython.git
   

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature
   

4. When you’re done making changes, run all the checks and tests with the nox command:

   nox
   

5. 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
   

6. 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.

Before merging, you should:

1. Update the documentation when there’s new API, functionality etc.

2. Add a note to CHANGELOG.rst about the changes.

Tips

To list all nox tasks:

nox --list

To run a subset of tests use one of the task from the above list, for example:

nox --session "test(cython='0.29', python='3.9', pytest='7')"