/usr/share/doc/python-pytest-doc/html/writing_plugins.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 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 | <!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>Writing plugins</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" />
<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>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="writing-plugins">
<span id="plugins"></span><span id="id1"></span><h1>Writing plugins<a class="headerlink" href="#writing-plugins" title="Permalink to this headline">¶</a></h1>
<p>It is easy to implement <a class="reference internal" href="#local-conftest-plugins">local conftest plugins</a> for your own project
or <a class="reference internal" href="#pip-installable-plugins">pip-installable plugins</a> that can be used throughout many projects,
including third party projects. Please refer to <a class="reference internal" href="plugins.html#using-plugins"><span>Installing and Using plugins</span></a> if you
only want to use but not write plugins.</p>
<p>A plugin contains one or multiple hook functions. <a class="reference internal" href="#writinghooks"><span>Writing hooks</span></a>
explains the basics and details of how you can write a hook function yourself.
<code class="docutils literal"><span class="pre">pytest</span></code> implements all aspects of configuration, collection, running and
reporting by calling <a class="reference internal" href="#well-specified-hooks">well specified hooks</a> of the following plugins:</p>
<ul class="simple">
<li><a class="reference internal" href="plugins.html#builtin-plugins"><span>Pytest default plugin reference</span></a>: loaded from pytest’s internal <code class="docutils literal"><span class="pre">_pytest</span></code> directory.</li>
<li><a class="reference internal" href="plugins.html#extplugins"><span>external plugins</span></a>: modules discovered through
<a class="reference internal" href="#setuptools-entry-points">setuptools entry points</a></li>
<li><a class="reference internal" href="#conftest-py-plugins">conftest.py plugins</a>: modules auto-discovered in test directories</li>
</ul>
<p>In principle, each hook call is a <code class="docutils literal"><span class="pre">1:N</span></code> Python function call where <code class="docutils literal"><span class="pre">N</span></code> is the
number of registered implementation functions for a given specification.
All specifications and implementations following the <code class="docutils literal"><span class="pre">pytest_</span></code> prefix
naming convention, making them easy to distinguish and find.</p>
<div class="section" id="plugin-discovery-order-at-tool-startup">
<span id="pluginorder"></span><h2>Plugin discovery order at tool startup<a class="headerlink" href="#plugin-discovery-order-at-tool-startup" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal"><span class="pre">pytest</span></code> loads plugin modules at tool startup in the following way:</p>
<ul>
<li><p class="first">by loading all builtin plugins</p>
</li>
<li><p class="first">by loading all plugins registered through <a class="reference internal" href="#setuptools-entry-points">setuptools entry points</a>.</p>
</li>
<li><p class="first">by pre-scanning the command line for the <code class="docutils literal"><span class="pre">-p</span> <span class="pre">name</span></code> option
and loading the specified plugin before actual command line parsing.</p>
</li>
<li><p class="first">by loading all <code class="file docutils literal"><span class="pre">conftest.py</span></code> files as inferred by the command line
invocation:</p>
<ul class="simple">
<li>if no test paths are specified use current dir as a test path</li>
<li>if exists, load <code class="docutils literal"><span class="pre">conftest.py</span></code> and <code class="docutils literal"><span class="pre">test*/conftest.py</span></code> relative
to the directory part of the first test path.</li>
</ul>
<p>Note that pytest does not find <code class="docutils literal"><span class="pre">conftest.py</span></code> 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.</p>
</li>
<li><p class="first">by recursively loading all plugins specified by the
<code class="docutils literal"><span class="pre">pytest_plugins</span></code> variable in <code class="docutils literal"><span class="pre">conftest.py</span></code> files</p>
</li>
</ul>
</div>
<div class="section" id="conftest-py-local-per-directory-plugins">
<span id="local-conftest-plugins"></span><span id="conftest"></span><span id="localplugin"></span><span id="conftest-py"></span><span id="conftest-py-plugins"></span><h2>conftest.py: local per-directory plugins<a class="headerlink" href="#conftest-py-local-per-directory-plugins" title="Permalink to this headline">¶</a></h2>
<p>Local <code class="docutils literal"><span class="pre">conftest.py</span></code> plugins contain directory-specific hook
implementations. Hook Session and test running activities will
invoke all hooks defined in <code class="docutils literal"><span class="pre">conftest.py</span></code> files closer to the
root of the filesystem. Example of implementing the
<code class="docutils literal"><span class="pre">pytest_runtest_setup</span></code> hook so that is called for tests in the <code class="docutils literal"><span class="pre">a</span></code>
sub directory but not for other directories:</p>
<div class="highlight-python"><div class="highlight"><pre>a/conftest.py:
def pytest_runtest_setup(item):
# called for running each test in 'a' directory
print ("setting up", item)
a/test_sub.py:
def test_sub():
pass
test_flat.py:
def test_flat():
pass
</pre></div>
</div>
<p>Here is how you might run it:</p>
<div class="highlight-python"><div class="highlight"><pre>py.test test_flat.py # will not show "setting up"
py.test a/test_sub.py # will show "setting up"
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you have <code class="docutils literal"><span class="pre">conftest.py</span></code> files which do not reside in a
python package directory (i.e. one containing an <code class="docutils literal"><span class="pre">__init__.py</span></code>) then
“import conftest” can be ambiguous because there might be other
<code class="docutils literal"><span class="pre">conftest.py</span></code> files as well on your PYTHONPATH or <code class="docutils literal"><span class="pre">sys.path</span></code>.
It is thus good practice for projects to either put <code class="docutils literal"><span class="pre">conftest.py</span></code>
under a package scope or to never import anything from a
conftest.py file.</p>
</div>
</div>
<div class="section" id="writing-your-own-plugin">
<h2>Writing your own plugin<a class="headerlink" href="#writing-your-own-plugin" title="Permalink to this headline">¶</a></h2>
<p>If you want to write a plugin, there are many real-life examples
you can copy from:</p>
<ul class="simple">
<li>a custom collection example plugin: <a class="reference internal" href="example/nonpython.html#yaml-plugin"><span>A basic example for specifying tests in Yaml files</span></a></li>
<li>around 20 doc:<cite>builtin plugins</cite> which provide pytest’s own functionality</li>
<li>many <a class="reference external" href="http://plugincompat.herokuapp.com">external plugins</a> providing additional features</li>
</ul>
<p>All of these plugins implement the documented <a class="reference internal" href="#well-specified-hooks">well specified hooks</a>
to extend and add functionality.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Make sure to check out the excellent
<a class="reference external" href="https://github.com/pytest-dev/cookiecutter-pytest-plugin">cookiecutter-pytest-plugin</a>
project, which is a <a class="reference external" href="https://github.com/audreyr/cookiecutter">cookiecutter template</a>
for authoring plugins.</p>
<p class="last">The template provides an excellent starting point with a working plugin,
tests running with tox, comprehensive README and
entry-pointy already pre-configured.</p>
</div>
<p>Also consider <a class="reference internal" href="contributing.html#submitplugin"><span>contributing your plugin to pytest-dev</span></a>
once it has some happy users other than yourself.</p>
</div>
<div class="section" id="making-your-plugin-installable-by-others">
<span id="pip-installable-plugins"></span><span id="setuptools-entry-points"></span><h2>Making your plugin installable by others<a class="headerlink" href="#making-your-plugin-installable-by-others" title="Permalink to this headline">¶</a></h2>
<p>If you want to make your plugin externally available, you
may define a so-called entry point for your distribution so
that <code class="docutils literal"><span class="pre">pytest</span></code> finds your plugin module. Entry points are
a feature that is provided by <a class="reference external" href="http://pypi.python.org/pypi/setuptools">setuptools</a>. pytest looks up
the <code class="docutils literal"><span class="pre">pytest11</span></code> entrypoint to discover its
plugins and you can thus make your plugin available by defining
it in your setuptools-invocation:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># sample ./setup.py file</span>
<span class="kn">from</span> <span class="nn">setuptools</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"myproject"</span><span class="p">,</span>
<span class="n">packages</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'myproject'</span><span class="p">]</span>
<span class="c1"># the following makes a plugin available to pytest</span>
<span class="n">entry_points</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'pytest11'</span><span class="p">:</span> <span class="p">[</span>
<span class="s1">'name_of_plugin = myproject.pluginmodule'</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="p">)</span>
</pre></div>
</div>
<p>If a package is installed this way, <code class="docutils literal"><span class="pre">pytest</span></code> will load
<code class="docutils literal"><span class="pre">myproject.pluginmodule</span></code> as a plugin which can define
<a class="reference internal" href="#well-specified-hooks">well specified hooks</a>.</p>
</div>
<div class="section" id="requiring-loading-plugins-in-a-test-module-or-conftest-file">
<h2>Requiring/Loading plugins in a test module or conftest file<a class="headerlink" href="#requiring-loading-plugins-in-a-test-module-or-conftest-file" title="Permalink to this headline">¶</a></h2>
<p>You can require plugins in a test module or a conftest file like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">pytest_plugins</span> <span class="o">=</span> <span class="s2">"name1"</span><span class="p">,</span> <span class="s2">"name2"</span><span class="p">,</span>
</pre></div>
</div>
<p>When the test module or conftest plugin is loaded the specified plugins
will be loaded as well. You can also use dotted path like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">pytest_plugins</span> <span class="o">=</span> <span class="s2">"myapp.testsupport.myplugin"</span>
</pre></div>
</div>
<p>which will import the specified module as a <code class="docutils literal"><span class="pre">pytest</span></code> plugin.</p>
</div>
<div class="section" id="accessing-another-plugin-by-name">
<h2>Accessing another plugin by name<a class="headerlink" href="#accessing-another-plugin-by-name" title="Permalink to this headline">¶</a></h2>
<p>If a plugin wants to collaborate with code from
another plugin it can obtain a reference through
the plugin manager like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">plugin</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">pluginmanager</span><span class="o">.</span><span class="n">getplugin</span><span class="p">(</span><span class="s2">"name_of_plugin"</span><span class="p">)</span>
</pre></div>
</div>
<p>If you want to look at the names of existing plugins, use
the <code class="docutils literal"><span class="pre">--traceconfig</span></code> option.</p>
</div>
<div class="section" id="testing-plugins">
<h2>Testing plugins<a class="headerlink" href="#testing-plugins" title="Permalink to this headline">¶</a></h2>
<p>pytest comes with some facilities that you can enable for testing your
plugin. Given that you have an installed plugin you can enable the
<a class="reference internal" href="#_pytest.pytester.Testdir" title="_pytest.pytester.Testdir"><code class="xref py py-class docutils literal"><span class="pre">testdir</span></code></a> fixture via specifying a
command line option to include the pytester plugin (<code class="docutils literal"><span class="pre">-p</span> <span class="pre">pytester</span></code>) or
by putting <code class="docutils literal"><span class="pre">pytest_plugins</span> <span class="pre">=</span> <span class="pre">"pytester"</span></code> into your test or
<code class="docutils literal"><span class="pre">conftest.py</span></code> file. You then will have a <code class="docutils literal"><span class="pre">testdir</span></code> fixture which you
can use like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># content of test_myplugin.py</span>
<span class="n">pytest_plugins</span> <span class="o">=</span> <span class="s2">"pytester"</span> <span class="c1"># to get testdir fixture</span>
<span class="k">def</span> <span class="nf">test_myplugin</span><span class="p">(</span><span class="n">testdir</span><span class="p">):</span>
<span class="n">testdir</span><span class="o">.</span><span class="n">makepyfile</span><span class="p">(</span><span class="s2">"""</span>
<span class="s2"> def test_example():</span>
<span class="s2"> pass</span>
<span class="s2"> """</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">testdir</span><span class="o">.</span><span class="n">runpytest</span><span class="p">(</span><span class="s2">"--verbose"</span><span class="p">)</span>
<span class="n">result</span><span class="o">.</span><span class="n">fnmatch_lines</span><span class="p">(</span><span class="s2">"""</span>
<span class="s2"> test_example*</span>
<span class="s2"> """</span><span class="p">)</span>
</pre></div>
</div>
<p>Note that by default <code class="docutils literal"><span class="pre">testdir.runpytest()</span></code> will perform a pytest
in-process. You can pass the command line option <code class="docutils literal"><span class="pre">--runpytest=subprocess</span></code>
to have it happen in a subprocess.</p>
<p>Also see the <a class="reference internal" href="#_pytest.pytester.RunResult" title="_pytest.pytester.RunResult"><code class="xref py py-class docutils literal"><span class="pre">RunResult</span></code></a> for more
methods of the result object that you get from a call to <code class="docutils literal"><span class="pre">runpytest</span></code>.</p>
</div>
</div>
<div class="section" id="writing-hook-functions">
<span id="writinghooks"></span><h1>Writing hook functions<a class="headerlink" href="#writing-hook-functions" title="Permalink to this headline">¶</a></h1>
<div class="section" id="hook-function-validation-and-execution">
<span id="validation"></span><h2>hook function validation and execution<a class="headerlink" href="#hook-function-validation-and-execution" title="Permalink to this headline">¶</a></h2>
<p>pytest calls hook functions from registered plugins for any
given hook specification. Let’s look at a typical hook function
for the <code class="docutils literal"><span class="pre">pytest_collection_modifyitems(session,</span> <span class="pre">config,</span>
<span class="pre">items)</span></code> hook which pytest calls after collection of all test items is
completed.</p>
<p>When we implement a <code class="docutils literal"><span class="pre">pytest_collection_modifyitems</span></code> function in our plugin
pytest will during registration verify that you use argument
names which match the specification and bail out if not.</p>
<p>Let’s look at a possible implementation:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">pytest_collection_modifyitems</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="c1"># called after collection is completed</span>
<span class="c1"># you can modify the ``items`` list</span>
</pre></div>
</div>
<p>Here, <code class="docutils literal"><span class="pre">pytest</span></code> will pass in <code class="docutils literal"><span class="pre">config</span></code> (the pytest config object)
and <code class="docutils literal"><span class="pre">items</span></code> (the list of collected test items) but will not pass
in the <code class="docutils literal"><span class="pre">session</span></code> argument because we didn’t list it in the function
signature. This dynamic “pruning” of arguments allows <code class="docutils literal"><span class="pre">pytest</span></code> to
be “future-compatible”: we can introduce new hook named parameters without
breaking the signatures of existing hook implementations. It is one of
the reasons for the general long-lived compatibility of pytest plugins.</p>
<p>Note that hook functions other than <code class="docutils literal"><span class="pre">pytest_runtest_*</span></code> are not
allowed to raise exceptions. Doing so will break the pytest run.</p>
</div>
<div class="section" id="firstresult-stop-at-first-non-none-result">
<h2>firstresult: stop at first non-None result<a class="headerlink" href="#firstresult-stop-at-first-non-none-result" title="Permalink to this headline">¶</a></h2>
<p>Most calls to <code class="docutils literal"><span class="pre">pytest</span></code> hooks result in a <strong>list of results</strong> which contains
all non-None results of the called hook functions.</p>
<p>Some hook specifications use the <code class="docutils literal"><span class="pre">firstresult=True</span></code> option so that the hook
call only executes until the first of N registered functions returns a
non-None result which is then taken as result of the overall hook call.
The remaining hook functions will not be called in this case.</p>
</div>
<div class="section" id="hookwrapper-executing-around-other-hooks">
<h2>hookwrapper: executing around other hooks<a class="headerlink" href="#hookwrapper-executing-around-other-hooks" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 2.7: </span>(experimental)</p>
</div>
<p>pytest plugins can implement hook wrappers which wrap the execution
of other hook implementations. A hook wrapper is a generator function
which yields exactly once. When pytest invokes hooks it first executes
hook wrappers and passes the same arguments as to the regular hooks.</p>
<p>At the yield point of the hook wrapper pytest will execute the next hook
implementations and return their result to the yield point in the form of
a <code class="xref py py-class docutils literal"><span class="pre">CallOutcome</span></code> instance which encapsulates a result or
exception info. The yield point itself will thus typically not raise
exceptions (unless there are bugs).</p>
<p>Here is an example definition of a hook wrapper:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">pytest</span>
<span class="nd">@pytest.hookimpl</span><span class="p">(</span><span class="n">hookwrapper</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="c1"># do whatever you want before the next hook executes</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="k">yield</span>
<span class="c1"># outcome.excinfo may be None or a (cls, val, tb) tuple</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">outcome</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span> <span class="c1"># will raise if outcome was exception</span>
<span class="c1"># postprocess result</span>
</pre></div>
</div>
<p>Note that hook wrappers don’t return results themselves, they merely
perform tracing or other side effects around the actual hook implementations.
If the result of the underlying hook is a mutable object, they may modify
that result but it’s probably better to avoid it.</p>
</div>
<div class="section" id="hook-function-ordering-call-example">
<h2>Hook function ordering / call example<a class="headerlink" href="#hook-function-ordering-call-example" title="Permalink to this headline">¶</a></h2>
<p>For any given hook specification there may be more than one
implementation and we thus generally view <code class="docutils literal"><span class="pre">hook</span></code> execution as a
<code class="docutils literal"><span class="pre">1:N</span></code> function call where <code class="docutils literal"><span class="pre">N</span></code> is the number of registered functions.
There are ways to influence if a hook implementation comes before or
after others, i.e. the position in the <code class="docutils literal"><span class="pre">N</span></code>-sized list of functions:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># Plugin 1</span>
<span class="nd">@pytest.hookimpl</span><span class="p">(</span><span class="n">tryfirst</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_collection_modifyitems</span><span class="p">(</span><span class="n">items</span><span class="p">):</span>
<span class="c1"># will execute as early as possible</span>
<span class="c1"># Plugin 2</span>
<span class="nd">@pytest.hookimpl</span><span class="p">(</span><span class="n">trylast</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_collection_modifyitems</span><span class="p">(</span><span class="n">items</span><span class="p">):</span>
<span class="c1"># will execute as late as possible</span>
<span class="c1"># Plugin 3</span>
<span class="nd">@pytest.hookimpl</span><span class="p">(</span><span class="n">hookwrapper</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_collection_modifyitems</span><span class="p">(</span><span class="n">items</span><span class="p">):</span>
<span class="c1"># will execute even before the tryfirst one above!</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="k">yield</span>
<span class="c1"># will execute after all non-hookwrappers executed</span>
</pre></div>
</div>
<p>Here is the order of execution:</p>
<ol class="arabic simple">
<li>Plugin3’s pytest_collection_modifyitems called until the yield point
because it is a hook wrapper.</li>
<li>Plugin1’s pytest_collection_modifyitems is called because it is marked
with <code class="docutils literal"><span class="pre">tryfirst=True</span></code>.</li>
<li>Plugin2’s pytest_collection_modifyitems is called because it is marked
with <code class="docutils literal"><span class="pre">trylast=True</span></code> (but even without this mark it would come after
Plugin1).</li>
<li>Plugin3’s pytest_collection_modifyitems then executing the code after the yield
point. The yield receives a <code class="xref py py-class docutils literal"><span class="pre">CallOutcome</span></code> instance which encapsulates
the result from calling the non-wrappers. Wrappers shall not modify the result.</li>
</ol>
<p>It’s possible to use <code class="docutils literal"><span class="pre">tryfirst</span></code> and <code class="docutils literal"><span class="pre">trylast</span></code> also in conjunction with
<code class="docutils literal"><span class="pre">hookwrapper=True</span></code> in which case it will influence the ordering of hookwrappers
among each other.</p>
</div>
<div class="section" id="declaring-new-hooks">
<h2>Declaring new hooks<a class="headerlink" href="#declaring-new-hooks" title="Permalink to this headline">¶</a></h2>
<p>Plugins and <code class="docutils literal"><span class="pre">conftest.py</span></code> files may declare new hooks that can then be
implemented by other plugins in order to alter behaviour or interact with
the new plugin:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_addhooks">
<code class="descname">pytest_addhooks</code><span class="sig-paren">(</span><em>pluginmanager</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_addhooks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_addhooks" title="Permalink to this definition">¶</a></dt>
<dd><p>called at plugin registration time to allow adding new hooks via a call to
pluginmanager.add_hookspecs(module_or_class, prefix).</p>
</dd></dl>
<p>Hooks are usually declared as do-nothing functions that contain only
documentation describing when the hook will be called and what return values
are expected.</p>
<p>For an example, see <a class="reference external" href="https://github.com/pytest-dev/pytest-xdist/blob/974bd566c599dc6a9ea291838c6f226197208b46/xdist/newhooks.py">newhooks.py</a> from <a class="reference internal" href="xdist.html#xdist"><span>xdist: pytest distributed testing plugin</span></a>.</p>
</div>
<div class="section" id="optionally-using-hooks-from-3rd-party-plugins">
<h2>Optionally using hooks from 3rd party plugins<a class="headerlink" href="#optionally-using-hooks-from-3rd-party-plugins" title="Permalink to this headline">¶</a></h2>
<p>Using new hooks from plugins as explained above might be a little tricky
because of the standard <a class="reference internal" href="#validation"><span>validation mechanism</span></a>:
if you depend on a plugin that is not installed, validation will fail and
the error message will not make much sense to your users.</p>
<p>One approach is to defer the hook implementation to a new plugin instead of
declaring the hook functions directly in your plugin module, for example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># contents of myplugin.py</span>
<span class="k">class</span> <span class="nc">DeferPlugin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Simple plugin to defer pytest-xdist hook functions."""</span>
<span class="k">def</span> <span class="nf">pytest_testnodedown</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
<span class="sd">"""standard xdist hook function.</span>
<span class="sd"> """</span>
<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="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">pluginmanager</span><span class="o">.</span><span class="n">hasplugin</span><span class="p">(</span><span class="s1">'xdist'</span><span class="p">):</span>
<span class="n">config</span><span class="o">.</span><span class="n">pluginmanager</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">DeferPlugin</span><span class="p">())</span>
</pre></div>
</div>
<p>This has the added benefit of allowing you to conditionally install hooks
depending on which plugins are installed.</p>
</div>
</div>
<div class="section" id="pytest-hook-reference">
<span id="well-specified-hooks"></span><h1>pytest hook reference<a class="headerlink" href="#pytest-hook-reference" title="Permalink to this headline">¶</a></h1>
<div class="section" id="initialization-command-line-and-configuration-hooks">
<h2>Initialization, command line and configuration hooks<a class="headerlink" href="#initialization-command-line-and-configuration-hooks" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="_pytest.hookspec.pytest_load_initial_conftests">
<code class="descname">pytest_load_initial_conftests</code><span class="sig-paren">(</span><em>args</em>, <em>early_config</em>, <em>parser</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_load_initial_conftests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_load_initial_conftests" title="Permalink to this definition">¶</a></dt>
<dd><p>implements the loading of initial conftest files ahead
of command line option parsing.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_cmdline_preparse">
<code class="descname">pytest_cmdline_preparse</code><span class="sig-paren">(</span><em>config</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_cmdline_preparse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_cmdline_preparse" title="Permalink to this definition">¶</a></dt>
<dd><p>(deprecated) modify command line arguments before option parsing.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_cmdline_parse">
<code class="descname">pytest_cmdline_parse</code><span class="sig-paren">(</span><em>pluginmanager</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_cmdline_parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_cmdline_parse" title="Permalink to this definition">¶</a></dt>
<dd><p>return initialized config object, parsing the specified args.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_namespace">
<code class="descname">pytest_namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_namespace" title="Permalink to this definition">¶</a></dt>
<dd><p>return dict of name->object to be made globally available in
the pytest namespace. This hook is called at plugin registration
time.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_addoption">
<code class="descname">pytest_addoption</code><span class="sig-paren">(</span><em>parser</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_addoption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_addoption" title="Permalink to this definition">¶</a></dt>
<dd><p>register argparse-style options and ini-style config values.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>This function must be implemented in a <a class="reference internal" href="#pluginorder"><span>plugin</span></a>
and is called once at the beginning of a test run.</p>
<p class="last">Implementing this hook from <code class="docutils literal"><span class="pre">conftest.py</span></code> files is <strong>strongly</strong>
discouraged because <code class="docutils literal"><span class="pre">conftest.py</span></code> files are lazily loaded and
may give strange <em>unknown option</em> errors depending on the directory
<code class="docutils literal"><span class="pre">py.test</span></code> is invoked from.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parser</strong> – To add command line options, call
<a class="reference internal" href="#_pytest.config.Parser.addoption" title="_pytest.config.Parser.addoption"><code class="xref py py-func docutils literal"><span class="pre">parser.addoption(...)</span></code></a>.
To add ini-file values call <a class="reference internal" href="#_pytest.config.Parser.addini" title="_pytest.config.Parser.addini"><code class="xref py py-func docutils literal"><span class="pre">parser.addini(...)</span></code></a>.</td>
</tr>
</tbody>
</table>
<p>Options can later be accessed through the
<a class="reference internal" href="#_pytest.config.Config" title="_pytest.config.Config"><code class="xref py py-class docutils literal"><span class="pre">config</span></code></a> object, respectively:</p>
<ul class="simple">
<li><a class="reference internal" href="#_pytest.config.Config.getoption" title="_pytest.config.Config.getoption"><code class="xref py py-func docutils literal"><span class="pre">config.getoption(name)</span></code></a> to
retrieve the value of a command line option.</li>
<li><a class="reference internal" href="#_pytest.config.Config.getini" title="_pytest.config.Config.getini"><code class="xref py py-func docutils literal"><span class="pre">config.getini(name)</span></code></a> to retrieve
a value read from an ini-style file.</li>
</ul>
<p>The config object is passed around on many internal objects via the <code class="docutils literal"><span class="pre">.config</span></code>
attribute or can be retrieved as the <code class="docutils literal"><span class="pre">pytestconfig</span></code> fixture or accessed
via (deprecated) <code class="docutils literal"><span class="pre">pytest.config</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_cmdline_main">
<code class="descname">pytest_cmdline_main</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_cmdline_main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_cmdline_main" title="Permalink to this definition">¶</a></dt>
<dd><p>called for performing the main command line action. The default
implementation will invoke the configure hooks and runtest_mainloop.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_configure">
<code class="descname">pytest_configure</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_configure" title="Permalink to this definition">¶</a></dt>
<dd><p>called after command line options have been parsed
and all plugins and initial conftest files been loaded.
This hook is called for every plugin.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_unconfigure">
<code class="descname">pytest_unconfigure</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_unconfigure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_unconfigure" title="Permalink to this definition">¶</a></dt>
<dd><p>called before test process is exited.</p>
</dd></dl>
</div>
<div class="section" id="generic-runtest-hooks">
<h2>Generic “runtest” hooks<a class="headerlink" href="#generic-runtest-hooks" title="Permalink to this headline">¶</a></h2>
<p>All runtest related hooks receive a <code class="xref py py-class docutils literal"><span class="pre">pytest.Item</span></code> object.</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_runtest_protocol">
<code class="descname">pytest_runtest_protocol</code><span class="sig-paren">(</span><em>item</em>, <em>nextitem</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_runtest_protocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_runtest_protocol" title="Permalink to this definition">¶</a></dt>
<dd><p>implements the runtest_setup/call/teardown protocol for
the given test item, including capturing exceptions and calling
reporting hooks.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> – test item for which the runtest protocol is performed.</li>
<li><strong>nextitem</strong> – the scheduled-to-be-next test item (or None if this
is the end my friend). This argument is passed on to
<a class="reference internal" href="#_pytest.hookspec.pytest_runtest_teardown" title="_pytest.hookspec.pytest_runtest_teardown"><code class="xref py py-func docutils literal"><span class="pre">pytest_runtest_teardown()</span></code></a>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return boolean:</th><td class="field-body"><p class="first last">True if no further hook implementations should be invoked.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_runtest_setup">
<code class="descname">pytest_runtest_setup</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_runtest_setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_runtest_setup" title="Permalink to this definition">¶</a></dt>
<dd><p>called before <code class="docutils literal"><span class="pre">pytest_runtest_call(item)</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_runtest_call">
<code class="descname">pytest_runtest_call</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_runtest_call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_runtest_call" title="Permalink to this definition">¶</a></dt>
<dd><p>called to execute the test <code class="docutils literal"><span class="pre">item</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_runtest_teardown">
<code class="descname">pytest_runtest_teardown</code><span class="sig-paren">(</span><em>item</em>, <em>nextitem</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_runtest_teardown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_runtest_teardown" title="Permalink to this definition">¶</a></dt>
<dd><p>called after <code class="docutils literal"><span class="pre">pytest_runtest_call</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nextitem</strong> – 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.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_runtest_makereport">
<code class="descname">pytest_runtest_makereport</code><span class="sig-paren">(</span><em>item</em>, <em>call</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_runtest_makereport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_runtest_makereport" title="Permalink to this definition">¶</a></dt>
<dd><p>return a <a class="reference internal" href="#_pytest.runner.TestReport" title="_pytest.runner.TestReport"><code class="xref py py-class docutils literal"><span class="pre">_pytest.runner.TestReport</span></code></a> object
for the given <code class="xref py py-class docutils literal"><span class="pre">pytest.Item</span></code> and
<a class="reference internal" href="#_pytest.runner.CallInfo" title="_pytest.runner.CallInfo"><code class="xref py py-class docutils literal"><span class="pre">_pytest.runner.CallInfo</span></code></a>.</p>
</dd></dl>
<p>For deeper understanding you may look at the default implementation of
these hooks in <code class="xref py py-mod docutils literal"><span class="pre">_pytest.runner</span></code> and maybe also
in <code class="xref py py-mod docutils literal"><span class="pre">_pytest.pdb</span></code> which interacts with <code class="xref py py-mod docutils literal"><span class="pre">_pytest.capture</span></code>
and its input/output capturing in order to immediately drop
into interactive debugging when a test failure occurs.</p>
<p>The <code class="xref py py-mod docutils literal"><span class="pre">_pytest.terminal</span></code> reported specifically uses
the reporting hook to print information about a test run.</p>
</div>
<div class="section" id="collection-hooks">
<h2>Collection hooks<a class="headerlink" href="#collection-hooks" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal"><span class="pre">pytest</span></code> calls the following hooks for collecting files and directories:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_ignore_collect">
<code class="descname">pytest_ignore_collect</code><span class="sig-paren">(</span><em>path</em>, <em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_ignore_collect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_ignore_collect" title="Permalink to this definition">¶</a></dt>
<dd><p>return True to prevent considering this path for collection.
This hook is consulted for all files and directories prior to calling
more specific hooks.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_collect_directory">
<code class="descname">pytest_collect_directory</code><span class="sig-paren">(</span><em>path</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_collect_directory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_collect_directory" title="Permalink to this definition">¶</a></dt>
<dd><p>called before traversing a directory for collection files.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_collect_file">
<code class="descname">pytest_collect_file</code><span class="sig-paren">(</span><em>path</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_collect_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_collect_file" title="Permalink to this definition">¶</a></dt>
<dd><p>return collection Node or None for the given path. Any new node
needs to have the specified <code class="docutils literal"><span class="pre">parent</span></code> as a parent.</p>
</dd></dl>
<p>For influencing the collection of objects in Python modules
you can use the following hook:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_pycollect_makeitem">
<code class="descname">pytest_pycollect_makeitem</code><span class="sig-paren">(</span><em>collector</em>, <em>name</em>, <em>obj</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_pycollect_makeitem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_pycollect_makeitem" title="Permalink to this definition">¶</a></dt>
<dd><p>return custom item/collector for a python object in a module, or None.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_generate_tests">
<code class="descname">pytest_generate_tests</code><span class="sig-paren">(</span><em>metafunc</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_generate_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_generate_tests" title="Permalink to this definition">¶</a></dt>
<dd><p>generate (multiple) parametrized calls to a test function.</p>
</dd></dl>
<p>After collection is complete, you can modify the order of
items, delete or otherwise amend the test items:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_collection_modifyitems">
<code class="descname">pytest_collection_modifyitems</code><span class="sig-paren">(</span><em>session</em>, <em>config</em>, <em>items</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_collection_modifyitems"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_collection_modifyitems" title="Permalink to this definition">¶</a></dt>
<dd><p>called after collection has been performed, may filter or re-order
the items in-place.</p>
</dd></dl>
</div>
<div class="section" id="reporting-hooks">
<h2>Reporting hooks<a class="headerlink" href="#reporting-hooks" title="Permalink to this headline">¶</a></h2>
<p>Session related reporting hooks:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_collectstart">
<code class="descname">pytest_collectstart</code><span class="sig-paren">(</span><em>collector</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_collectstart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_collectstart" title="Permalink to this definition">¶</a></dt>
<dd><p>collector starts collecting.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_itemcollected">
<code class="descname">pytest_itemcollected</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_itemcollected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_itemcollected" title="Permalink to this definition">¶</a></dt>
<dd><p>we just collected a test item.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_collectreport">
<code class="descname">pytest_collectreport</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_collectreport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_collectreport" title="Permalink to this definition">¶</a></dt>
<dd><p>collector finished collecting.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_deselected">
<code class="descname">pytest_deselected</code><span class="sig-paren">(</span><em>items</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_deselected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_deselected" title="Permalink to this definition">¶</a></dt>
<dd><p>called for test items deselected by keyword.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_report_header">
<code class="descname">pytest_report_header</code><span class="sig-paren">(</span><em>config</em>, <em>startdir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_report_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_report_header" title="Permalink to this definition">¶</a></dt>
<dd><p>return a string to be displayed as header info for terminal reporting.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_report_teststatus">
<code class="descname">pytest_report_teststatus</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_report_teststatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_report_teststatus" title="Permalink to this definition">¶</a></dt>
<dd><p>return result-category, shortletter and verbose word for reporting.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_terminal_summary">
<code class="descname">pytest_terminal_summary</code><span class="sig-paren">(</span><em>terminalreporter</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_terminal_summary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_terminal_summary" title="Permalink to this definition">¶</a></dt>
<dd><p>add additional section in terminal summary reporting.</p>
</dd></dl>
<p>And here is the central hook for reporting about
test execution:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_runtest_logreport">
<code class="descname">pytest_runtest_logreport</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_runtest_logreport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_runtest_logreport" title="Permalink to this definition">¶</a></dt>
<dd><p>process a test setup/call/teardown report relating to
the respective phase of executing a test.</p>
</dd></dl>
<p>You can also use this hook to customize assertion representation for some
types:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_assertrepr_compare">
<code class="descname">pytest_assertrepr_compare</code><span class="sig-paren">(</span><em>config</em>, <em>op</em>, <em>left</em>, <em>right</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_assertrepr_compare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_assertrepr_compare" title="Permalink to this definition">¶</a></dt>
<dd><p>return explanation for comparisons in failing assert expressions.</p>
<p>Return None for no custom explanation, otherwise return a list
of strings. The strings will be joined by newlines but any newlines
<em>in</em> 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.</p>
</dd></dl>
</div>
<div class="section" id="debugging-interaction-hooks">
<h2>Debugging/Interaction hooks<a class="headerlink" href="#debugging-interaction-hooks" title="Permalink to this headline">¶</a></h2>
<p>There are few hooks which can be used for special
reporting or interaction with exceptions:</p>
<dl class="function">
<dt id="_pytest.hookspec.pytest_internalerror">
<code class="descname">pytest_internalerror</code><span class="sig-paren">(</span><em>excrepr</em>, <em>excinfo</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_internalerror"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_internalerror" title="Permalink to this definition">¶</a></dt>
<dd><p>called for internal errors.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_keyboard_interrupt">
<code class="descname">pytest_keyboard_interrupt</code><span class="sig-paren">(</span><em>excinfo</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_keyboard_interrupt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_keyboard_interrupt" title="Permalink to this definition">¶</a></dt>
<dd><p>called for keyboard interrupt.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_exception_interact">
<code class="descname">pytest_exception_interact</code><span class="sig-paren">(</span><em>node</em>, <em>call</em>, <em>report</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_exception_interact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_exception_interact" title="Permalink to this definition">¶</a></dt>
<dd><p>called when an exception was raised which can potentially be
interactively handled.</p>
<p>This hook is only called if an exception was raised
that is not an internal exception like <code class="docutils literal"><span class="pre">skip.Exception</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="_pytest.hookspec.pytest_enter_pdb">
<code class="descname">pytest_enter_pdb</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/hookspec.html#pytest_enter_pdb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.hookspec.pytest_enter_pdb" title="Permalink to this definition">¶</a></dt>
<dd><p>called upon pdb.set_trace(), can be used by plugins to take special
action just before the python debugger enters in interactive mode.</p>
</dd></dl>
</div>
</div>
<div class="section" id="reference-of-objects-involved-in-hooks">
<h1>Reference of objects involved in hooks<a class="headerlink" href="#reference-of-objects-involved-in-hooks" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="_pytest.config.Config">
<em class="property">class </em><code class="descname">Config</code><a class="reference internal" href="_modules/_pytest/config.html#Config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config" title="Permalink to this definition">¶</a></dt>
<dd><p>access to configuration values, pluginmanager and plugin hooks.</p>
<dl class="attribute">
<dt id="_pytest.config.Config.option">
<code class="descname">option</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.config.Config.option" title="Permalink to this definition">¶</a></dt>
<dd><p>access to command line option as attributes.
(deprecated), use <a class="reference internal" href="#_pytest.config.Config.getoption" title="_pytest.config.Config.getoption"><code class="xref py py-func docutils literal"><span class="pre">getoption()</span></code></a> instead</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.config.Config.pluginmanager">
<code class="descname">pluginmanager</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.config.Config.pluginmanager" title="Permalink to this definition">¶</a></dt>
<dd><p>a pluginmanager instance</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.add_cleanup">
<code class="descname">add_cleanup</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.add_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.add_cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a function to be called when the config object gets out of
use (usually coninciding with pytest_unconfigure).</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.warn">
<code class="descname">warn</code><span class="sig-paren">(</span><em>code</em>, <em>message</em>, <em>fslocation=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.warn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.warn" title="Permalink to this definition">¶</a></dt>
<dd><p>generate a warning for this test session.</p>
</dd></dl>
<dl class="classmethod">
<dt id="_pytest.config.Config.fromdictargs">
<em class="property">classmethod </em><code class="descname">fromdictargs</code><span class="sig-paren">(</span><em>option_dict</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.fromdictargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.fromdictargs" title="Permalink to this definition">¶</a></dt>
<dd><p>constructor useable for subprocesses.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.addinivalue_line">
<code class="descname">addinivalue_line</code><span class="sig-paren">(</span><em>name</em>, <em>line</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.addinivalue_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.addinivalue_line" title="Permalink to this definition">¶</a></dt>
<dd><p>add a line to an ini-file option. The option must have been
declared but might not yet be set in which case the line becomes the
the first line in its value.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.getini">
<code class="descname">getini</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.getini"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.getini" title="Permalink to this definition">¶</a></dt>
<dd><p>return configuration value from an <a class="reference internal" href="customize.html#inifiles"><span>ini file</span></a>. If the
specified name hasn’t been registered through a prior
<code class="xref py py-func docutils literal"><span class="pre">parser.addini</span></code>
call (usually from a plugin), a ValueError is raised.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.getoption">
<code class="descname">getoption</code><span class="sig-paren">(</span><em>name</em>, <em>default=<NOTSET></em>, <em>skip=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.getoption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.getoption" title="Permalink to this definition">¶</a></dt>
<dd><p>return command line option value.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – name of the option. You may also specify
the literal <code class="docutils literal"><span class="pre">--OPT</span></code> option instead of the “dest” option name.</li>
<li><strong>default</strong> – default value if no option of that name exists.</li>
<li><strong>skip</strong> – if True raise pytest.skip if option does not exists
or has a None value.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.getvalue">
<code class="descname">getvalue</code><span class="sig-paren">(</span><em>name</em>, <em>path=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.getvalue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.getvalue" title="Permalink to this definition">¶</a></dt>
<dd><p>(deprecated, use getoption())</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Config.getvalueorskip">
<code class="descname">getvalueorskip</code><span class="sig-paren">(</span><em>name</em>, <em>path=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Config.getvalueorskip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Config.getvalueorskip" title="Permalink to this definition">¶</a></dt>
<dd><p>(deprecated, use getoption(skip=True))</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="_pytest.config.Parser">
<em class="property">class </em><code class="descname">Parser</code><a class="reference internal" href="_modules/_pytest/config.html#Parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Parser" title="Permalink to this definition">¶</a></dt>
<dd><p>Parser for command line arguments and ini-file values.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Variables:</th><td class="field-body"><strong>extra_info</strong> – dict of generic param -> value to display in case
there’s an error processing the command line arguments.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="_pytest.config.Parser.getgroup">
<code class="descname">getgroup</code><span class="sig-paren">(</span><em>name</em>, <em>description=''</em>, <em>after=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Parser.getgroup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Parser.getgroup" title="Permalink to this definition">¶</a></dt>
<dd><p>get (or create) a named option Group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Name:</th><td class="field-body">name of the option group.</td>
</tr>
<tr class="field-even field"><th class="field-name">Description:</th><td class="field-body">long description for –help output.</td>
</tr>
<tr class="field-odd field"><th class="field-name">After:</th><td class="field-body">name of other group, used for ordering –help output.</td>
</tr>
</tbody>
</table>
<p>The returned group object has an <code class="docutils literal"><span class="pre">addoption</span></code> method with the same
signature as <a class="reference internal" href="#_pytest.config.Parser.addoption" title="_pytest.config.Parser.addoption"><code class="xref py py-func docutils literal"><span class="pre">parser.addoption</span></code></a> but will be shown in the
respective group in the output of <code class="docutils literal"><span class="pre">pytest.</span> <span class="pre">--help</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Parser.addoption">
<code class="descname">addoption</code><span class="sig-paren">(</span><em>*opts</em>, <em>**attrs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Parser.addoption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Parser.addoption" title="Permalink to this definition">¶</a></dt>
<dd><p>register a command line option.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Opts:</th><td class="field-body">option names, can be short or long options.</td>
</tr>
<tr class="field-even field"><th class="field-name">Attrs:</th><td class="field-body">same attributes which the <code class="docutils literal"><span class="pre">add_option()</span></code> function of the
<a class="reference external" href="http://docs.python.org/2/library/argparse.html">argparse library</a>
accepts.</td>
</tr>
</tbody>
</table>
<p>After command line parsing options are available on the pytest config
object via <code class="docutils literal"><span class="pre">config.option.NAME</span></code> where <code class="docutils literal"><span class="pre">NAME</span></code> is usually set
by passing a <code class="docutils literal"><span class="pre">dest</span></code> attribute, for example
<code class="docutils literal"><span class="pre">addoption("--long",</span> <span class="pre">dest="NAME",</span> <span class="pre">...)</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Parser.parse_known_args">
<code class="descname">parse_known_args</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Parser.parse_known_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Parser.parse_known_args" title="Permalink to this definition">¶</a></dt>
<dd><p>parses and returns a namespace object with known arguments at this
point.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Parser.parse_known_and_unknown_args">
<code class="descname">parse_known_and_unknown_args</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Parser.parse_known_and_unknown_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Parser.parse_known_and_unknown_args" title="Permalink to this definition">¶</a></dt>
<dd><p>parses and returns a namespace object with known arguments, and
the remaining arguments unknown at this point.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.Parser.addini">
<code class="descname">addini</code><span class="sig-paren">(</span><em>name</em>, <em>help</em>, <em>type=None</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#Parser.addini"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.Parser.addini" title="Permalink to this definition">¶</a></dt>
<dd><p>register an ini-file option.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Name:</th><td class="field-body">name of the ini-variable</td>
</tr>
<tr class="field-even field"><th class="field-name">Type:</th><td class="field-body">type of the variable, can be <code class="docutils literal"><span class="pre">pathlist</span></code>, <code class="docutils literal"><span class="pre">args</span></code> or <code class="docutils literal"><span class="pre">linelist</span></code>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Default:</th><td class="field-body">default value if no ini-file option exists but is queried.</td>
</tr>
</tbody>
</table>
<p>The value of ini-variables can be retrieved via a call to
<a class="reference internal" href="#_pytest.config.Config.getini" title="_pytest.config.Config.getini"><code class="xref py py-func docutils literal"><span class="pre">config.getini(name)</span></code></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="_pytest.runner.CallInfo">
<em class="property">class </em><code class="descname">CallInfo</code><a class="reference internal" href="_modules/_pytest/runner.html#CallInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.runner.CallInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Result/Exception info a function invocation.</p>
<dl class="attribute">
<dt id="_pytest.runner.CallInfo.when">
<code class="descname">when</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.CallInfo.when" title="Permalink to this definition">¶</a></dt>
<dd><p>context of invocation: one of “setup”, “call”,
“teardown”, “memocollect”</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.CallInfo.excinfo">
<code class="descname">excinfo</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.CallInfo.excinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>None or ExceptionInfo object.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="_pytest.runner.TestReport">
<em class="property">class </em><code class="descname">TestReport</code><a class="reference internal" href="_modules/_pytest/runner.html#TestReport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.runner.TestReport" title="Permalink to this definition">¶</a></dt>
<dd><p>Basic test report object (also used for setup and teardown calls if
they fail).</p>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.nodeid">
<code class="descname">nodeid</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.nodeid" title="Permalink to this definition">¶</a></dt>
<dd><p>normalized collection node id</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.location">
<code class="descname">location</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.location" title="Permalink to this definition">¶</a></dt>
<dd><p>a (filesystempath, lineno, domaininfo) tuple indicating the
actual location of a test item - it might be different from the
collected one e.g. if a method is inherited from a different module.</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.keywords">
<code class="descname">keywords</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.keywords" title="Permalink to this definition">¶</a></dt>
<dd><p>a name -> value dictionary containing all keywords and
markers associated with a test invocation.</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.outcome">
<code class="descname">outcome</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.outcome" title="Permalink to this definition">¶</a></dt>
<dd><p>test outcome, always one of “passed”, “failed”, “skipped”.</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.longrepr">
<code class="descname">longrepr</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.longrepr" title="Permalink to this definition">¶</a></dt>
<dd><p>None or a failure representation.</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.when">
<code class="descname">when</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.when" title="Permalink to this definition">¶</a></dt>
<dd><p>one of ‘setup’, ‘call’, ‘teardown’ to indicate runtest phase.</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.sections">
<code class="descname">sections</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.sections" title="Permalink to this definition">¶</a></dt>
<dd><p>list of (secname, data) extra information which needs to
marshallable</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.runner.TestReport.duration">
<code class="descname">duration</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.runner.TestReport.duration" title="Permalink to this definition">¶</a></dt>
<dd><p>time it took to run just the test</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="_pytest.config.get_plugin_manager">
<code class="descname">get_plugin_manager</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#get_plugin_manager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.get_plugin_manager" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain a new instance of the
<a class="reference internal" href="#_pytest.config.PytestPluginManager" title="_pytest.config.PytestPluginManager"><code class="xref py py-class docutils literal"><span class="pre">_pytest.config.PytestPluginManager</span></code></a>, with default plugins
already loaded.</p>
<p>This function can be used by integration with other tools, like hooking
into pytest to run tests into an IDE.</p>
</dd></dl>
<dl class="class">
<dt id="_pytest.config.PytestPluginManager">
<em class="property">class </em><code class="descname">PytestPluginManager</code><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">_pytest.vendored_packages.pluggy.PluginManager</span></code></p>
<p>Overwrites <code class="xref py py-class docutils literal"><span class="pre">pluggy.PluginManager</span></code> to add pytest-specific
functionality:</p>
<ul class="simple">
<li>loading plugins from the command line, <code class="docutils literal"><span class="pre">PYTEST_PLUGIN</span></code> env variable and
<code class="docutils literal"><span class="pre">pytest_plugins</span></code> global variables found in plugins being loaded;</li>
<li><code class="docutils literal"><span class="pre">conftest.py</span></code> loading during start-up;</li>
</ul>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.addhooks">
<code class="descname">addhooks</code><span class="sig-paren">(</span><em>module_or_class</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.addhooks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.addhooks" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified">Deprecated since version 2.8.</span></p>
</div>
<p>Use <code class="xref py py-meth docutils literal"><span class="pre">pluggy.PluginManager.add_hookspecs()</span></code> instead.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.parse_hookimpl_opts">
<code class="descname">parse_hookimpl_opts</code><span class="sig-paren">(</span><em>plugin</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.parse_hookimpl_opts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.parse_hookimpl_opts" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.parse_hookspec_opts">
<code class="descname">parse_hookspec_opts</code><span class="sig-paren">(</span><em>module_or_class</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.parse_hookspec_opts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.parse_hookspec_opts" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.register">
<code class="descname">register</code><span class="sig-paren">(</span><em>plugin</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.register" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.getplugin">
<code class="descname">getplugin</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.getplugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.getplugin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.hasplugin">
<code class="descname">hasplugin</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.hasplugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.hasplugin" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if the plugin with the given name is registered.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.pytest_configure">
<code class="descname">pytest_configure</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.pytest_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.pytest_configure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.consider_preparse">
<code class="descname">consider_preparse</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.consider_preparse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.consider_preparse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.consider_pluginarg">
<code class="descname">consider_pluginarg</code><span class="sig-paren">(</span><em>arg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.consider_pluginarg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.consider_pluginarg" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.consider_conftest">
<code class="descname">consider_conftest</code><span class="sig-paren">(</span><em>conftestmodule</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.consider_conftest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.consider_conftest" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.consider_env">
<code class="descname">consider_env</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.consider_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.consider_env" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.consider_module">
<code class="descname">consider_module</code><span class="sig-paren">(</span><em>mod</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.consider_module"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.consider_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="_pytest.config.PytestPluginManager.import_plugin">
<code class="descname">import_plugin</code><span class="sig-paren">(</span><em>modname</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/config.html#PytestPluginManager.import_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.config.PytestPluginManager.import_plugin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="_pytest.pytester.Testdir">
<em class="property">class </em><code class="descname">Testdir</code><a class="reference internal" href="_modules/_pytest/pytester.html#Testdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.Testdir" title="Permalink to this definition">¶</a></dt>
<dd><p>Temporary test directory with tools to test/run py.test itself.</p>
<p>This is based on the <code class="docutils literal"><span class="pre">tmpdir</span></code> fixture but provides a number of
methods which aid with testing py.test itself. Unless
<code class="xref py py-meth docutils literal"><span class="pre">chdir()</span></code> is used all methods will use <code class="xref py py-attr docutils literal"><span class="pre">tmpdir</span></code> as
current working directory.</p>
<p>Attributes:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tmpdir:</th><td class="field-body">The <code class="xref py py-class docutils literal"><span class="pre">py.path.local</span></code> instance of the temporary
directory.</td>
</tr>
<tr class="field-even field"><th class="field-name">Plugins:</th><td class="field-body">A list of plugins to use with <code class="xref py py-meth docutils literal"><span class="pre">parseconfig()</span></code> and
<a class="reference internal" href="#_pytest.pytester.Testdir.runpytest" title="_pytest.pytester.Testdir.runpytest"><code class="xref py py-meth docutils literal"><span class="pre">runpytest()</span></code></a>. Initially this is an empty list but
plugins can be added to the list. The type of items to add to
the list depend on the method which uses them so refer to them
for details.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="_pytest.pytester.Testdir.makeconftest">
<code class="descname">makeconftest</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#Testdir.makeconftest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.Testdir.makeconftest" title="Permalink to this definition">¶</a></dt>
<dd><p>Write a contest.py file with ‘source’ as contents.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.Testdir.makepyfile">
<code class="descname">makepyfile</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#Testdir.makepyfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.Testdir.makepyfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Shortcut for .makefile() with a .py extension.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.Testdir.runpytest_inprocess">
<code class="descname">runpytest_inprocess</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#Testdir.runpytest_inprocess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.Testdir.runpytest_inprocess" title="Permalink to this definition">¶</a></dt>
<dd><p>Return result of running pytest in-process, providing a similar
interface to what self.runpytest() provides.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.Testdir.runpytest">
<code class="descname">runpytest</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#Testdir.runpytest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.Testdir.runpytest" title="Permalink to this definition">¶</a></dt>
<dd><p>Run pytest inline or in a subprocess, depending on the command line
option “–runpytest” and return a <a class="reference internal" href="#_pytest.pytester.RunResult" title="_pytest.pytester.RunResult"><code class="xref py py-class docutils literal"><span class="pre">RunResult</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.Testdir.runpytest_subprocess">
<code class="descname">runpytest_subprocess</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#Testdir.runpytest_subprocess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.Testdir.runpytest_subprocess" title="Permalink to this definition">¶</a></dt>
<dd><p>Run py.test as a subprocess with given arguments.</p>
<p>Any plugins added to the <code class="xref py py-attr docutils literal"><span class="pre">plugins</span></code> list will added
using the <code class="docutils literal"><span class="pre">-p</span></code> command line option. Addtionally
<code class="docutils literal"><span class="pre">--basetemp</span></code> is used put any temporary files and directories
in a numbered directory prefixed with “runpytest-” so they do
not conflict with the normal numberd pytest location for
temporary files and directories.</p>
<p>Returns a <a class="reference internal" href="#_pytest.pytester.RunResult" title="_pytest.pytester.RunResult"><code class="xref py py-class docutils literal"><span class="pre">RunResult</span></code></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="_pytest.pytester.RunResult">
<em class="property">class </em><code class="descname">RunResult</code><a class="reference internal" href="_modules/_pytest/pytester.html#RunResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.RunResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of running a command.</p>
<p>Attributes:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Ret:</th><td class="field-body">The return value.</td>
</tr>
<tr class="field-even field"><th class="field-name">Outlines:</th><td class="field-body">List of lines captured from stdout.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Errlines:</th><td class="field-body">List of lines captures from stderr.</td>
</tr>
<tr class="field-even field"><th class="field-name">Stdout:</th><td class="field-body"><a class="reference internal" href="#_pytest.pytester.LineMatcher" title="_pytest.pytester.LineMatcher"><code class="xref py py-class docutils literal"><span class="pre">LineMatcher</span></code></a> of stdout, use <code class="docutils literal"><span class="pre">stdout.str()</span></code> to
reconstruct stdout or the commonly used
<code class="docutils literal"><span class="pre">stdout.fnmatch_lines()</span></code> method.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Stderrr:</th><td class="field-body"><a class="reference internal" href="#_pytest.pytester.LineMatcher" title="_pytest.pytester.LineMatcher"><code class="xref py py-class docutils literal"><span class="pre">LineMatcher</span></code></a> of stderr.</td>
</tr>
<tr class="field-even field"><th class="field-name">Duration:</th><td class="field-body">Duration in seconds.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="_pytest.pytester.RunResult.parseoutcomes">
<code class="descname">parseoutcomes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#RunResult.parseoutcomes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.RunResult.parseoutcomes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dictionary of outcomestring->num from parsing
the terminal output that the test process produced.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.RunResult.assert_outcomes">
<code class="descname">assert_outcomes</code><span class="sig-paren">(</span><em>passed=0</em>, <em>skipped=0</em>, <em>failed=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#RunResult.assert_outcomes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.RunResult.assert_outcomes" title="Permalink to this definition">¶</a></dt>
<dd><p>assert that the specified outcomes appear with the respective
numbers (0 means it didn’t occur) in the text output from a test run.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="_pytest.pytester.LineMatcher">
<em class="property">class </em><code class="descname">LineMatcher</code><a class="reference internal" href="_modules/_pytest/pytester.html#LineMatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.LineMatcher" title="Permalink to this definition">¶</a></dt>
<dd><p>Flexible matching of text.</p>
<p>This is a convenience class to test large texts like the output of
commands.</p>
<p>The constructor takes a list of lines without their trailing
newlines, i.e. <code class="docutils literal"><span class="pre">text.splitlines()</span></code>.</p>
<dl class="method">
<dt id="_pytest.pytester.LineMatcher.str">
<code class="descname">str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#LineMatcher.str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.LineMatcher.str" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the entire original text.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.LineMatcher.fnmatch_lines_random">
<code class="descname">fnmatch_lines_random</code><span class="sig-paren">(</span><em>lines2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#LineMatcher.fnmatch_lines_random"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.LineMatcher.fnmatch_lines_random" title="Permalink to this definition">¶</a></dt>
<dd><p>Check lines exist in the output.</p>
<p>The argument is a list of lines which have to occur in the
output, in any order. Each line can contain glob whildcards.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.LineMatcher.get_lines_after">
<code class="descname">get_lines_after</code><span class="sig-paren">(</span><em>fnline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#LineMatcher.get_lines_after"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.LineMatcher.get_lines_after" title="Permalink to this definition">¶</a></dt>
<dd><p>Return all lines following the given line in the text.</p>
<p>The given line can contain glob wildcards.</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.pytester.LineMatcher.fnmatch_lines">
<code class="descname">fnmatch_lines</code><span class="sig-paren">(</span><em>lines2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/pytester.html#LineMatcher.fnmatch_lines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.pytester.LineMatcher.fnmatch_lines" title="Permalink to this definition">¶</a></dt>
<dd><p>Search the text for matching lines.</p>
<p>The argument is a list of lines which have to match and can
use glob wildcards. If they do not match an pytest.fail() is
called. The matches and non-matches are also printed on
stdout.</p>
</dd></dl>
</dd></dl>
</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>
<hr>
<ul>
<li><a class="reference internal" href="#">Writing plugins</a><ul>
<li><a class="reference internal" href="#plugin-discovery-order-at-tool-startup">Plugin discovery order at tool startup</a></li>
<li><a class="reference internal" href="#conftest-py-local-per-directory-plugins">conftest.py: local per-directory plugins</a></li>
<li><a class="reference internal" href="#writing-your-own-plugin">Writing your own plugin</a></li>
<li><a class="reference internal" href="#making-your-plugin-installable-by-others">Making your plugin installable by others</a></li>
<li><a class="reference internal" href="#requiring-loading-plugins-in-a-test-module-or-conftest-file">Requiring/Loading plugins in a test module or conftest file</a></li>
<li><a class="reference internal" href="#accessing-another-plugin-by-name">Accessing another plugin by name</a></li>
<li><a class="reference internal" href="#testing-plugins">Testing plugins</a></li>
</ul>
</li>
<li><a class="reference internal" href="#writing-hook-functions">Writing hook functions</a><ul>
<li><a class="reference internal" href="#hook-function-validation-and-execution">hook function validation and execution</a></li>
<li><a class="reference internal" href="#firstresult-stop-at-first-non-none-result">firstresult: stop at first non-None result</a></li>
<li><a class="reference internal" href="#hookwrapper-executing-around-other-hooks">hookwrapper: executing around other hooks</a></li>
<li><a class="reference internal" href="#hook-function-ordering-call-example">Hook function ordering / call example</a></li>
<li><a class="reference internal" href="#declaring-new-hooks">Declaring new hooks</a></li>
<li><a class="reference internal" href="#optionally-using-hooks-from-3rd-party-plugins">Optionally using hooks from 3rd party plugins</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pytest-hook-reference">pytest hook reference</a><ul>
<li><a class="reference internal" href="#initialization-command-line-and-configuration-hooks">Initialization, command line and configuration hooks</a></li>
<li><a class="reference internal" href="#generic-runtest-hooks">Generic “runtest” hooks</a></li>
<li><a class="reference internal" href="#collection-hooks">Collection hooks</a></li>
<li><a class="reference internal" href="#reporting-hooks">Reporting hooks</a></li>
<li><a class="reference internal" href="#debugging-interaction-hooks">Debugging/Interaction hooks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#reference-of-objects-involved-in-hooks">Reference of objects involved in hooks</a></li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
</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>
|