/usr/share/doc/python-pytest-doc/html/_modules/_pytest/runner.html is in python-pytest-doc 2.6.3-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>_pytest.runner</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.6.2',
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="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li><a href="../../contents.html">pytest-2.6.2</a> »</li>
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for _pytest.runner</h1><div class="highlight"><pre>
<span class="sd">""" basic collect and runtest protocol implementations """</span>
<span class="kn">import</span> <span class="nn">bdb</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">time</span> <span class="kn">import</span> <span class="n">time</span>
<span class="kn">import</span> <span class="nn">py</span>
<span class="kn">import</span> <span class="nn">pytest</span>
<span class="kn">from</span> <span class="nn">py._code.code</span> <span class="kn">import</span> <span class="n">TerminalRepr</span>
<span class="k">def</span> <span class="nf">pytest_namespace</span><span class="p">():</span>
<span class="k">return</span> <span class="p">{</span>
<span class="s">'fail'</span> <span class="p">:</span> <span class="n">fail</span><span class="p">,</span>
<span class="s">'skip'</span> <span class="p">:</span> <span class="n">skip</span><span class="p">,</span>
<span class="s">'importorskip'</span> <span class="p">:</span> <span class="n">importorskip</span><span class="p">,</span>
<span class="s">'exit'</span> <span class="p">:</span> <span class="nb">exit</span><span class="p">,</span>
<span class="p">}</span>
<span class="c">#</span>
<span class="c"># pytest plugin hooks</span>
<span class="k">def</span> <span class="nf">pytest_addoption</span><span class="p">(</span><span class="n">parser</span><span class="p">):</span>
<span class="n">group</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">getgroup</span><span class="p">(</span><span class="s">"terminal reporting"</span><span class="p">,</span> <span class="s">"reporting"</span><span class="p">,</span> <span class="n">after</span><span class="o">=</span><span class="s">"general"</span><span class="p">)</span>
<span class="n">group</span><span class="o">.</span><span class="n">addoption</span><span class="p">(</span><span class="s">'--durations'</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s">"store"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s">"N"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s">"show N slowest setup/test durations (N=0 for all)."</span><span class="p">),</span>
<span class="k">def</span> <span class="nf">pytest_terminal_summary</span><span class="p">(</span><span class="n">terminalreporter</span><span class="p">):</span>
<span class="n">durations</span> <span class="o">=</span> <span class="n">terminalreporter</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">option</span><span class="o">.</span><span class="n">durations</span>
<span class="k">if</span> <span class="n">durations</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">tr</span> <span class="o">=</span> <span class="n">terminalreporter</span>
<span class="n">dlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">replist</span> <span class="ow">in</span> <span class="n">tr</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="k">for</span> <span class="n">rep</span> <span class="ow">in</span> <span class="n">replist</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">rep</span><span class="p">,</span> <span class="s">'duration'</span><span class="p">):</span>
<span class="n">dlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rep</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dlist</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">dlist</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">duration</span><span class="p">)</span>
<span class="n">dlist</span><span class="o">.</span><span class="n">reverse</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">durations</span><span class="p">:</span>
<span class="n">tr</span><span class="o">.</span><span class="n">write_sep</span><span class="p">(</span><span class="s">"="</span><span class="p">,</span> <span class="s">"slowest test durations"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">tr</span><span class="o">.</span><span class="n">write_sep</span><span class="p">(</span><span class="s">"="</span><span class="p">,</span> <span class="s">"slowest </span><span class="si">%s</span><span class="s"> test durations"</span> <span class="o">%</span> <span class="n">durations</span><span class="p">)</span>
<span class="n">dlist</span> <span class="o">=</span> <span class="n">dlist</span><span class="p">[:</span><span class="n">durations</span><span class="p">]</span>
<span class="k">for</span> <span class="n">rep</span> <span class="ow">in</span> <span class="n">dlist</span><span class="p">:</span>
<span class="n">nodeid</span> <span class="o">=</span> <span class="n">rep</span><span class="o">.</span><span class="n">nodeid</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">"::()::"</span><span class="p">,</span> <span class="s">"::"</span><span class="p">)</span>
<span class="n">tr</span><span class="o">.</span><span class="n">write_line</span><span class="p">(</span><span class="s">"</span><span class="si">%02.2f</span><span class="s">s </span><span class="si">%-8s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">rep</span><span class="o">.</span><span class="n">duration</span><span class="p">,</span> <span class="n">rep</span><span class="o">.</span><span class="n">when</span><span class="p">,</span> <span class="n">nodeid</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">pytest_sessionstart</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
<span class="n">session</span><span class="o">.</span><span class="n">_setupstate</span> <span class="o">=</span> <span class="n">SetupState</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">pytest_sessionfinish</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
<span class="n">session</span><span class="o">.</span><span class="n">_setupstate</span><span class="o">.</span><span class="n">teardown_all</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">NodeInfo</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span>
<span class="k">def</span> <span class="nf">pytest_runtest_protocol</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="p">):</span>
<span class="n">item</span><span class="o">.</span><span class="n">ihook</span><span class="o">.</span><span class="n">pytest_runtest_logstart</span><span class="p">(</span>
<span class="n">nodeid</span><span class="o">=</span><span class="n">item</span><span class="o">.</span><span class="n">nodeid</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="n">item</span><span class="o">.</span><span class="n">location</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">runtestprotocol</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="o">=</span><span class="n">nextitem</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">def</span> <span class="nf">runtestprotocol</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">nextitem</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="n">hasrequest</span> <span class="o">=</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s">"_request"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">hasrequest</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">item</span><span class="o">.</span><span class="n">_request</span><span class="p">:</span>
<span class="n">item</span><span class="o">.</span><span class="n">_initrequest</span><span class="p">()</span>
<span class="n">rep</span> <span class="o">=</span> <span class="n">call_and_report</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s">"setup"</span><span class="p">,</span> <span class="n">log</span><span class="p">)</span>
<span class="n">reports</span> <span class="o">=</span> <span class="p">[</span><span class="n">rep</span><span class="p">]</span>
<span class="k">if</span> <span class="n">rep</span><span class="o">.</span><span class="n">passed</span><span class="p">:</span>
<span class="n">reports</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">call_and_report</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s">"call"</span><span class="p">,</span> <span class="n">log</span><span class="p">))</span>
<span class="n">reports</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">call_and_report</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s">"teardown"</span><span class="p">,</span> <span class="n">log</span><span class="p">,</span>
<span class="n">nextitem</span><span class="o">=</span><span class="n">nextitem</span><span class="p">))</span>
<span class="c"># after all teardown hooks have been called</span>
<span class="c"># want funcargs and request info to go away</span>
<span class="k">if</span> <span class="n">hasrequest</span><span class="p">:</span>
<span class="n">item</span><span class="o">.</span><span class="n">_request</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">item</span><span class="o">.</span><span class="n">funcargs</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">return</span> <span class="n">reports</span>
<span class="k">def</span> <span class="nf">pytest_runtest_setup</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
<span class="n">item</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">_setupstate</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_runtest_call</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
<span class="n">item</span><span class="o">.</span><span class="n">runtest</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">pytest_runtest_teardown</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="p">):</span>
<span class="n">item</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">_setupstate</span><span class="o">.</span><span class="n">teardown_exact</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_report_teststatus</span><span class="p">(</span><span class="n">report</span><span class="p">):</span>
<span class="k">if</span> <span class="n">report</span><span class="o">.</span><span class="n">when</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"setup"</span><span class="p">,</span> <span class="s">"teardown"</span><span class="p">):</span>
<span class="k">if</span> <span class="n">report</span><span class="o">.</span><span class="n">failed</span><span class="p">:</span>
<span class="c"># category, shortletter, verbose-word</span>
<span class="k">return</span> <span class="s">"error"</span><span class="p">,</span> <span class="s">"E"</span><span class="p">,</span> <span class="s">"ERROR"</span>
<span class="k">elif</span> <span class="n">report</span><span class="o">.</span><span class="n">skipped</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"skipped"</span><span class="p">,</span> <span class="s">"s"</span><span class="p">,</span> <span class="s">"SKIPPED"</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s">""</span><span class="p">,</span> <span class="s">""</span><span class="p">,</span> <span class="s">""</span>
<span class="c">#</span>
<span class="c"># Implementation</span>
<span class="k">def</span> <span class="nf">call_and_report</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">when</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">):</span>
<span class="n">call</span> <span class="o">=</span> <span class="n">call_runtest_hook</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">when</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">)</span>
<span class="n">hook</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">ihook</span>
<span class="n">report</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">pytest_runtest_makereport</span><span class="p">(</span><span class="n">item</span><span class="o">=</span><span class="n">item</span><span class="p">,</span> <span class="n">call</span><span class="o">=</span><span class="n">call</span><span class="p">)</span>
<span class="k">if</span> <span class="n">log</span><span class="p">:</span>
<span class="n">hook</span><span class="o">.</span><span class="n">pytest_runtest_logreport</span><span class="p">(</span><span class="n">report</span><span class="o">=</span><span class="n">report</span><span class="p">)</span>
<span class="k">if</span> <span class="n">check_interactive_exception</span><span class="p">(</span><span class="n">call</span><span class="p">,</span> <span class="n">report</span><span class="p">):</span>
<span class="n">hook</span><span class="o">.</span><span class="n">pytest_exception_interact</span><span class="p">(</span><span class="n">node</span><span class="o">=</span><span class="n">item</span><span class="p">,</span> <span class="n">call</span><span class="o">=</span><span class="n">call</span><span class="p">,</span> <span class="n">report</span><span class="o">=</span><span class="n">report</span><span class="p">)</span>
<span class="k">return</span> <span class="n">report</span>
<span class="k">def</span> <span class="nf">check_interactive_exception</span><span class="p">(</span><span class="n">call</span><span class="p">,</span> <span class="n">report</span><span class="p">):</span>
<span class="k">return</span> <span class="n">call</span><span class="o">.</span><span class="n">excinfo</span> <span class="ow">and</span> <span class="ow">not</span> <span class="p">(</span>
<span class="nb">hasattr</span><span class="p">(</span><span class="n">report</span><span class="p">,</span> <span class="s">"wasxfail"</span><span class="p">)</span> <span class="ow">or</span>
<span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="o">.</span><span class="n">errisinstance</span><span class="p">(</span><span class="n">skip</span><span class="o">.</span><span class="n">Exception</span><span class="p">)</span> <span class="ow">or</span>
<span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="o">.</span><span class="n">errisinstance</span><span class="p">(</span><span class="n">bdb</span><span class="o">.</span><span class="n">BdbQuit</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">call_runtest_hook</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">when</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">):</span>
<span class="n">hookname</span> <span class="o">=</span> <span class="s">"pytest_runtest_"</span> <span class="o">+</span> <span class="n">when</span>
<span class="n">ihook</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">ihook</span><span class="p">,</span> <span class="n">hookname</span><span class="p">)</span>
<span class="k">return</span> <span class="n">CallInfo</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">ihook</span><span class="p">(</span><span class="n">item</span><span class="o">=</span><span class="n">item</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">),</span> <span class="n">when</span><span class="o">=</span><span class="n">when</span><span class="p">)</span>
<div class="viewcode-block" id="CallInfo"><a class="viewcode-back" href="../../plugins.html#_pytest.runner.CallInfo">[docs]</a><span class="k">class</span> <span class="nc">CallInfo</span><span class="p">:</span>
<span class="sd">""" Result/Exception info a function invocation. """</span>
<span class="c">#: None or ExceptionInfo object.</span>
<span class="n">excinfo</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="n">when</span><span class="p">):</span>
<span class="c">#: context of invocation: one of "setup", "call",</span>
<span class="c">#: "teardown", "memocollect"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">when</span> <span class="o">=</span> <span class="n">when</span>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result</span> <span class="o">=</span> <span class="n">func</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stop</span> <span class="o">=</span> <span class="n">time</span><span class="p">()</span>
<span class="k">raise</span>
<span class="k">except</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">excinfo</span> <span class="o">=</span> <span class="n">py</span><span class="o">.</span><span class="n">code</span><span class="o">.</span><span class="n">ExceptionInfo</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stop</span> <span class="o">=</span> <span class="n">time</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">excinfo</span><span class="p">:</span>
<span class="n">status</span> <span class="o">=</span> <span class="s">"exception: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">excinfo</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">status</span> <span class="o">=</span> <span class="s">"result: </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="p">,)</span>
<span class="k">return</span> <span class="s">"<CallInfo when=</span><span class="si">%r</span><span class="s"> </span><span class="si">%s</span><span class="s">>"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">when</span><span class="p">,</span> <span class="n">status</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">getslaveinfoline</span><span class="p">(</span><span class="n">node</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">node</span><span class="o">.</span><span class="n">_slaveinfocache</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">node</span><span class="o">.</span><span class="n">slaveinfo</span>
<span class="n">ver</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">d</span><span class="p">[</span><span class="s">'version_info'</span><span class="p">][:</span><span class="mi">3</span><span class="p">]</span>
<span class="n">node</span><span class="o">.</span><span class="n">_slaveinfocache</span> <span class="o">=</span> <span class="n">s</span> <span class="o">=</span> <span class="s">"[</span><span class="si">%s</span><span class="s">] </span><span class="si">%s</span><span class="s"> -- Python </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">d</span><span class="p">[</span><span class="s">'id'</span><span class="p">],</span> <span class="n">d</span><span class="p">[</span><span class="s">'sysplatform'</span><span class="p">],</span> <span class="n">ver</span><span class="p">,</span> <span class="n">d</span><span class="p">[</span><span class="s">'executable'</span><span class="p">])</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">class</span> <span class="nc">BaseReport</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kw</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">toterminal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out</span><span class="p">):</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">longrepr</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'node'</span><span class="p">):</span>
<span class="n">out</span><span class="o">.</span><span class="n">line</span><span class="p">(</span><span class="n">getslaveinfoline</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="p">))</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">longrepr</span><span class="p">,</span> <span class="s">'toterminal'</span><span class="p">):</span>
<span class="n">longrepr</span><span class="o">.</span><span class="n">toterminal</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">out</span><span class="o">.</span><span class="n">line</span><span class="p">(</span><span class="n">longrepr</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeEncodeError</span><span class="p">:</span>
<span class="n">out</span><span class="o">.</span><span class="n">line</span><span class="p">(</span><span class="s">"<unprintable longrepr>"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_sections</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">content</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">sections</span><span class="p">:</span>
<span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">prefix</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">content</span>
<span class="n">passed</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">outcome</span> <span class="o">==</span> <span class="s">"passed"</span><span class="p">)</span>
<span class="n">failed</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">outcome</span> <span class="o">==</span> <span class="s">"failed"</span><span class="p">)</span>
<span class="n">skipped</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">outcome</span> <span class="o">==</span> <span class="s">"skipped"</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">fspath</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodeid</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"::"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">pytest_runtest_makereport</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">call</span><span class="p">):</span>
<span class="n">when</span> <span class="o">=</span> <span class="n">call</span><span class="o">.</span><span class="n">when</span>
<span class="n">duration</span> <span class="o">=</span> <span class="n">call</span><span class="o">.</span><span class="n">stop</span><span class="o">-</span><span class="n">call</span><span class="o">.</span><span class="n">start</span>
<span class="n">keywords</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="n">x</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">item</span><span class="o">.</span><span class="n">keywords</span><span class="p">])</span>
<span class="n">excinfo</span> <span class="o">=</span> <span class="n">call</span><span class="o">.</span><span class="n">excinfo</span>
<span class="n">sections</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="p">:</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"passed"</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">excinfo</span><span class="p">,</span> <span class="n">py</span><span class="o">.</span><span class="n">code</span><span class="o">.</span><span class="n">ExceptionInfo</span><span class="p">):</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"failed"</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="n">excinfo</span>
<span class="k">elif</span> <span class="n">excinfo</span><span class="o">.</span><span class="n">errisinstance</span><span class="p">(</span><span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="o">.</span><span class="n">Exception</span><span class="p">):</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"skipped"</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">excinfo</span><span class="o">.</span><span class="n">_getreprcrash</span><span class="p">()</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">path</span><span class="p">),</span> <span class="n">r</span><span class="o">.</span><span class="n">lineno</span><span class="p">,</span> <span class="n">r</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"failed"</span>
<span class="k">if</span> <span class="n">call</span><span class="o">.</span><span class="n">when</span> <span class="o">==</span> <span class="s">"call"</span><span class="p">:</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">repr_failure</span><span class="p">(</span><span class="n">excinfo</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span> <span class="c"># exception in setup or teardown</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">_repr_failure_py</span><span class="p">(</span><span class="n">excinfo</span><span class="p">,</span>
<span class="n">style</span><span class="o">=</span><span class="n">item</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">option</span><span class="o">.</span><span class="n">tbstyle</span><span class="p">)</span>
<span class="k">for</span> <span class="n">rwhen</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">content</span> <span class="ow">in</span> <span class="n">item</span><span class="o">.</span><span class="n">_report_sections</span><span class="p">:</span>
<span class="n">sections</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s">"Captured std</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">rwhen</span><span class="p">),</span> <span class="n">content</span><span class="p">))</span>
<span class="k">return</span> <span class="n">TestReport</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">nodeid</span><span class="p">,</span> <span class="n">item</span><span class="o">.</span><span class="n">location</span><span class="p">,</span>
<span class="n">keywords</span><span class="p">,</span> <span class="n">outcome</span><span class="p">,</span> <span class="n">longrepr</span><span class="p">,</span> <span class="n">when</span><span class="p">,</span>
<span class="n">sections</span><span class="p">,</span> <span class="n">duration</span><span class="p">)</span>
<div class="viewcode-block" id="TestReport"><a class="viewcode-back" href="../../plugins.html#_pytest.runner.TestReport">[docs]</a><span class="k">class</span> <span class="nc">TestReport</span><span class="p">(</span><span class="n">BaseReport</span><span class="p">):</span>
<span class="sd">""" Basic test report object (also used for setup and teardown calls if</span>
<span class="sd"> they fail).</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodeid</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">keywords</span><span class="p">,</span> <span class="n">outcome</span><span class="p">,</span>
<span class="n">longrepr</span><span class="p">,</span> <span class="n">when</span><span class="p">,</span> <span class="n">sections</span><span class="o">=</span><span class="p">(),</span> <span class="n">duration</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
<span class="c">#: normalized collection node id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodeid</span> <span class="o">=</span> <span class="n">nodeid</span>
<span class="c">#: a (filesystempath, lineno, domaininfo) tuple indicating the</span>
<span class="c">#: actual location of a test item - it might be different from the</span>
<span class="c">#: collected one e.g. if a method is inherited from a different module.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span>
<span class="c">#: a name -> value dictionary containing all keywords and</span>
<span class="c">#: markers associated with a test invocation.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keywords</span> <span class="o">=</span> <span class="n">keywords</span>
<span class="c">#: test outcome, always one of "passed", "failed", "skipped".</span>
<span class="bp">self</span><span class="o">.</span><span class="n">outcome</span> <span class="o">=</span> <span class="n">outcome</span>
<span class="c">#: None or a failure representation.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">longrepr</span> <span class="o">=</span> <span class="n">longrepr</span>
<span class="c">#: one of 'setup', 'call', 'teardown' to indicate runtest phase.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">when</span> <span class="o">=</span> <span class="n">when</span>
<span class="c">#: list of (secname, data) extra information which needs to</span>
<span class="c">#: marshallable</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sections</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">sections</span><span class="p">)</span>
<span class="c">#: time it took to run just the test</span>
<span class="bp">self</span><span class="o">.</span><span class="n">duration</span> <span class="o">=</span> <span class="n">duration</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">extra</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"<TestReport </span><span class="si">%r</span><span class="s"> when=</span><span class="si">%r</span><span class="s"> outcome=</span><span class="si">%r</span><span class="s">>"</span> <span class="o">%</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodeid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">when</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">outcome</span><span class="p">)</span>
</div>
<span class="k">class</span> <span class="nc">TeardownErrorReport</span><span class="p">(</span><span class="n">BaseReport</span><span class="p">):</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"failed"</span>
<span class="n">when</span> <span class="o">=</span> <span class="s">"teardown"</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">longrepr</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">longrepr</span> <span class="o">=</span> <span class="n">longrepr</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sections</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">extra</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_make_collect_report</span><span class="p">(</span><span class="n">collector</span><span class="p">):</span>
<span class="n">call</span> <span class="o">=</span> <span class="n">CallInfo</span><span class="p">(</span><span class="n">collector</span><span class="o">.</span><span class="n">_memocollect</span><span class="p">,</span> <span class="s">"memocollect"</span><span class="p">)</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="p">:</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"passed"</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">_pytest</span> <span class="kn">import</span> <span class="n">nose</span>
<span class="n">skip_exceptions</span> <span class="o">=</span> <span class="p">(</span><span class="n">Skipped</span><span class="p">,)</span> <span class="o">+</span> <span class="n">nose</span><span class="o">.</span><span class="n">get_skip_exceptions</span><span class="p">()</span>
<span class="k">if</span> <span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="o">.</span><span class="n">errisinstance</span><span class="p">(</span><span class="n">skip_exceptions</span><span class="p">):</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"skipped"</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">collector</span><span class="o">.</span><span class="n">_repr_failure_py</span><span class="p">(</span><span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="p">,</span> <span class="s">"line"</span><span class="p">)</span><span class="o">.</span><span class="n">reprcrash</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">path</span><span class="p">),</span> <span class="n">r</span><span class="o">.</span><span class="n">lineno</span><span class="p">,</span> <span class="n">r</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">outcome</span> <span class="o">=</span> <span class="s">"failed"</span>
<span class="n">errorinfo</span> <span class="o">=</span> <span class="n">collector</span><span class="o">.</span><span class="n">repr_failure</span><span class="p">(</span><span class="n">call</span><span class="o">.</span><span class="n">excinfo</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">errorinfo</span><span class="p">,</span> <span class="s">"toterminal"</span><span class="p">):</span>
<span class="n">errorinfo</span> <span class="o">=</span> <span class="n">CollectErrorRepr</span><span class="p">(</span><span class="n">errorinfo</span><span class="p">)</span>
<span class="n">longrepr</span> <span class="o">=</span> <span class="n">errorinfo</span>
<span class="n">rep</span> <span class="o">=</span> <span class="n">CollectReport</span><span class="p">(</span><span class="n">collector</span><span class="o">.</span><span class="n">nodeid</span><span class="p">,</span> <span class="n">outcome</span><span class="p">,</span> <span class="n">longrepr</span><span class="p">,</span>
<span class="nb">getattr</span><span class="p">(</span><span class="n">call</span><span class="p">,</span> <span class="s">'result'</span><span class="p">,</span> <span class="bp">None</span><span class="p">))</span>
<span class="n">rep</span><span class="o">.</span><span class="n">call</span> <span class="o">=</span> <span class="n">call</span> <span class="c"># see collect_one_node</span>
<span class="k">return</span> <span class="n">rep</span>
<span class="k">class</span> <span class="nc">CollectReport</span><span class="p">(</span><span class="n">BaseReport</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodeid</span><span class="p">,</span> <span class="n">outcome</span><span class="p">,</span> <span class="n">longrepr</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span>
<span class="n">sections</span><span class="o">=</span><span class="p">(),</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodeid</span> <span class="o">=</span> <span class="n">nodeid</span>
<span class="bp">self</span><span class="o">.</span><span class="n">outcome</span> <span class="o">=</span> <span class="n">outcome</span>
<span class="bp">self</span><span class="o">.</span><span class="n">longrepr</span> <span class="o">=</span> <span class="n">longrepr</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result</span> <span class="o">=</span> <span class="n">result</span> <span class="ow">or</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sections</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">sections</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">extra</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fspath</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fspath</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"<CollectReport </span><span class="si">%r</span><span class="s"> lenresult=</span><span class="si">%s</span><span class="s"> outcome=</span><span class="si">%r</span><span class="s">>"</span> <span class="o">%</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodeid</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">outcome</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">CollectErrorRepr</span><span class="p">(</span><span class="n">TerminalRepr</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">longrepr</span> <span class="o">=</span> <span class="n">msg</span>
<span class="k">def</span> <span class="nf">toterminal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out</span><span class="p">):</span>
<span class="n">out</span><span class="o">.</span><span class="n">line</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">longrepr</span><span class="p">,</span> <span class="n">red</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">SetupState</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">""" shared state for setting up/tearing down test items or collectors. """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stack</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_finalizers</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">addfinalizer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">finalizer</span><span class="p">,</span> <span class="n">colitem</span><span class="p">):</span>
<span class="sd">""" attach a finalizer to the given colitem.</span>
<span class="sd"> if colitem is None, this will add a finalizer that</span>
<span class="sd"> is called at the end of teardown_all().</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="n">colitem</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">colitem</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">py</span><span class="o">.</span><span class="n">builtin</span><span class="o">.</span><span class="n">callable</span><span class="p">(</span><span class="n">finalizer</span><span class="p">)</span>
<span class="c">#assert colitem in self.stack # some unit tests don't setup stack :/</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_finalizers</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">colitem</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">finalizer</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_pop_and_teardown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">colitem</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_teardown_with_finalization</span><span class="p">(</span><span class="n">colitem</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_callfinalizers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">colitem</span><span class="p">):</span>
<span class="n">finalizers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_finalizers</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">colitem</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">exc</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">while</span> <span class="n">finalizers</span><span class="p">:</span>
<span class="n">fin</span> <span class="o">=</span> <span class="n">finalizers</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">fin</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="c"># XXX Only first exception will be seen by user,</span>
<span class="c"># ideally all should be reported.</span>
<span class="k">if</span> <span class="n">exc</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
<span class="k">if</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">py</span><span class="o">.</span><span class="n">builtin</span><span class="o">.</span><span class="n">_reraise</span><span class="p">(</span><span class="o">*</span><span class="n">exc</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_teardown_with_finalization</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">colitem</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_callfinalizers</span><span class="p">(</span><span class="n">colitem</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">colitem</span><span class="p">,</span> <span class="s">"teardown"</span><span class="p">):</span>
<span class="n">colitem</span><span class="o">.</span><span class="n">teardown</span><span class="p">()</span>
<span class="k">for</span> <span class="n">colitem</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_finalizers</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">colitem</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="n">colitem</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">stack</span> \
<span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">colitem</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">teardown_all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_pop_and_teardown</span><span class="p">()</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_finalizers</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_teardown_with_finalization</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_finalizers</span>
<span class="k">def</span> <span class="nf">teardown_exact</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="n">nextitem</span><span class="p">):</span>
<span class="n">needed_collectors</span> <span class="o">=</span> <span class="n">nextitem</span> <span class="ow">and</span> <span class="n">nextitem</span><span class="o">.</span><span class="n">listchain</span><span class="p">()</span> <span class="ow">or</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_teardown_towards</span><span class="p">(</span><span class="n">needed_collectors</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_teardown_towards</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">needed_collectors</span><span class="p">):</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stack</span> <span class="o">==</span> <span class="n">needed_collectors</span><span class="p">[:</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="p">)]:</span>
<span class="k">break</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_pop_and_teardown</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">colitem</span><span class="p">):</span>
<span class="sd">""" setup objects along the collector chain to the test-method</span>
<span class="sd"> and teardown previously setup objects."""</span>
<span class="n">needed_collectors</span> <span class="o">=</span> <span class="n">colitem</span><span class="o">.</span><span class="n">listchain</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_teardown_towards</span><span class="p">(</span><span class="n">needed_collectors</span><span class="p">)</span>
<span class="c"># check if the last collection node has raised an error</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="s">'_prepare_exc'</span><span class="p">):</span>
<span class="n">py</span><span class="o">.</span><span class="n">builtin</span><span class="o">.</span><span class="n">_reraise</span><span class="p">(</span><span class="o">*</span><span class="n">col</span><span class="o">.</span><span class="n">_prepare_exc</span><span class="p">)</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">needed_collectors</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="p">):]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">col</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">col</span><span class="o">.</span><span class="n">setup</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="n">col</span><span class="o">.</span><span class="n">_prepare_exc</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
<span class="k">raise</span>
<span class="k">def</span> <span class="nf">collect_one_node</span><span class="p">(</span><span class="n">collector</span><span class="p">):</span>
<span class="n">ihook</span> <span class="o">=</span> <span class="n">collector</span><span class="o">.</span><span class="n">ihook</span>
<span class="n">ihook</span><span class="o">.</span><span class="n">pytest_collectstart</span><span class="p">(</span><span class="n">collector</span><span class="o">=</span><span class="n">collector</span><span class="p">)</span>
<span class="n">rep</span> <span class="o">=</span> <span class="n">ihook</span><span class="o">.</span><span class="n">pytest_make_collect_report</span><span class="p">(</span><span class="n">collector</span><span class="o">=</span><span class="n">collector</span><span class="p">)</span>
<span class="n">call</span> <span class="o">=</span> <span class="n">rep</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">"call"</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">call</span> <span class="ow">and</span> <span class="n">check_interactive_exception</span><span class="p">(</span><span class="n">call</span><span class="p">,</span> <span class="n">rep</span><span class="p">):</span>
<span class="n">ihook</span><span class="o">.</span><span class="n">pytest_exception_interact</span><span class="p">(</span><span class="n">node</span><span class="o">=</span><span class="n">collector</span><span class="p">,</span> <span class="n">call</span><span class="o">=</span><span class="n">call</span><span class="p">,</span> <span class="n">report</span><span class="o">=</span><span class="n">rep</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rep</span>
<span class="c"># =============================================================</span>
<span class="c"># Test OutcomeExceptions and helpers for creating them.</span>
<span class="k">class</span> <span class="nc">OutcomeException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">""" OutcomeException and its subclass instances indicate and</span>
<span class="sd"> contain info about test and collection outcomes.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">pytrace</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="ne">Exception</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pytrace</span> <span class="o">=</span> <span class="n">pytrace</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">)</span>
<span class="k">return</span> <span class="s">"<</span><span class="si">%s</span><span class="s"> instance>"</span> <span class="o">%</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,)</span>
<span class="n">__str__</span> <span class="o">=</span> <span class="n">__repr__</span>
<span class="k">class</span> <span class="nc">Skipped</span><span class="p">(</span><span class="n">OutcomeException</span><span class="p">):</span>
<span class="c"># XXX hackish: on 3k we fake to live in the builtins</span>
<span class="c"># in order to have Skipped exception printing shorter/nicer</span>
<span class="n">__module__</span> <span class="o">=</span> <span class="s">'builtins'</span>
<span class="k">class</span> <span class="nc">Failed</span><span class="p">(</span><span class="n">OutcomeException</span><span class="p">):</span>
<span class="sd">""" raised from an explicit call to pytest.fail() """</span>
<span class="n">__module__</span> <span class="o">=</span> <span class="s">'builtins'</span>
<span class="k">class</span> <span class="nc">Exit</span><span class="p">(</span><span class="ne">KeyboardInterrupt</span><span class="p">):</span>
<span class="sd">""" raised for immediate program exits (no tracebacks/summaries)"""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="o">=</span><span class="s">"unknown reason"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span>
<span class="ne">KeyboardInterrupt</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
<span class="c"># exposed helper methods</span>
<div class="viewcode-block" id="exit"><a class="viewcode-back" href="../../builtin.html#_pytest.runner.exit">[docs]</a><span class="k">def</span> <span class="nf">exit</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="sd">""" exit testing process as if KeyboardInterrupt was triggered. """</span>
<span class="n">__tracebackhide__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">raise</span> <span class="n">Exit</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
</div>
<span class="nb">exit</span><span class="o">.</span><span class="n">Exception</span> <span class="o">=</span> <span class="n">Exit</span>
<div class="viewcode-block" id="skip"><a class="viewcode-back" href="../../builtin.html#_pytest.runner.skip">[docs]</a><span class="k">def</span> <span class="nf">skip</span><span class="p">(</span><span class="n">msg</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
<span class="sd">""" skip an executing test with the given message. Note: it's usually</span>
<span class="sd"> better to use the pytest.mark.skipif marker to declare a test to be</span>
<span class="sd"> skipped under certain conditions like mismatching platforms or</span>
<span class="sd"> dependencies. See the pytest_skipping plugin for details.</span>
<span class="sd"> """</span>
<span class="n">__tracebackhide__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">raise</span> <span class="n">Skipped</span><span class="p">(</span><span class="n">msg</span><span class="o">=</span><span class="n">msg</span><span class="p">)</span></div>
<span class="n">skip</span><span class="o">.</span><span class="n">Exception</span> <span class="o">=</span> <span class="n">Skipped</span>
<div class="viewcode-block" id="fail"><a class="viewcode-back" href="../../builtin.html#_pytest.runner.fail">[docs]</a><span class="k">def</span> <span class="nf">fail</span><span class="p">(</span><span class="n">msg</span><span class="o">=</span><span class="s">""</span><span class="p">,</span> <span class="n">pytrace</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">""" explicitely fail an currently-executing test with the given Message.</span>
<span class="sd"> :arg pytrace: if false the msg represents the full failure information</span>
<span class="sd"> and no python traceback will be reported.</span>
<span class="sd"> """</span>
<span class="n">__tracebackhide__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">raise</span> <span class="n">Failed</span><span class="p">(</span><span class="n">msg</span><span class="o">=</span><span class="n">msg</span><span class="p">,</span> <span class="n">pytrace</span><span class="o">=</span><span class="n">pytrace</span><span class="p">)</span></div>
<span class="n">fail</span><span class="o">.</span><span class="n">Exception</span> <span class="o">=</span> <span class="n">Failed</span>
<div class="viewcode-block" id="importorskip"><a class="viewcode-back" href="../../builtin.html#_pytest.runner.importorskip">[docs]</a><span class="k">def</span> <span class="nf">importorskip</span><span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="n">minversion</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">""" return imported module if it has at least "minversion" as its</span>
<span class="sd"> __version__ attribute. If no minversion is specified the a skip</span>
<span class="sd"> is only triggered if the module can not be imported.</span>
<span class="sd"> Note that version comparison only works with simple version strings</span>
<span class="sd"> like "1.2.3" but not "1.2.3.dev1" or others.</span>
<span class="sd"> """</span>
<span class="n">__tracebackhide__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="nb">compile</span><span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="s">'eval'</span><span class="p">)</span> <span class="c"># to catch syntaxerrors</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">__import__</span><span class="p">(</span><span class="n">modname</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">skip</span><span class="p">(</span><span class="s">"could not import </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span><span class="p">(</span><span class="n">modname</span><span class="p">,))</span>
<span class="n">mod</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">modname</span><span class="p">]</span>
<span class="k">if</span> <span class="n">minversion</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">mod</span>
<span class="n">verattr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="s">'__version__'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">intver</span><span class="p">(</span><span class="n">verstring</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">verstring</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"."</span><span class="p">)]</span>
<span class="k">if</span> <span class="n">verattr</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="n">intver</span><span class="p">(</span><span class="n">verattr</span><span class="p">)</span> <span class="o"><</span> <span class="n">intver</span><span class="p">(</span><span class="n">minversion</span><span class="p">):</span>
<span class="n">skip</span><span class="p">(</span><span class="s">"module </span><span class="si">%r</span><span class="s"> has __version__ </span><span class="si">%r</span><span class="s">, required is: </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span><span class="p">(</span>
<span class="n">modname</span><span class="p">,</span> <span class="n">verattr</span><span class="p">,</span> <span class="n">minversion</span><span class="p">))</span>
<span class="k">return</span> <span class="n">mod</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../contents.html">
<img class="logo" src="../../_static/pytest1.png" alt="Logo"/>
</a></p><h3><a href="../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../contents.html">Contents</a></li>
<li><a href="../../getting-started.html">Install</a></li>
<li><a href="../../example/index.html">Examples</a></li>
<li><a href="../../customize.html">Customize</a></li>
<li><a href="../../contact.html">Contact</a></li>
<li><a href="../../talks.html">Talks/Posts</a></li>
<li><a href="../../changelog.html">Changelog</a></li>
</ul><h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul><h3>Useful Links</h3>
<ul>
<li><a href="../../index.html">The pytest Website</a></li>
<li><a href="../../contributing.html">Contribution Guide</a></li>
<li><a href="https://pypi.python.org/pypi/pytest">pytest @ PyPI</a></li>
<li><a href="https://bitbucket.org/hpk42/pytest/">pytest @ Bitbucket</a></li>
<li><a href="http://pytest.org/latest/plugins_index/index.html">3rd party plugins</a></li>
<li><a href="https://bitbucket.org/hpk42/pytest/issues?status=new&status=open">Issue Tracker</a></li>
<li><a href="http://pytest.org/latest/pytest.pdf">PDF Documentation</a>
</ul>
<div id="searchbox" style="display: none">
<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 2014, holger krekel.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|