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

Document bootstrap and initialization hooks 

Fix #2616
This commit is contained in:
Bruno Oliveira 2018-01-06 13:31:38 -02:00
parent 06a182386b
commit afb8a4e35d
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
_pytest/hookspec.py
View File

@ -85,8 +85,7 @@ def pytest_configure(config):
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
# Bootstrapping hooks called for plugins registered early enough: # Bootstrapping hooks called for plugins registered early enough:
# internal and 3rd party plugins as well as directly # internal and 3rd party plugins.
# discoverable conftest.py local plugins.
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
@ -96,6 +95,9 @@ def pytest_cmdline_parse(pluginmanager, args):
Stops at first non-None result, see :ref:`firstresult` Stops at first non-None result, see :ref:`firstresult`
.. note::
This hook will not be called for ``conftest.py`` files, only for setuptools plugins.
:param _pytest.config.PytestPluginManager pluginmanager: pytest plugin manager :param _pytest.config.PytestPluginManager pluginmanager: pytest plugin manager
:param list[str] args: list of arguments passed on the command line :param list[str] args: list of arguments passed on the command line
""" """
@ -107,6 +109,9 @@ def pytest_cmdline_preparse(config, args):
This hook is considered deprecated and will be removed in a future pytest version. Consider This hook is considered deprecated and will be removed in a future pytest version. Consider
using :func:`pytest_load_initial_conftests` instead. using :func:`pytest_load_initial_conftests` instead.
.. note::
This hook will not be called for ``conftest.py`` files, only for setuptools plugins.
:param _pytest.config.Config config: pytest config object :param _pytest.config.Config config: pytest config object
:param list[str] args: list of arguments passed on the command line :param list[str] args: list of arguments passed on the command line
""" """
@ -117,6 +122,9 @@ def pytest_cmdline_main(config):
""" called for performing the main command line action. The default """ called for performing the main command line action. The default
implementation will invoke the configure hooks and runtest_mainloop. implementation will invoke the configure hooks and runtest_mainloop.
.. note::
This hook will not be called for ``conftest.py`` files, only for setuptools plugins.
Stops at first non-None result, see :ref:`firstresult` Stops at first non-None result, see :ref:`firstresult`
:param _pytest.config.Config config: pytest config object :param _pytest.config.Config config: pytest config object
@ -127,6 +135,9 @@ def pytest_load_initial_conftests(early_config, parser, args):
""" implements the loading of initial conftest files ahead """ implements the loading of initial conftest files ahead
of command line option parsing. of command line option parsing.
.. note::
This hook will not be called for ``conftest.py`` files, only for setuptools plugins.
:param _pytest.config.Config early_config: pytest config object :param _pytest.config.Config early_config: pytest config object
:param list[str] args: list of arguments passed on the command line :param list[str] args: list of arguments passed on the command line
:param _pytest.config.Parser parser: to add command line options :param _pytest.config.Parser parser: to add command line options

13
doc/en/writing_plugins.rst
View File

@ -583,11 +583,22 @@ pytest hook reference
Initialization, command line and configuration hooks Initialization, command line and configuration hooks
---------------------------------------------------- ----------------------------------------------------
Bootstrapping hooks
~~~~~~~~~~~~~~~~~~~
Bootstrapping hooks called for plugins registered early enough (internal and setuptools plugins).
.. autofunction:: pytest_load_initial_conftests .. autofunction:: pytest_load_initial_conftests
.. autofunction:: pytest_cmdline_preparse .. autofunction:: pytest_cmdline_preparse
.. autofunction:: pytest_cmdline_parse .. autofunction:: pytest_cmdline_parse
.. autofunction:: pytest_addoption
.. autofunction:: pytest_cmdline_main .. autofunction:: pytest_cmdline_main
Initialization hooks
~~~~~~~~~~~~~~~~~~~~
Initialization hooks called for plugins and ``conftest.py`` files.
.. autofunction:: pytest_addoption
.. autofunction:: pytest_configure .. autofunction:: pytest_configure
.. autofunction:: pytest_unconfigure .. autofunction:: pytest_unconfigure