Go to file
Anthony Sottile 19a15a94ee
Merge pull request #6197 from asottile/fix_init_py_discovery
Fix incorrect discovery of non-test `__init__.py` files.
2019-11-15 13:19:48 -08:00
.github Make whole checklist a comment to avoid incomplete TODOs in PRs 2019-11-14 12:01:40 +02:00
bench Add rudimentary mypy type checking 2019-07-09 12:12:07 -07:00
changelog Add regression tests for __init__.py breakage 2019-11-15 13:19:31 -08:00
doc/en Preparing release version 5.2.3 (#6190) 2019-11-14 18:17:28 -03:00
extra pre-commit run fix-encoding-pragma --all-files 2019-06-03 12:08:01 -03:00
scripts Workaround curl bug which makes retries of fetching codecov.io/bash not work 2019-10-12 21:52:01 +03:00
src Revert "fix bug with nonskipped first test in package (#5831)" 2019-11-15 08:29:52 -08:00
testing Add regression tests for __init__.py breakage 2019-11-15 13:19:31 -08:00
.coveragerc .coveragerc: add report section 2019-08-16 01:14:19 +02:00
.gitattributes Add codecov support to AppVeyor and remove coveralls 2018-09-05 19:50:06 -03:00
.gitignore Add rudimentary mypy type checking 2019-07-09 12:12:07 -07:00
.pre-commit-config.yaml Move `@overload` to compat 2019-08-18 14:54:52 -07:00
.travis.yml ci: Travis: remove py38 from allowed failures; do not use "-dev" 2019-11-06 13:09:11 +01:00
AUTHORS Add regression tests for __init__.py breakage 2019-11-15 13:19:31 -08:00
CHANGELOG.rst Adjust CHANGELOG 2019-11-14 17:51:38 -03:00
CITATION Fix linting issues 2018-07-14 16:35:33 +01:00
CODE_OF_CONDUCT.md Add a code of conduct 2019-08-08 14:01:29 +02:00
CONTRIBUTING.rst Update URL: python/black → psf/black 2019-08-10 12:38:13 -07:00
HOWTORELEASE.rst Update release instructions for 4.6-maintenance 2019-06-02 11:50:07 -07:00
LICENSE Update copyright year 2019-01-04 10:37:07 -02:00
OPENCOLLECTIVE.rst doc: fix typos in OPENCOLLECTIVE.rst [ci skip] 2019-07-10 20:15:22 +02:00
README.rst Update Tidelift docs with latest campaign 2019-10-24 14:58:58 -03:00
TIDELIFT.rst Add docs about Tidelift and OpenCollective 2019-06-30 14:13:30 -03:00
azure-pipelines.yml ci: optimize twisted/pexpect related jobs 2019-06-08 19:21:56 +02:00
codecov.yml ci: add codecov.yml to turn comments off 2019-08-15 23:54:03 +02:00
pyproject.toml Add new 'improvement' changelog category 2019-08-10 09:33:51 -03:00
setup.cfg setup.cfg: fix check-manifest ignore [ci skip] 2019-11-08 22:39:39 +01:00
setup.py tests: keep numpy being optional 2019-10-16 23:50:23 +02:00
tox.ini tests: filterwarnings: do not crash with "(rm_rf)" warning 2019-10-18 17:22:56 +02:00

README.rst

.. image:: https://docs.pytest.org/en/latest/_static/pytest1.png
   :target: https://docs.pytest.org/en/latest/
   :align: center
   :alt: pytest


------

.. image:: https://img.shields.io/pypi/v/pytest.svg
    :target: https://pypi.org/project/pytest/

.. image:: https://img.shields.io/conda/vn/conda-forge/pytest.svg
    :target: https://anaconda.org/conda-forge/pytest

.. image:: https://img.shields.io/pypi/pyversions/pytest.svg
    :target: https://pypi.org/project/pytest/

.. image:: https://codecov.io/gh/pytest-dev/pytest/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pytest-dev/pytest
    :alt: Code coverage Status

.. image:: https://travis-ci.org/pytest-dev/pytest.svg?branch=master
    :target: https://travis-ci.org/pytest-dev/pytest

.. image:: https://dev.azure.com/pytest-dev/pytest/_apis/build/status/pytest-CI?branchName=master
    :target: https://dev.azure.com/pytest-dev/pytest

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. image:: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
    :target: https://www.codetriage.com/pytest-dev/pytest

The ``pytest`` framework makes it easy to write small tests, yet
scales to support complex functional testing for applications and libraries.

An example of a simple test:

.. code-block:: python

    # content of test_sample.py
    def inc(x):
        return x + 1


    def test_answer():
        assert inc(3) == 5


To execute it::

    $ pytest
    ============================= test session starts =============================
    collected 1 items

    test_sample.py F

    ================================== FAILURES ===================================
    _________________________________ test_answer _________________________________

        def test_answer():
    >       assert inc(3) == 5
    E       assert 4 == 5
    E        +  where 4 = inc(3)

    test_sample.py:5: AssertionError
    ========================== 1 failed in 0.04 seconds ===========================


Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used. See `getting-started <https://docs.pytest.org/en/latest/getting-started.html#our-first-test-run>`_ for more examples.


Features
--------

- Detailed info on failing `assert statements <https://docs.pytest.org/en/latest/assert.html>`_ (no need to remember ``self.assert*`` names);

- `Auto-discovery
  <https://docs.pytest.org/en/latest/goodpractices.html#python-test-discovery>`_
  of test modules and functions;

- `Modular fixtures <https://docs.pytest.org/en/latest/fixture.html>`_ for
  managing small or parametrized long-lived test resources;

- Can run `unittest <https://docs.pytest.org/en/latest/unittest.html>`_ (or trial),
  `nose <https://docs.pytest.org/en/latest/nose.html>`_ test suites out of the box;

- Python 3.5+ and PyPy3;

- Rich plugin architecture, with over 315+ `external plugins <http://plugincompat.herokuapp.com>`_ and thriving community;


Documentation
-------------

For full documentation, including installation, tutorials and PDF documents, please see https://docs.pytest.org/en/latest/.


Bugs/Requests
-------------

Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features.


Changelog
---------

Consult the `Changelog <https://docs.pytest.org/en/latest/changelog.html>`__ page for fixes and enhancements of each version.


Support pytest
--------------

`Open Collective`_ is an online funding platform for open and transparent communities.
It provide tools to raise money and share your finances in full transparency.

It is the platform of choice for individuals and companies that want to make one-time or
monthly donations directly to the project.

See more datails in the `pytest collective`_.

.. _Open Collective: https://opencollective.com
.. _pytest collective: https://opencollective.com/pytest


pytest for enterprise
---------------------

Available as part of the Tidelift Subscription.

The maintainers of pytest and thousands of other packages are working with Tidelift to deliver commercial support and
maintenance for the open source dependencies you use to build your applications.
Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.

`Learn more. <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_

Security
^^^^^^^^

pytest has never been associated with a security vunerability, but in any case, to report a
security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
Tidelift will coordinate the fix and disclosure.


License
-------

Copyright Holger Krekel and others, 2004-2019.

Distributed under the terms of the `MIT`_ license, pytest is free and open source software.

.. _`MIT`: https://github.com/pytest-dev/pytest/blob/master/LICENSE