| 1 |
.. documentation master file, created by |
| 2 |
sphinx-quickstart on Sat Jan 21 19:11:14 2017. |
| 3 |
You can adapt this file completely to your liking, but it should at least |
| 4 |
contain the root `toctree` directive. |
| 5 |
|
| 6 |
|
| 7 |
=================================== |
| 8 |
pytest-trio: Pytest plugin for trio |
| 9 |
=================================== |
| 10 |
|
| 11 |
This is a pytest plugin to help you test projects that use `Trio |
| 12 |
<https://trio.readthedocs.io/>`__, a friendly library for concurrency |
| 13 |
and async I/O in Python. Features include: |
| 14 |
|
| 15 |
* Async tests without the boilerplate: just write ``async def |
| 16 |
test_whatever(): ...``. |
| 17 |
|
| 18 |
* Useful fixtures included: use :data:`autojump_clock` for easy |
| 19 |
testing of code with timeouts, or :data:`nursery` to easily set up |
| 20 |
background tasks. |
| 21 |
|
| 22 |
* Write your own async fixtures: set up an async database connection |
| 23 |
or start a server inside a fixture, and then use it in your tests. |
| 24 |
|
| 25 |
* If you have multiple async fixtures, pytest-trio will even do |
| 26 |
setup/teardown concurrently whenever possible. (Though honestly, |
| 27 |
we're not sure whether this is a good idea or not and might remove |
| 28 |
it in the future. If it makes your tests harder to debug, or |
| 29 |
conversely provides you with big speedups, `please let us know |
| 30 |
<https://github.com/python-trio/pytest-trio/issues/57>`__.) |
| 31 |
|
| 32 |
* Integration with the fabulous `Hypothesis |
| 33 |
<https://hypothesis.works/>`__ library, so your async tests can use |
| 34 |
property-based testing: just use ``@given`` like you're used to. |
| 35 |
|
| 36 |
* Support for testing projects that use Trio exclusively and want to |
| 37 |
use pytest-trio everywhere, and also for testing projects that |
| 38 |
support multiple async libraries and only want to enable |
| 39 |
pytest-trio's features for a subset of their test suite. |
| 40 |
|
| 41 |
|
| 42 |
Vital statistics |
| 43 |
================ |
| 44 |
|
| 45 |
* Install: ``pip install pytest-trio`` |
| 46 |
|
| 47 |
* Documentation: https://pytest-trio.readthedocs.io |
| 48 |
|
| 49 |
* Issue tracker, source code: https://github.com/python-trio/pytest-trio |
| 50 |
|
| 51 |
* License: MIT or Apache 2, your choice |
| 52 |
|
| 53 |
* Contributor guide: https://trio.readthedocs.io/en/latest/contributing.html |
| 54 |
|
| 55 |
* Code of conduct: Contributors are requested to follow our `code of |
| 56 |
conduct |
| 57 |
<https://trio.readthedocs.io/en/latest/code-of-conduct.html>`__ in |
| 58 |
all project spaces. |
| 59 |
|
| 60 |
.. toctree:: |
| 61 |
:maxdepth: 2 |
| 62 |
|
| 63 |
quickstart.rst |
| 64 |
reference.rst |
| 65 |
|
| 66 |
.. toctree:: |
| 67 |
:maxdepth: 1 |
| 68 |
|
| 69 |
history.rst |
| 70 |
|
| 71 |
==================== |
| 72 |
Indices and tables |
| 73 |
==================== |
| 74 |
|
| 75 |
* :ref:`genindex` |
| 76 |
* :ref:`modindex` |
| 77 |
* :ref:`search` |
| 78 |
* :ref:`glossary` |