228 lines
8.4 KiB
Python
228 lines
8.4 KiB
Python
"""
|
|
hook specifications for py.test plugins
|
|
"""
|
|
|
|
# -------------------------------------------------------------------------
|
|
# Initialization
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_namespace():
|
|
"""return dict of name->object to be made globally available in
|
|
the py.test/pytest namespace. This hook is called before command
|
|
line options are fully parsed. If you want to provide helper functions
|
|
that can interact with a test function invocation, please refer to
|
|
:ref:`funcarg mechanism`.
|
|
"""
|
|
|
|
def pytest_addoption(parser):
|
|
"""allows to add optparse-style command line options via a call to
|
|
``parser.addoption(...)``."""
|
|
|
|
def pytest_addhooks(pluginmanager):
|
|
"allows to add new hooks via pluginmanager.registerhooks(module)"
|
|
|
|
def pytest_cmdline_main(config):
|
|
""" called for performing the main command line action. The default
|
|
implementation will invoke the configure hooks and runtest_mainloop. """
|
|
pytest_cmdline_main.firstresult = True
|
|
|
|
def pytest_configure(config):
|
|
""" called after command line options have been parsed.
|
|
and all plugins and initial conftest files been loaded.
|
|
"""
|
|
|
|
def pytest_unconfigure(config):
|
|
""" called before test process is exited. """
|
|
|
|
def pytest_runtest_mainloop(session):
|
|
""" called for performing the main runtest loop (after collection. """
|
|
pytest_runtest_mainloop.firstresult = True
|
|
|
|
# -------------------------------------------------------------------------
|
|
# collection hooks
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_perform_collection(session):
|
|
""" perform the collection protocol for the given session. """
|
|
pytest_perform_collection.firstresult = True
|
|
|
|
def pytest_collection_modifyitems(config, items):
|
|
""" called to allow filtering and selecting of test items (inplace). """
|
|
|
|
def pytest_log_finishcollection(collection):
|
|
""" called after collection has finished. """
|
|
|
|
def pytest_ignore_collect(path, config):
|
|
""" return True to prevent considering this path for collection.
|
|
This hook is consulted for all files and directories prior to calling
|
|
more specific hooks.
|
|
"""
|
|
pytest_ignore_collect.firstresult = True
|
|
|
|
def pytest_collect_directory(path, parent):
|
|
""" return collection Node or None for the given path. Any new node
|
|
needs to have the specified ``parent`` as a parent."""
|
|
pytest_collect_directory.firstresult = True
|
|
|
|
def pytest_collect_file(path, parent):
|
|
""" return collection Node or None for the given path. Any new node
|
|
needs to have the specified ``parent`` as a parent."""
|
|
|
|
# logging hooks for collection
|
|
def pytest_collectstart(collector):
|
|
""" collector starts collecting. """
|
|
|
|
def pytest_log_itemcollect(item):
|
|
""" we just collected a test item. """
|
|
|
|
def pytest_collectreport(report):
|
|
""" collector finished collecting. """
|
|
|
|
def pytest_deselected(items):
|
|
""" called for test items deselected by keyword. """
|
|
|
|
def pytest_make_collect_report(collector):
|
|
""" perform a collection and return a collection. """
|
|
pytest_make_collect_report.firstresult = True
|
|
|
|
# -------------------------------------------------------------------------
|
|
# Python test function related hooks
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_pycollect_makemodule(path, parent):
|
|
""" 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.
|
|
"""
|
|
pytest_pycollect_makemodule.firstresult = True
|
|
|
|
def pytest_pycollect_makeitem(collector, name, obj):
|
|
""" return custom item/collector for a python object in a module, or None. """
|
|
pytest_pycollect_makeitem.firstresult = True
|
|
|
|
def pytest_pyfunc_call(pyfuncitem):
|
|
""" call underlying test function. """
|
|
pytest_pyfunc_call.firstresult = True
|
|
|
|
def pytest_generate_tests(metafunc):
|
|
""" generate (multiple) parametrized calls to a test function."""
|
|
|
|
# -------------------------------------------------------------------------
|
|
# generic runtest related hooks
|
|
# -------------------------------------------------------------------------
|
|
def pytest_itemstart(item, node=None):
|
|
""" (deprecated, use pytest_runtest_logstart). """
|
|
|
|
def pytest_runtest_protocol(item):
|
|
""" implements the standard runtest_setup/call/teardown protocol including
|
|
capturing exceptions and calling reporting hooks on the results accordingly.
|
|
|
|
:return boolean: True if no further hook implementations should be invoked.
|
|
"""
|
|
pytest_runtest_protocol.firstresult = True
|
|
|
|
def pytest_runtest_logstart(nodeid, location, fspath):
|
|
""" signal the start of a test run. """
|
|
|
|
def pytest_runtest_setup(item):
|
|
""" called before ``pytest_runtest_call(item)``. """
|
|
|
|
def pytest_runtest_call(item):
|
|
""" called to execute the test ``item``. """
|
|
|
|
def pytest_runtest_teardown(item):
|
|
""" called after ``pytest_runtest_call``. """
|
|
|
|
def pytest_runtest_makereport(item, call):
|
|
""" return a :py:class:`pytest.plugin.runner.TestReport` object
|
|
for the given :py:class:`pytest.collect.Item` and
|
|
:py:class:`pytest.plugin.runner.CallInfo`.
|
|
"""
|
|
pytest_runtest_makereport.firstresult = True
|
|
|
|
def pytest_runtest_logreport(report):
|
|
""" process item test report. """
|
|
|
|
# special handling for final teardown - somewhat internal for now
|
|
def pytest__teardown_final(session):
|
|
""" called before test session finishes. """
|
|
pytest__teardown_final.firstresult = True
|
|
|
|
def pytest__teardown_final_logerror(report, session):
|
|
""" called if runtest_teardown_final failed. """
|
|
|
|
# -------------------------------------------------------------------------
|
|
# test session related hooks
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_sessionstart(session):
|
|
""" before session.main() is called. """
|
|
|
|
def pytest_sessionfinish(session, exitstatus):
|
|
""" whole test run finishes. """
|
|
|
|
|
|
# -------------------------------------------------------------------------
|
|
# hooks for customising the assert methods
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_assertrepr_compare(config, op, left, right):
|
|
"""return 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 sligthly, the intention is for the first line to be a summary.
|
|
"""
|
|
|
|
# -------------------------------------------------------------------------
|
|
# hooks for influencing reporting (invoked from pytest_terminal)
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_report_header(config):
|
|
""" return a string to be displayed as header info for terminal reporting."""
|
|
|
|
def pytest_report_teststatus(report):
|
|
""" return result-category, shortletter and verbose word for reporting."""
|
|
pytest_report_teststatus.firstresult = True
|
|
|
|
def pytest_terminal_summary(terminalreporter):
|
|
""" add additional section in terminal summary reporting. """
|
|
|
|
def pytest_report_iteminfo(item):
|
|
""" return (fspath, lineno, domainpath) location info for the item.
|
|
the information is used for result display and to sort tests.
|
|
fspath,lineno: file and linenumber of source of item definition.
|
|
domainpath: custom id - e.g. for python: dotted import address
|
|
"""
|
|
pytest_report_iteminfo.firstresult = True
|
|
|
|
# -------------------------------------------------------------------------
|
|
# doctest hooks
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_doctest_prepare_content(content):
|
|
""" return processed content for a given doctest"""
|
|
pytest_doctest_prepare_content.firstresult = True
|
|
|
|
|
|
# -------------------------------------------------------------------------
|
|
# error handling and internal debugging hooks
|
|
# -------------------------------------------------------------------------
|
|
|
|
def pytest_plugin_registered(plugin, manager):
|
|
""" a new py lib plugin got registered. """
|
|
|
|
def pytest_plugin_unregistered(plugin):
|
|
""" a py lib plugin got unregistered. """
|
|
|
|
def pytest_internalerror(excrepr):
|
|
""" called for internal errors. """
|
|
|
|
def pytest_keyboard_interrupt(excinfo):
|
|
""" called for keyboard interrupt. """
|
|
|
|
def pytest_trace(category, msg):
|
|
""" called for debug info. """
|