<!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>Doctest integration for modules and test files</title> <link rel="stylesheet" href="_static/sphinxdoc.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.3.4.1', 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="top" title="None" href="index.html" /> <link rel="up" title="py.test reference documentation" href="apiref.html" /> <link rel="next" title="Working with plugins and conftest files" href="plugins.html" /> <link rel="prev" title="Running tests written for nose" href="nose.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="plugins.html" title="Working with plugins and conftest files" accesskey="N">next</a></li> <li class="right" > <a href="nose.html" title="Running tests written for nose" accesskey="P">previous</a> |</li> <li><a href="contents.html">pytest-2.3.4.1</a> »</li> <li><a href="apiref.html" accesskey="U">py.test reference documentation</a> »</li> <g:plusone></g:plusone> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <div id="searchbox" style="display: none"> <form class="search" action="search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Search" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('#searchbox').show(0);</script> <h3>quicklinks</h3> <div style="text-align: left; font-size: 100%; vertical-align: middle;"> <table> <tr> <td> <a href="index.html">home</a> </td><td> <a href="contents.html">TOC/contents</a> </td></tr><tr><td> <a href="getting-started.html">install</a> </td><td> <a href="changelog.html">changelog</a> </td></tr><tr><td> <a href="example/index.html">examples</a> </td><td> <a href="customize.html">customize</a> </td></tr><tr><td> <a href="https://bitbucket.org/hpk42/pytest/issues?status=new&status=open">issues[bb]</a> </td><td> <a href="contact.html">contact</a> </td></tr></table> </div> <h4>Previous topic</h4> <p class="topless"><a href="nose.html" title="previous chapter">Running tests written for nose</a></p> <h4>Next topic</h4> <p class="topless"><a href="plugins.html" title="next chapter">Working with plugins and conftest files</a></p> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="doctest-integration-for-modules-and-test-files"> <h1>Doctest integration for modules and test files<a class="headerlink" href="#doctest-integration-for-modules-and-test-files" title="Permalink to this headline">ΒΆ</a></h1> <p>By default all files matching the <tt class="docutils literal"><span class="pre">test*.txt</span></tt> pattern will be run through the python standard <tt class="docutils literal"><span class="pre">doctest</span></tt> module. You can change the pattern by issuing:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">doctest</span><span class="o">-</span><span class="n">glob</span><span class="o">=</span><span class="s">'*.rst'</span> </pre></div> </div> <p>on the command line. You can also trigger running of doctests from docstrings in all python modules (including regular python test modules):</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">doctest</span><span class="o">-</span><span class="n">modules</span> </pre></div> </div> <p>You can make these changes permanent in your project by putting them into a pytest.ini file like this:</p> <div class="highlight-python"><div class="highlight"><pre><span class="c"># content of pytest.ini</span> <span class="p">[</span><span class="n">pytest</span><span class="p">]</span> <span class="n">addopts</span> <span class="o">=</span> <span class="o">--</span><span class="n">doctest</span><span class="o">-</span><span class="n">modules</span> </pre></div> </div> <p>If you then have a text file like this:</p> <div class="highlight-python"><pre># content of example.rst hello this is a doctest >>> x = 3 >>> x 3</pre> </div> <p>and another like this:</p> <div class="highlight-python"><div class="highlight"><pre><span class="c"># content of mymodule.py</span> <span class="k">def</span> <span class="nf">something</span><span class="p">():</span> <span class="sd">""" a doctest in a docstring</span> <span class="sd"> >>> something()</span> <span class="sd"> 42</span> <span class="sd"> """</span> <span class="k">return</span> <span class="mi">42</span> </pre></div> </div> <p>then you can just invoke <tt class="docutils literal"><span class="pre">py.test</span></tt> without command line options:</p> <div class="highlight-python"><pre>$ py.test =========================== test session starts ============================ platform linux2 -- Python 2.7.3 -- pytest-2.3.5 collected 1 items mymodule.py . ========================= 1 passed in 0.02 seconds =========================</pre> </div> <p>It is possible to use fixtures using the <tt class="docutils literal"><span class="pre">getfixture</span></tt> helper:</p> <div class="highlight-python"><pre># content of example.rst >>> tmp = getfixture('tmpdir') >>> ...</pre> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="plugins.html" title="Working with plugins and conftest files" >next</a></li> <li class="right" > <a href="nose.html" title="Running tests written for nose" >previous</a> |</li> <li><a href="contents.html">pytest-2.3.4.1</a> »</li> <li><a href="apiref.html" >py.test reference documentation</a> »</li> <g:plusone></g:plusone> </ul> </div> <div class="footer"> © Copyright 2012, holger krekel. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-7597274-13']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script> </body> </html>