This file is indexed.

/usr/share/doc/python-pytest/html/tmpdir.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
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
<!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>Temporary directories and files &#8212; 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="Capturing of the stdout/stderr output" href="capture.html" />
    <link rel="prev" title="Monkeypatching/mocking modules and environments" href="monkeypatch.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="capture.html" title="Capturing of the stdout/stderr output"
             accesskey="N">next</a></li>
        <li class="right" >
          <a href="monkeypatch.html" title="Monkeypatching/mocking modules and environments"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="contents.html">pytest-3.3</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="temporary-directories-and-files">
<span id="tmpdir"></span><span id="tmpdir-handling"></span><h1>Temporary directories and files<a class="headerlink" href="#temporary-directories-and-files" title="Permalink to this headline"></a></h1>
<div class="section" id="the-tmpdir-fixture">
<h2>The 'tmpdir' fixture<a class="headerlink" href="#the-tmpdir-fixture" title="Permalink to this headline"></a></h2>
<p>You can use the <code class="docutils literal"><span class="pre">tmpdir</span></code> fixture which will
provide a temporary directory unique to the test invocation,
created in the <a class="reference internal" href="#base-temporary-directory">base temporary directory</a>.</p>
<p><code class="docutils literal"><span class="pre">tmpdir</span></code> is a <a class="reference external" href="http://py.rtfd.org/en/latest/path.html">py.path.local</a> object which offers <code class="docutils literal"><span class="pre">os.path</span></code> methods
and more.  Here is an example test usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># content of test_tmpdir.py</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="k">def</span> <span class="nf">test_create_file</span><span class="p">(</span><span class="n">tmpdir</span><span class="p">):</span>
    <span class="n">p</span> <span class="o">=</span> <span class="n">tmpdir</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="s2">&quot;sub&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">&quot;hello.txt&quot;</span><span class="p">)</span>
    <span class="n">p</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;content&quot;</span><span class="p">)</span>
    <span class="k">assert</span> <span class="n">p</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;content&quot;</span>
    <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">tmpdir</span><span class="o">.</span><span class="n">listdir</span><span class="p">())</span> <span class="o">==</span> <span class="mi">1</span>
    <span class="k">assert</span> <span class="mi">0</span>
</pre></div>
</div>
<p>Running this would result in a passed test except for the last
<code class="docutils literal"><span class="pre">assert</span> <span class="pre">0</span></code> line which we use to look at values:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pytest test_tmpdir.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
rootdir: $REGENDOC_TMPDIR, inifile:
collected 1 item

test_tmpdir.py F                                                     [100%]

================================= FAILURES =================================
_____________________________ test_create_file _____________________________

tmpdir = local(&#39;PYTEST_TMPDIR/test_create_file0&#39;)

    def test_create_file(tmpdir):
        p = tmpdir.mkdir(&quot;sub&quot;).join(&quot;hello.txt&quot;)
        p.write(&quot;content&quot;)
        assert p.read() == &quot;content&quot;
        assert len(tmpdir.listdir()) == 1
&gt;       assert 0
E       assert 0

test_tmpdir.py:7: AssertionError
========================= 1 failed in 0.12 seconds =========================
</pre></div>
</div>
</div>
<div class="section" id="the-tmpdir-factory-fixture">
<h2>The 'tmpdir_factory' fixture<a class="headerlink" href="#the-tmpdir-factory-fixture" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 2.8.</span></p>
</div>
<p>The <code class="docutils literal"><span class="pre">tmpdir_factory</span></code> is a session-scoped fixture which can be used
to create arbitrary temporary directories from any other fixture or test.</p>
<p>For example, suppose your test suite needs a large image on disk, which is
generated procedurally. Instead of computing the same image for each test
that uses it into its own <code class="docutils literal"><span class="pre">tmpdir</span></code>, you can generate it once per-session
to save time:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="c1"># contents of conftest.py</span>
<span class="kn">import</span> <span class="nn">pytest</span>

<span class="nd">@pytest.fixture</span><span class="p">(</span><span class="n">scope</span><span class="o">=</span><span class="s1">&#39;session&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">image_file</span><span class="p">(</span><span class="n">tmpdir_factory</span><span class="p">):</span>
    <span class="n">img</span> <span class="o">=</span> <span class="n">compute_expensive_image</span><span class="p">()</span>
    <span class="n">fn</span> <span class="o">=</span> <span class="n">tmpdir_factory</span><span class="o">.</span><span class="n">mktemp</span><span class="p">(</span><span class="s1">&#39;data&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;img.png&#39;</span><span class="p">)</span>
    <span class="n">img</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">fn</span><span class="p">))</span>
    <span class="k">return</span> <span class="n">fn</span>

<span class="c1"># contents of test_image.py</span>
<span class="k">def</span> <span class="nf">test_histogram</span><span class="p">(</span><span class="n">image_file</span><span class="p">):</span>
    <span class="n">img</span> <span class="o">=</span> <span class="n">load_image</span><span class="p">(</span><span class="n">image_file</span><span class="p">)</span>
    <span class="c1"># compute and test histogram</span>
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">tmpdir_factory</span></code> instances have the following methods:</p>
<dl class="method">
<dt id="_pytest.tmpdir.TempdirFactory.mktemp">
<code class="descclassname">TempdirFactory.</code><code class="descname">mktemp</code><span class="sig-paren">(</span><em>basename</em>, <em>numbered=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/tmpdir.html#TempdirFactory.mktemp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.tmpdir.TempdirFactory.mktemp" title="Permalink to this definition"></a></dt>
<dd><p>Create a subdirectory of the base temporary directory and return it.
If <code class="docutils literal"><span class="pre">numbered</span></code>, ensure the directory is unique by adding a number
prefix greater than any existing one.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.tmpdir.TempdirFactory.getbasetemp">
<code class="descclassname">TempdirFactory.</code><code class="descname">getbasetemp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/tmpdir.html#TempdirFactory.getbasetemp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.tmpdir.TempdirFactory.getbasetemp" title="Permalink to this definition"></a></dt>
<dd><p>return base temporary directory.</p>
</dd></dl>

</div>
<div class="section" id="the-default-base-temporary-directory">
<span id="base-temporary-directory"></span><h2>The default base temporary directory<a class="headerlink" href="#the-default-base-temporary-directory" title="Permalink to this headline"></a></h2>
<p>Temporary directories are by default created as sub-directories of
the system temporary directory.  The base name will be <code class="docutils literal"><span class="pre">pytest-NUM</span></code> where
<code class="docutils literal"><span class="pre">NUM</span></code> will be incremented with each test run.  Moreover, entries older
than 3 temporary directories will be removed.</p>
<p>You can override the default temporary directory setting like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pytest</span> <span class="o">--</span><span class="n">basetemp</span><span class="o">=</span><span class="n">mydir</span>
</pre></div>
</div>
<p>When distributing tests on the local machine, <code class="docutils literal"><span class="pre">pytest</span></code> takes care to
configure a basetemp directory for the sub processes such that all temporary
data lands below a single per-test run basetemp directory.</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="#">Temporary directories and files</a><ul>
<li><a class="reference internal" href="#the-tmpdir-fixture">The 'tmpdir' fixture</a></li>
<li><a class="reference internal" href="#the-tmpdir-factory-fixture">The 'tmpdir_factory' fixture</a></li>
<li><a class="reference internal" href="#the-default-base-temporary-directory">The default base temporary directory</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
  <li><a href="contents.html">Documentation overview</a><ul>
      <li>Previous: <a href="monkeypatch.html" title="previous chapter">Monkeypatching/mocking modules and environments</a></li>
      <li>Next: <a href="capture.html" title="next chapter">Capturing of the stdout/stderr output</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">
    &copy; Copyright 2018, holger krekel and pytest-dev team.
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  </div>
  

  </body>
</html>