/usr/share/doc/python-pytest-doc/html/_modules/_pytest/hookspec.html is in python-pytest-doc 2.8.7-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>_pytest.hookspec</title>
<link rel="stylesheet" href="../../_static/flasky.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.8.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="shortcut icon" href="../../_static/pytest1favi.ico"/>
<link rel="top" title="None" href="../../contents.html" />
<link rel="up" title="Module code" href="../index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="../../contents.html">pytest-2.8.7</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for _pytest.hookspec</h1><div class="highlight"><pre>
<span class="sd">""" hook specifications for pytest plugins, invoked from main.py and builtin plugins. """</span>
<span class="kn">from</span> <span class="nn">_pytest._pluggy</span> <span class="kn">import</span> <span class="n">HookspecMarker</span>
<span class="n">hookspec</span> <span class="o">=</span> <span class="n">HookspecMarker</span><span class="p">(</span><span class="s2">"pytest"</span><span class="p">)</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># Initialization hooks called for every plugin</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">historic</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_addhooks"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_addhooks">[docs]</a><span class="k">def</span> <span class="nf">pytest_addhooks</span><span class="p">(</span><span class="n">pluginmanager</span><span class="p">):</span>
<span class="sd">"""called at plugin registration time to allow adding new hooks via a call to</span>
<span class="sd"> pluginmanager.add_hookspecs(module_or_class, prefix)."""</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">historic</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_namespace"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_namespace">[docs]</a><span class="k">def</span> <span class="nf">pytest_namespace</span><span class="p">():</span>
<span class="sd">"""return dict of name->object to be made globally available in</span>
<span class="sd"> the pytest namespace. This hook is called at plugin registration</span>
<span class="sd"> time.</span>
<span class="sd"> """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">historic</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_plugin_registered</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="n">manager</span><span class="p">):</span>
<span class="sd">""" a new pytest plugin got registered. """</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">historic</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_addoption"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_addoption">[docs]</a><span class="k">def</span> <span class="nf">pytest_addoption</span><span class="p">(</span><span class="n">parser</span><span class="p">):</span>
<span class="sd">"""register argparse-style options and ini-style config values.</span>
<span class="sd"> .. warning::</span>
<span class="sd"> This function must be implemented in a :ref:`plugin <pluginorder>`</span>
<span class="sd"> and is called once at the beginning of a test run.</span>
<span class="sd"> Implementing this hook from ``conftest.py`` files is **strongly**</span>
<span class="sd"> discouraged because ``conftest.py`` files are lazily loaded and</span>
<span class="sd"> may give strange *unknown option* errors depending on the directory</span>
<span class="sd"> ``py.test`` is invoked from.</span>
<span class="sd"> :arg parser: To add command line options, call</span>
<span class="sd"> :py:func:`parser.addoption(...) <_pytest.config.Parser.addoption>`.</span>
<span class="sd"> To add ini-file values call :py:func:`parser.addini(...)</span>
<span class="sd"> <_pytest.config.Parser.addini>`.</span>
<span class="sd"> Options can later be accessed through the</span>
<span class="sd"> :py:class:`config <_pytest.config.Config>` object, respectively:</span>
<span class="sd"> - :py:func:`config.getoption(name) <_pytest.config.Config.getoption>` to</span>
<span class="sd"> retrieve the value of a command line option.</span>
<span class="sd"> - :py:func:`config.getini(name) <_pytest.config.Config.getini>` to retrieve</span>
<span class="sd"> a value read from an ini-style file.</span>
<span class="sd"> The config object is passed around on many internal objects via the ``.config``</span>
<span class="sd"> attribute or can be retrieved as the ``pytestconfig`` fixture or accessed</span>
<span class="sd"> via (deprecated) ``pytest.config``.</span>
<span class="sd"> """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">historic</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_configure"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_configure">[docs]</a><span class="k">def</span> <span class="nf">pytest_configure</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">""" called after command line options have been parsed</span>
<span class="sd"> and all plugins and initial conftest files been loaded.</span>
<span class="sd"> This hook is called for every plugin.</span>
<span class="sd"> """</span></div>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># Bootstrapping hooks called for plugins registered early enough:</span>
<span class="c1"># internal and 3rd party plugins as well as directly</span>
<span class="c1"># discoverable conftest.py local plugins.</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_cmdline_parse"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_cmdline_parse">[docs]</a><span class="k">def</span> <span class="nf">pytest_cmdline_parse</span><span class="p">(</span><span class="n">pluginmanager</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="sd">"""return initialized config object, parsing the specified args. """</span></div>
<div class="viewcode-block" id="pytest_cmdline_preparse"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_cmdline_preparse">[docs]</a><span class="k">def</span> <span class="nf">pytest_cmdline_preparse</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="sd">"""(deprecated) modify command line arguments before option parsing. """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_cmdline_main"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_cmdline_main">[docs]</a><span class="k">def</span> <span class="nf">pytest_cmdline_main</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">""" called for performing the main command line action. The default</span>
<span class="sd"> implementation will invoke the configure hooks and runtest_mainloop. """</span></div>
<div class="viewcode-block" id="pytest_load_initial_conftests"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_load_initial_conftests">[docs]</a><span class="k">def</span> <span class="nf">pytest_load_initial_conftests</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">early_config</span><span class="p">,</span> <span class="n">parser</span><span class="p">):</span>
<span class="sd">""" implements the loading of initial conftest files ahead</span>
<span class="sd"> of command line option parsing. """</span></div>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># collection hooks</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_collection</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
<span class="sd">""" perform the collection protocol for the given session. """</span>
<div class="viewcode-block" id="pytest_collection_modifyitems"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_collection_modifyitems">[docs]</a><span class="k">def</span> <span class="nf">pytest_collection_modifyitems</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">items</span><span class="p">):</span>
<span class="sd">""" called after collection has been performed, may filter or re-order</span>
<span class="sd"> the items in-place."""</span></div>
<span class="k">def</span> <span class="nf">pytest_collection_finish</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
<span class="sd">""" called after collection has been performed and modified. """</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_ignore_collect"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_ignore_collect">[docs]</a><span class="k">def</span> <span class="nf">pytest_ignore_collect</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
<span class="sd">""" return True to prevent considering this path for collection.</span>
<span class="sd"> This hook is consulted for all files and directories prior to calling</span>
<span class="sd"> more specific hooks.</span>
<span class="sd"> """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_collect_directory"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_collect_directory">[docs]</a><span class="k">def</span> <span class="nf">pytest_collect_directory</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
<span class="sd">""" called before traversing a directory for collection files. """</span></div>
<div class="viewcode-block" id="pytest_collect_file"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_collect_file">[docs]</a><span class="k">def</span> <span class="nf">pytest_collect_file</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
<span class="sd">""" return collection Node or None for the given path. Any new node</span>
<span class="sd"> needs to have the specified ``parent`` as a parent."""</span></div>
<span class="c1"># logging hooks for collection</span>
<div class="viewcode-block" id="pytest_collectstart"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_collectstart">[docs]</a><span class="k">def</span> <span class="nf">pytest_collectstart</span><span class="p">(</span><span class="n">collector</span><span class="p">):</span>
<span class="sd">""" collector starts collecting. """</span></div>
<div class="viewcode-block" id="pytest_itemcollected"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_itemcollected">[docs]</a><span class="k">def</span> <span class="nf">pytest_itemcollected</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
<span class="sd">""" we just collected a test item. """</span></div>
<div class="viewcode-block" id="pytest_collectreport"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_collectreport">[docs]</a><span class="k">def</span> <span class="nf">pytest_collectreport</span><span class="p">(</span><span class="n">report</span><span class="p">):</span>
<span class="sd">""" collector finished collecting. """</span></div>
<div class="viewcode-block" id="pytest_deselected"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_deselected">[docs]</a><span class="k">def</span> <span class="nf">pytest_deselected</span><span class="p">(</span><span class="n">items</span><span class="p">):</span>
<span class="sd">""" called for test items deselected by keyword. """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_make_collect_report</span><span class="p">(</span><span class="n">collector</span><span class="p">):</span>
<span class="sd">""" perform ``collector.collect()`` and return a CollectReport. """</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># Python test function related hooks</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_pycollect_makemodule</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
<span class="sd">""" return a Module collector or None for the given path.</span>
<span class="sd"> This hook will be called for each matching test module path.</span>
<span class="sd"> The pytest_collect_file hook needs to be used if you want to</span>
<span class="sd"> create test modules for files that do not match as a test module.</span>
<span class="sd"> """</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_pycollect_makeitem"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_pycollect_makeitem">[docs]</a><span class="k">def</span> <span class="nf">pytest_pycollect_makeitem</span><span class="p">(</span><span class="n">collector</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="sd">""" return custom item/collector for a python object in a module, or None. """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_pyfunc_call</span><span class="p">(</span><span class="n">pyfuncitem</span><span class="p">):</span>
<span class="sd">""" call underlying test function. """</span>
<div class="viewcode-block" id="pytest_generate_tests"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_generate_tests">[docs]</a><span class="k">def</span> <span class="nf">pytest_generate_tests</span><span class="p">(</span><span class="n">metafunc</span><span class="p">):</span>
<span class="sd">""" generate (multiple) parametrized calls to a test function."""</span></div>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># generic runtest related hooks</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_runtestloop</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
<span class="sd">""" called for performing the main runtest loop</span>
<span class="sd"> (after collection finished). """</span>
<span class="k">def</span> <span class="nf">pytest_itemstart</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span>
<span class="sd">""" (deprecated, use pytest_runtest_logstart). """</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_runtest_protocol"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_runtest_protocol">[docs]</a><span class="k">def</span> <span class="nf">pytest_runtest_protocol</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="p">):</span>
<span class="sd">""" implements the runtest_setup/call/teardown protocol for</span>
<span class="sd"> the given test item, including capturing exceptions and calling</span>
<span class="sd"> reporting hooks.</span>
<span class="sd"> :arg item: test item for which the runtest protocol is performed.</span>
<span class="sd"> :arg nextitem: the scheduled-to-be-next test item (or None if this</span>
<span class="sd"> is the end my friend). This argument is passed on to</span>
<span class="sd"> :py:func:`pytest_runtest_teardown`.</span>
<span class="sd"> :return boolean: True if no further hook implementations should be invoked.</span>
<span class="sd"> """</span></div>
<span class="k">def</span> <span class="nf">pytest_runtest_logstart</span><span class="p">(</span><span class="n">nodeid</span><span class="p">,</span> <span class="n">location</span><span class="p">):</span>
<span class="sd">""" signal the start of running a single test item. """</span>
<div class="viewcode-block" id="pytest_runtest_setup"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_runtest_setup">[docs]</a><span class="k">def</span> <span class="nf">pytest_runtest_setup</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
<span class="sd">""" called before ``pytest_runtest_call(item)``. """</span></div>
<div class="viewcode-block" id="pytest_runtest_call"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_runtest_call">[docs]</a><span class="k">def</span> <span class="nf">pytest_runtest_call</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
<span class="sd">""" called to execute the test ``item``. """</span></div>
<div class="viewcode-block" id="pytest_runtest_teardown"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_runtest_teardown">[docs]</a><span class="k">def</span> <span class="nf">pytest_runtest_teardown</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="p">):</span>
<span class="sd">""" called after ``pytest_runtest_call``.</span>
<span class="sd"> :arg nextitem: the scheduled-to-be-next test item (None if no further</span>
<span class="sd"> test item is scheduled). This argument can be used to</span>
<span class="sd"> perform exact teardowns, i.e. calling just enough finalizers</span>
<span class="sd"> so that nextitem only needs to call setup-functions.</span>
<span class="sd"> """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_runtest_makereport"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_runtest_makereport">[docs]</a><span class="k">def</span> <span class="nf">pytest_runtest_makereport</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">call</span><span class="p">):</span>
<span class="sd">""" return a :py:class:`_pytest.runner.TestReport` object</span>
<span class="sd"> for the given :py:class:`pytest.Item` and</span>
<span class="sd"> :py:class:`_pytest.runner.CallInfo`.</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="pytest_runtest_logreport"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_runtest_logreport">[docs]</a><span class="k">def</span> <span class="nf">pytest_runtest_logreport</span><span class="p">(</span><span class="n">report</span><span class="p">):</span>
<span class="sd">""" process a test setup/call/teardown report relating to</span>
<span class="sd"> the respective phase of executing a test. """</span></div>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># test session related hooks</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="k">def</span> <span class="nf">pytest_sessionstart</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
<span class="sd">""" before session.main() is called. """</span>
<span class="k">def</span> <span class="nf">pytest_sessionfinish</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">exitstatus</span><span class="p">):</span>
<span class="sd">""" whole test run finishes. """</span>
<div class="viewcode-block" id="pytest_unconfigure"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_unconfigure">[docs]</a><span class="k">def</span> <span class="nf">pytest_unconfigure</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">""" called before test process is exited. """</span></div>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># hooks for customising the assert methods</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<div class="viewcode-block" id="pytest_assertrepr_compare"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_assertrepr_compare">[docs]</a><span class="k">def</span> <span class="nf">pytest_assertrepr_compare</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">op</span><span class="p">,</span> <span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">):</span>
<span class="sd">"""return explanation for comparisons in failing assert expressions.</span>
<span class="sd"> Return None for no custom explanation, otherwise return a list</span>
<span class="sd"> of strings. The strings will be joined by newlines but any newlines</span>
<span class="sd"> *in* a string will be escaped. Note that all but the first line will</span>
<span class="sd"> be indented sligthly, the intention is for the first line to be a summary.</span>
<span class="sd"> """</span></div>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># hooks for influencing reporting (invoked from _pytest_terminal)</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<div class="viewcode-block" id="pytest_report_header"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_report_header">[docs]</a><span class="k">def</span> <span class="nf">pytest_report_header</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">startdir</span><span class="p">):</span>
<span class="sd">""" return a string to be displayed as header info for terminal reporting."""</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<div class="viewcode-block" id="pytest_report_teststatus"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_report_teststatus">[docs]</a><span class="k">def</span> <span class="nf">pytest_report_teststatus</span><span class="p">(</span><span class="n">report</span><span class="p">):</span>
<span class="sd">""" return result-category, shortletter and verbose word for reporting."""</span></div>
<div class="viewcode-block" id="pytest_terminal_summary"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_terminal_summary">[docs]</a><span class="k">def</span> <span class="nf">pytest_terminal_summary</span><span class="p">(</span><span class="n">terminalreporter</span><span class="p">):</span>
<span class="sd">""" add additional section in terminal summary reporting. """</span></div>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">historic</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_logwarning</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">nodeid</span><span class="p">,</span> <span class="n">fslocation</span><span class="p">):</span>
<span class="sd">""" process a warning specified by a message, a code string,</span>
<span class="sd"> a nodeid and fslocation (both of which may be None</span>
<span class="sd"> if the warning is not tied to a partilar node/location)."""</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># doctest hooks</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="nd">@hookspec</span><span class="p">(</span><span class="n">firstresult</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_doctest_prepare_content</span><span class="p">(</span><span class="n">content</span><span class="p">):</span>
<span class="sd">""" return processed content for a given doctest"""</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<span class="c1"># error handling and internal debugging hooks</span>
<span class="c1"># -------------------------------------------------------------------------</span>
<div class="viewcode-block" id="pytest_internalerror"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_internalerror">[docs]</a><span class="k">def</span> <span class="nf">pytest_internalerror</span><span class="p">(</span><span class="n">excrepr</span><span class="p">,</span> <span class="n">excinfo</span><span class="p">):</span>
<span class="sd">""" called for internal errors. """</span></div>
<div class="viewcode-block" id="pytest_keyboard_interrupt"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_keyboard_interrupt">[docs]</a><span class="k">def</span> <span class="nf">pytest_keyboard_interrupt</span><span class="p">(</span><span class="n">excinfo</span><span class="p">):</span>
<span class="sd">""" called for keyboard interrupt. """</span></div>
<div class="viewcode-block" id="pytest_exception_interact"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_exception_interact">[docs]</a><span class="k">def</span> <span class="nf">pytest_exception_interact</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">call</span><span class="p">,</span> <span class="n">report</span><span class="p">):</span>
<span class="sd">"""called when an exception was raised which can potentially be</span>
<span class="sd"> interactively handled.</span>
<span class="sd"> This hook is only called if an exception was raised</span>
<span class="sd"> that is not an internal exception like ``skip.Exception``.</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="pytest_enter_pdb"><a class="viewcode-back" href="../../writing_plugins.html#_pytest.hookspec.pytest_enter_pdb">[docs]</a><span class="k">def</span> <span class="nf">pytest_enter_pdb</span><span class="p">():</span>
<span class="sd">""" called upon pdb.set_trace(), can be used by plugins to take special</span>
<span class="sd"> action just before the python debugger enters in interactive mode.</span>
<span class="sd"> """</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../contents.html">
<img class="logo" src="../../_static/pytest1.png" alt="Logo"/>
</a></p><h3><a href="../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../contents.html">Contents</a></li>
<li><a href="../../getting-started.html">Install</a></li>
<li><a href="../../example/index.html">Examples</a></li>
<li><a href="../../customize.html">Customize</a></li>
<li><a href="../../contact.html">Contact</a></li>
<li><a href="../../talks.html">Talks/Posts</a></li>
<li><a href="../../changelog.html">Changelog</a></li>
</ul><h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul><h3>Useful Links</h3>
<ul>
<li><a href="../../index.html">The pytest Website</a></li>
<li><a href="../../contributing.html">Contribution Guide</a></li>
<li><a href="https://pypi.python.org/pypi/pytest">pytest @ PyPI</a></li>
<li><a href="https://github.com/pytest-dev/pytest/">pytest @ GitHub</a></li>
<li><a href="http://plugincompat.herokuapp.com/">3rd party plugins</a></li>
<li><a href="https://github.com/pytest-dev/pytest/issues">Issue Tracker</a></li>
<li><a href="http://pytest.org/latest/pytest.pdf">PDF Documentation</a>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2015, holger krekel and pytest-dev team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|