/usr/share/doc/python-pytest/html/pythonpath.html is in python-pytest-doc 3.3.2-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 | <!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 import mechanisms and sys.path/PYTHONPATH — pytest documentation</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: '3.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="search" title="Search" href="search.html" />
<link rel="next" title="Configuration" href="customize.html" />
<link rel="prev" title="Good Integration Practices" href="goodpractices.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="customize.html" title="Configuration"
accesskey="N">next</a></li>
<li class="right" >
<a href="goodpractices.html" title="Good Integration Practices"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">pytest-3.3</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pytest-import-mechanisms-and-sys-path-pythonpath">
<span id="pythonpath"></span><h1>pytest import mechanisms and <code class="docutils literal"><span class="pre">sys.path</span></code>/<code class="docutils literal"><span class="pre">PYTHONPATH</span></code><a class="headerlink" href="#pytest-import-mechanisms-and-sys-path-pythonpath" title="Permalink to this headline">¶</a></h1>
<p>Here's a list of scenarios where pytest may need to change <code class="docutils literal"><span class="pre">sys.path</span></code> in order
to import test modules or <code class="docutils literal"><span class="pre">conftest.py</span></code> files.</p>
<div class="section" id="test-modules-conftest-py-files-inside-packages">
<h2>Test modules / <code class="docutils literal"><span class="pre">conftest.py</span></code> files inside packages<a class="headerlink" href="#test-modules-conftest-py-files-inside-packages" title="Permalink to this headline">¶</a></h2>
<p>Consider this file and directory layout:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">root</span><span class="o">/</span>
<span class="o">|-</span> <span class="n">foo</span><span class="o">/</span>
<span class="o">|-</span> <span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="o">|-</span> <span class="n">conftest</span><span class="o">.</span><span class="n">py</span>
<span class="o">|-</span> <span class="n">bar</span><span class="o">/</span>
<span class="o">|-</span> <span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="o">|-</span> <span class="n">tests</span><span class="o">/</span>
<span class="o">|-</span> <span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="o">|-</span> <span class="n">test_foo</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>When executing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pytest</span> <span class="n">root</span><span class="o">/</span>
</pre></div>
</div>
<p>pytest will find <code class="docutils literal"><span class="pre">foo/bar/tests/test_foo.py</span></code> and realize it is part of a package given that
there's an <code class="docutils literal"><span class="pre">__init__.py</span></code> file in the same folder. It will then search upwards until it can find the
last folder which still contains an <code class="docutils literal"><span class="pre">__init__.py</span></code> file in order to find the package <em>root</em> (in
this case <code class="docutils literal"><span class="pre">foo/</span></code>). To load the module, it will insert <code class="docutils literal"><span class="pre">root/</span></code> to the front of
<code class="docutils literal"><span class="pre">sys.path</span></code> (if not there already) in order to load
<code class="docutils literal"><span class="pre">test_foo.py</span></code> as the <em>module</em> <code class="docutils literal"><span class="pre">foo.bar.tests.test_foo</span></code>.</p>
<p>The same logic applies to the <code class="docutils literal"><span class="pre">conftest.py</span></code> file: it will be imported as <code class="docutils literal"><span class="pre">foo.conftest</span></code> module.</p>
<p>Preserving the full package name is important when tests live in a package to avoid problems
and allow test modules to have duplicated names. This is also discussed in details in
<a class="reference internal" href="goodpractices.html#test-discovery"><span class="std std-ref">Conventions for Python test discovery</span></a>.</p>
</div>
<div class="section" id="standalone-test-modules-conftest-py-files">
<h2>Standalone test modules / <code class="docutils literal"><span class="pre">conftest.py</span></code> files<a class="headerlink" href="#standalone-test-modules-conftest-py-files" title="Permalink to this headline">¶</a></h2>
<p>Consider this file and directory layout:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">root</span><span class="o">/</span>
<span class="o">|-</span> <span class="n">foo</span><span class="o">/</span>
<span class="o">|-</span> <span class="n">conftest</span><span class="o">.</span><span class="n">py</span>
<span class="o">|-</span> <span class="n">bar</span><span class="o">/</span>
<span class="o">|-</span> <span class="n">tests</span><span class="o">/</span>
<span class="o">|-</span> <span class="n">test_foo</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>When executing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pytest</span> <span class="n">root</span><span class="o">/</span>
</pre></div>
</div>
<p>pytest will find <code class="docutils literal"><span class="pre">foo/bar/tests/test_foo.py</span></code> and realize it is NOT part of a package given that
there's no <code class="docutils literal"><span class="pre">__init__.py</span></code> file in the same folder. It will then add <code class="docutils literal"><span class="pre">root/foo/bar/tests</span></code> to
<code class="docutils literal"><span class="pre">sys.path</span></code> in order to import <code class="docutils literal"><span class="pre">test_foo.py</span></code> as the <em>module</em> <code class="docutils literal"><span class="pre">test_foo</span></code>. The same is done
with the <code class="docutils literal"><span class="pre">conftest.py</span></code> file by adding <code class="docutils literal"><span class="pre">root/foo</span></code> to <code class="docutils literal"><span class="pre">sys.path</span></code> to import it as <code class="docutils literal"><span class="pre">conftest</span></code>.</p>
<p>For this reason this layout cannot have test modules with the same name, as they all will be
imported in the global import namespace.</p>
<p>This is also discussed in details in <a class="reference internal" href="goodpractices.html#test-discovery"><span class="std std-ref">Conventions for Python test discovery</span></a>.</p>
</div>
<div class="section" id="invoking-pytest-versus-python-m-pytest">
<h2>Invoking <code class="docutils literal"><span class="pre">pytest</span></code> versus <code class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span></code><a class="headerlink" href="#invoking-pytest-versus-python-m-pytest" title="Permalink to this headline">¶</a></h2>
<p>Running pytest with <code class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span> <span class="pre">[...]</span></code> instead of <code class="docutils literal"><span class="pre">pytest</span> <span class="pre">[...]</span></code> yields nearly
equivalent behaviour, except that the former call will add the current directory to <code class="docutils literal"><span class="pre">sys.path</span></code>.
See also <a class="reference internal" href="usage.html#cmdline"><span class="std std-ref">Calling pytest through python -m pytest</span></a>.</p>
</div>
</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>
<li><a href="backwards-compatibility.html">Backwards Compatibility</a></li>
<li><a href="license.html">License</a></li>
</ul>
<hr>
<ul>
<li><a class="reference internal" href="#">pytest import mechanisms and <code class="docutils literal"><span class="pre">sys.path</span></code>/<code class="docutils literal"><span class="pre">PYTHONPATH</span></code></a><ul>
<li><a class="reference internal" href="#test-modules-conftest-py-files-inside-packages">Test modules / <code class="docutils literal"><span class="pre">conftest.py</span></code> files inside packages</a></li>
<li><a class="reference internal" href="#standalone-test-modules-conftest-py-files">Standalone test modules / <code class="docutils literal"><span class="pre">conftest.py</span></code> files</a></li>
<li><a class="reference internal" href="#invoking-pytest-versus-python-m-pytest">Invoking <code class="docutils literal"><span class="pre">pytest</span></code> versus <code class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span></code></a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li>Previous: <a href="goodpractices.html" title="previous chapter">Good Integration Practices</a></li>
<li>Next: <a href="customize.html" title="next chapter">Configuration</a></li>
</ul></li>
</ul><h3>Useful Links</h3>
<ul>
<li><a href="index.html">The pytest Website</a></li>
<li><a href="contributing.html">Contribution Guide</a></li>
<li><a href="https://pypi.python.org/pypi/pytest">pytest @ PyPI</a></li>
<li><a href="https://github.com/pytest-dev/pytest/">pytest @ GitHub</a></li>
<li><a href="http://plugincompat.herokuapp.com/">3rd party plugins</a></li>
<li><a href="https://github.com/pytest-dev/pytest/issues">Issue Tracker</a></li>
<li><a href="https://media.readthedocs.org/pdf/pytest/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">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<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>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2018, holger krekel and pytest-dev team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|