B ܇\M@sdZddlmZddlmZedZeddddZeddd d Zeddd d Zeddd dZ eddddZ ddZ eddddZ ddZ eddddZddZddZeddddZeddd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zeddd,d-Zeddd.d/Zeddd0d1Zeddd2d3Zd4d5Zeddd6d7Zeddd8d9Zd:d;Zedddd?Z!d@dAZ"dBdCZ#dDdEZ$dFdGZ%edddHdIZ&dJdKZ'edddLdMZ(dNdOZ)dPdQZ*dRdSZ+dTdUZ,dVdWZ-dXdYZ.dZd[Z/eddd\d]Z0d^d_Z1eded`dadbZ2edddcddZ3edddedfZ4dgdhZ5didjZ6dkdlZ7dmdnZ8dodpZ9dqS)rzT hook specifications for pytest plugins, invoked from main.py and builtin plugins. )HookspecMarker)PYTEST_LOGWARNINGZpytestT)historiccCsdS)a.called at plugin registration time to allow adding new hooks via a call to ``pluginmanager.add_hookspecs(module_or_class, prefix)``. :param _pytest.config.PytestPluginManager pluginmanager: pytest plugin manager .. note:: This hook is incompatible with ``hookwrapper=True``. N) pluginmanagerrr/lib/python3.7/site-packages/_pytest/hookspec.pypytest_addhooks s rcCsdS)z a new pytest plugin got registered. :param plugin: the plugin module or instance :param _pytest.config.PytestPluginManager manager: pytest plugin manager .. note:: This hook is incompatible with ``hookwrapper=True``. Nr)ZpluginZmanagerrrrpytest_plugin_registereds r cCsdS)aregister argparse-style options and ini-style config values, called once at the beginning of a test run. .. note:: This function should be implemented only in plugins or ``conftest.py`` files situated at the tests root directory due to how pytest :ref:`discovers plugins during startup `. :arg _pytest.config.Parser parser: To add command line options, call :py:func:`parser.addoption(...) <_pytest.config.Parser.addoption>`. To add ini-file values call :py:func:`parser.addini(...) <_pytest.config.Parser.addini>`. Options can later be accessed through the :py:class:`config <_pytest.config.Config>` object, respectively: - :py:func:`config.getoption(name) <_pytest.config.Config.getoption>` to retrieve the value of a command line option. - :py:func:`config.getini(name) <_pytest.config.Config.getini>` to retrieve a value read from an ini-style file. The config object is passed around on many internal objects via the ``.config`` attribute or can be retrieved as the ``pytestconfig`` fixture. .. note:: This hook is incompatible with ``hookwrapper=True``. Nr)parserrrrpytest_addoption&sr cCsdS)a Allows plugins and conftest files to perform initial configuration. This hook is called for every plugin and initial conftest file after command line options have been parsed. After that, the hook is called for other conftest files as they are imported. .. note:: This hook is incompatible with ``hookwrapper=True``. :arg _pytest.config.Config config: pytest config object Nr)configrrrpytest_configureGsr )Z firstresultcCsdS)areturn initialized config object, parsing the specified args. 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 list[str] args: list of arguments passed on the command line Nr)rargsrrrpytest_cmdline_parse_s rcCsdS)a(**Deprecated**) modify command line arguments before option parsing. This hook is considered deprecated and will be removed in a future pytest version. Consider 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 list[str] args: list of arguments passed on the command line Nr)r rrrrpytest_cmdline_preparsems rcCsdS)au called for performing the main command line action. The default 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` :param _pytest.config.Config config: pytest config object Nr)r rrrpytest_cmdline_main{s rcCsdS)a implements the loading of initial conftest files ahead 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 list[str] args: list of arguments passed on the command line :param _pytest.config.Parser parser: to add command line options Nr)Z early_configr rrrrpytest_load_initial_conftestss rcCsdS)zPerform the collection protocol for the given session. Stops at first non-None result, see :ref:`firstresult`. :param _pytest.main.Session session: the pytest session object Nr)sessionrrrpytest_collectionsrcCsdS)a" called after collection has been performed, may filter or re-order the items in-place. :param _pytest.main.Session session: the pytest session object :param _pytest.config.Config config: pytest config object :param List[_pytest.nodes.Item] items: list of item objects Nr)rr itemsrrrpytest_collection_modifyitemssrcCsdS)z called after collection has been performed and modified. :param _pytest.main.Session session: the pytest session object Nr)rrrrpytest_collection_finishsrcCsdS)aI return True to prevent considering this path for collection. This hook is consulted for all files and directories prior to calling more specific hooks. Stops at first non-None result, see :ref:`firstresult` :param str path: the path to analyze :param _pytest.config.Config config: pytest config object Nr)pathr rrrpytest_ignore_collects rcCsdS)z called before traversing a directory for collection files. Stops at first non-None result, see :ref:`firstresult` :param str path: the path to analyze Nr)rparentrrrpytest_collect_directorysrcCsdS)z return collection Node or None for the given path. Any new node needs to have the specified ``parent`` as a parent. :param str path: the path to collect Nr)rrrrrpytest_collect_filesrcCsdS)z collector starts collecting. Nr) collectorrrrpytest_collectstartsrcCsdS)z we just collected a test item. Nr)itemrrrpytest_itemcollectedsr cCsdS)z collector finished collecting. Nr)reportrrrpytest_collectreportsr"cCsdS)z. called for test items deselected by keyword. Nr)rrrrpytest_deselectedsr#cCsdS)zy perform ``collector.collect()`` and return a CollectReport. Stops at first non-None result, see :ref:`firstresult` Nr)rrrrpytest_make_collect_reportsr$cCsdS)a; return a Module collector or None for the given path. This hook will be called for each matching test module path. The pytest_collect_file hook needs to be used if you want to create test modules for files that do not match as a test module. Stops at first non-None result, see :ref:`firstresult` Nr)rrrrrpytest_pycollect_makemodulesr%cCsdS)z return custom item/collector for a python object in a module, or None. Stops at first non-None result, see :ref:`firstresult` Nr)rnameobjrrrpytest_pycollect_makeitemsr(cCsdS)z\ call underlying test function. Stops at first non-None result, see :ref:`firstresult` Nr)Z pyfuncitemrrrpytest_pyfunc_callsr)cCsdS)z; generate (multiple) parametrized calls to a test function.Nr)Zmetafuncrrrpytest_generate_tests sr*cCsdS)aReturn a user-friendly string representation of the given ``val`` that will be used by @pytest.mark.parametrize calls. Return None if the hook doesn't know about ``val``. The parameter name is available as ``argname``, if required. Stops at first non-None result, see :ref:`firstresult` :param _pytest.config.Config config: pytest config object :param val: the parametrized value :param str argname: the automatic parameter name produced by pytest Nr)r valargnamerrrpytest_make_parametrize_ids r-cCsdS)z called for performing the main runtest loop (after collection finished). Stops at first non-None result, see :ref:`firstresult` :param _pytest.main.Session session: the pytest session object Nr)rrrrpytest_runtestloop#sr.cCsdS)z.(**Deprecated**) use pytest_runtest_logstart. Nr)rnoderrrpytest_itemstart.sr0cCsdS)a/ implements the runtest_setup/call/teardown protocol for the given test item, including capturing exceptions and calling reporting hooks. :arg item: test item for which the runtest protocol is performed. :arg nextitem: the scheduled-to-be-next test item (or None if this is the end my friend). This argument is passed on to :py:func:`pytest_runtest_teardown`. :return boolean: True if no further hook implementations should be invoked. Stops at first non-None result, see :ref:`firstresult` Nr)rnextitemrrrpytest_runtest_protocol2sr2cCsdS)a6 signal the start of running a single test item. This hook will be called **before** :func:`pytest_runtest_setup`, :func:`pytest_runtest_call` and :func:`pytest_runtest_teardown` hooks. :param str nodeid: full id of the item :param location: a triple of ``(filename, linenum, testname)`` Nr)nodeidlocationrrrpytest_runtest_logstartDsr5cCsdS)a? signal the complete finish of running a single test item. This hook will be called **after** :func:`pytest_runtest_setup`, :func:`pytest_runtest_call` and :func:`pytest_runtest_teardown` hooks. :param str nodeid: full id of the item :param location: a triple of ``(filename, linenum, testname)`` Nr)r3r4rrrpytest_runtest_logfinishOsr6cCsdS)z. called before ``pytest_runtest_call(item)``. Nr)rrrrpytest_runtest_setupZsr7cCsdS)z& called to execute the test ``item``. Nr)rrrrpytest_runtest_call^sr8cCsdS)aX called after ``pytest_runtest_call``. :arg nextitem: the scheduled-to-be-next test item (None if no further test item is scheduled). This argument can be used to perform exact teardowns, i.e. calling just enough finalizers so that nextitem only needs to call setup-functions. Nr)rr1rrrpytest_runtest_teardownbsr9cCsdS)z return a :py:class:`_pytest.runner.TestReport` object for the given :py:class:`pytest.Item <_pytest.main.Item>` and :py:class:`_pytest.runner.CallInfo`. Stops at first non-None result, see :ref:`firstresult` Nr)rcallrrrpytest_runtest_makereportlsr;cCsdS)ze process a test setup/call/teardown report relating to the respective phase of executing a test. Nr)r!rrrpytest_runtest_logreportusr<cCsdS)aw performs fixture setup execution. :return: The return value of the call to the fixture function Stops at first non-None result, see :ref:`firstresult` .. note:: If the fixture function returns None, other implementations of this hook function will continue to be called, according to the behavior of the :ref:`firstresult` option. Nr) fixturedefrequestrrrpytest_fixture_setups r?cCsdS)z called after fixture teardown, but before the cache is cleared so the fixture result cache ``fixturedef.cached_result`` can still be accessed.Nr)r=r>rrrpytest_fixture_post_finalizersr@cCsdS)z called after the ``Session`` object has been created and before performing collection and entering the run test loop. :param _pytest.main.Session session: the pytest session object Nr)rrrrpytest_sessionstartsrAcCsdS)z called after whole test run finished, right before returning the exit status to the system. :param _pytest.main.Session session: the pytest session object :param int exitstatus: the status which pytest will return to the system Nr)r exitstatusrrrpytest_sessionfinishsrCcCsdS)zj called before test process is exited. :param _pytest.config.Config config: pytest config object Nr)r rrrpytest_unconfiguresrDcCsdS)areturn explanation for comparisons in failing assert expressions. Return None for no custom explanation, otherwise return a list of strings. The strings will be joined by newlines but any newlines *in* a string will be escaped. Note that all but the first line will be indented slightly, the intention is for the first line to be a summary. :param _pytest.config.Config config: pytest config object Nr)r opleftrightrrrpytest_assertrepr_compares rHcCsdS)a return a string or list of strings to be displayed as header info for terminal reporting. :param _pytest.config.Config config: pytest config object :param startdir: py.path object with the starting dir .. note:: This function should be implemented only in plugins or ``conftest.py`` files situated at the tests root directory due to how pytest :ref:`discovers plugins during startup `. Nr)r startdirrrrpytest_report_headers rJcCsdS)a .. versionadded:: 3.2 return a string or list of strings to be displayed after collection has finished successfully. This strings will be displayed after the standard "collected X items" message. :param _pytest.config.Config config: pytest config object :param startdir: py.path object with the starting dir :param items: list of pytest items that are going to be executed; this list should not be modified. Nr)r rIrrrrpytest_report_collectionfinishs rKcCsdS)z return result-category, shortletter and verbose word for reporting. :param _pytest.config.Config config: pytest config object Stops at first non-None result, see :ref:`firstresult` Nr)r!r rrrpytest_report_teststatussrLcCsdS)abAdd a section to terminal summary reporting. :param _pytest.terminal.TerminalReporter terminalreporter: the internal terminal reporter object :param int exitstatus: the exit status that will be reported back to the OS :param _pytest.config.Config config: pytest config object .. versionadded:: 4.2 The ``config`` parameter. Nr)ZterminalreporterrBr rrrpytest_terminal_summarys rM)rZ warn_on_implcCsdS)ao .. deprecated:: 3.8 This hook is will stop working in a future release. pytest no longer triggers this hook, but the terminal writer still implements it to display warnings issued by :meth:`_pytest.config.Config.warn` and :meth:`_pytest.nodes.Node.warn`. Calling those functions will be an error in future releases. process a warning specified by a message, a code string, a nodeid and fslocation (both of which may be None if the warning is not tied to a particular node/location). .. note:: This hook is incompatible with ``hookwrapper=True``. Nr)messagecoder3Z fslocationrrrpytest_logwarningsrPcCsdS)aL Process a warning captured by the internal pytest warnings plugin. :param warnings.WarningMessage warning_message: The captured warning. This is the same object produced by :py:func:`warnings.catch_warnings`, and contains the same attributes as the parameters of :py:func:`warnings.showwarning`. :param str when: Indicates when the warning was captured. Possible values: * ``"config"``: during pytest configuration/initialization stage. * ``"collect"``: during test collection. * ``"runtest"``: during test execution. :param pytest.Item|None item: **DEPRECATED**: This parameter is incompatible with ``pytest-xdist``, and will always receive ``None`` in a future release. The item being executed if ``when`` is ``"runtest"``, otherwise ``None``. Nr)Zwarning_messageZwhenrrrrpytest_warning_captured srQcCsdS)zj return processed content for a given doctest Stops at first non-None result, see :ref:`firstresult` Nr)Zcontentrrrpytest_doctest_prepare_content)srRcCsdS)z called for internal errors. Nr)Zexcreprexcinforrrpytest_internalerror5srTcCsdS)z called for keyboard interrupt. Nr)rSrrrpytest_keyboard_interrupt9srUcCsdS)zcalled when an exception was raised which can potentially be interactively handled. This hook is only called if an exception was raised that is not an internal exception like ``skip.Exception``. Nr)r/r:r!rrrpytest_exception_interact=srVcCsdS)z called upon pdb.set_trace(), can be used by plugins to take special action just before the python debugger enters in interactive mode. :param _pytest.config.Config config: pytest config object :param pdb.Pdb pdb: Pdb instance Nr)r pdbrrrpytest_enter_pdbFsrXcCsdS)a called when leaving pdb (e.g. with continue after pdb.set_trace()). Can be used by plugins to take special action just after the python debugger leaves interactive mode. :param _pytest.config.Config config: pytest config object :param pdb.Pdb pdb: Pdb instance Nr)r rWrrrpytest_leave_pdbOsrYN):__doc__ZpluggyrZ_pytest.deprecatedrZhookspecrr r r rrrrrrrrrrrr r"r#r$r%r(r)r*r-r.r0r2r5r6r7r8r9r;r<r?r@rArCrDrHrJrKrLrMrPrQrRrTrUrVrXrYrrrrsn    !