floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #7748 from nicoddemus/fix-plugin-order-docs 

Improve docs about plugin discovery/loading at startup
This commit is contained in:
Ran Benita 2020-09-27 13:19:58 +03:00 committed by GitHub
parent 28ba9ab737 7324e90199
commit f324b27d02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/en/writing_plugins.rst
View File

@ -33,26 +33,34 @@ Plugin discovery order at tool startup
``pytest`` loads plugin modules at tool startup in the following way: ``pytest`` loads plugin modules at tool startup in the following way:
* by loading all builtin plugins 1. by scanning the command line for the ``-p no:name`` option
and *blocking* that plugin from being loaded (even builtin plugins can
be blocked this way). This happens before normal command-line parsing.
* by loading all plugins registered through `setuptools entry points`_. 2. by loading all builtin plugins.
* by pre-scanning the command line for the ``-p name`` option 3. by scanning the command line for the ``-p name`` option
and loading the specified plugin before actual command line parsing. and loading the specified plugin. This happens before normal command-line parsing.
* by loading all :file:`conftest.py` files as inferred by the command line 4. by loading all plugins registered through `setuptools entry points`_.
invocation:
- if no test paths are specified use current dir as a test path 5. by loading all plugins specified through the :envvar:`PYTEST_PLUGINS` environment variable.
- if exists, load ``conftest.py`` and ``test*/conftest.py`` relative
to the directory part of the first test path.
Note that pytest does not find ``conftest.py`` files in deeper nested 6. by loading all :file:`conftest.py` files as inferred by the command line
sub directories at tool startup. It is usually a good idea to keep invocation:
your ``conftest.py`` file in the top level test or project root directory.
* by recursively loading all plugins specified by the - if no test paths are specified, use the current dir as a test path
:globalvar:`pytest_plugins` variable in ``conftest.py`` files - if exists, load ``conftest.py`` and ``test*/conftest.py`` relative
to the directory part of the first test path. After the ``conftest.py``
file is loaded, load all plugins specified in its
:globalvar:`pytest_plugins` variable if present.
Note that pytest does not find ``conftest.py`` files in deeper nested
sub directories at tool startup. It is usually a good idea to keep
your ``conftest.py`` file in the top level test or project root directory.
7. by recursively loading all plugins specified by the
:globalvar:`pytest_plugins` variable in ``conftest.py`` files.
.. _`pytest/plugin`: http://bitbucket.org/pytest-dev/pytest/src/tip/pytest/plugin/ .. _`pytest/plugin`: http://bitbucket.org/pytest-dev/pytest/src/tip/pytest/plugin/