This file is indexed.

/usr/share/doc/python-pytest-doc/html/monkeypatch.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
<!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>Monkeypatching/mocking modules and environments</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="pytest reference documentation" href="apiref.html" />
    <link rel="next" title="xdist: pytest distributed testing plugin" href="xdist.html" />
    <link rel="prev" title="Capturing of the stdout/stderr output" href="capture.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 class="right" style="margin-right: 10px">
          <a href="xdist.html" title="xdist: pytest distributed testing plugin"
             accesskey="N">next</a></li>
        <li class="right" >
          <a href="capture.html" title="Capturing of the stdout/stderr output"
             accesskey="P">previous</a> |</li>
        <li><a href="contents.html">pytest-2.6.2</a> &raquo;</li>
          <li><a href="apiref.html" accesskey="U">pytest reference documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="monkeypatching-mocking-modules-and-environments">
<h1>Monkeypatching/mocking modules and environments<a class="headerlink" href="#monkeypatching-mocking-modules-and-environments" title="Permalink to this headline"></a></h1>
<p>Sometimes tests need to invoke functionality which depends
on global settings or which invokes code which cannot be easily
tested such as network access.  The <tt class="docutils literal"><span class="pre">monkeypatch</span></tt> function argument
helps you to safely set/delete an attribute, dictionary item or
environment variable or to modify <tt class="docutils literal"><span class="pre">sys.path</span></tt> for importing.
See the <a class="reference external" href="http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/">monkeypatch blog post</a> for some introduction material
and a discussion of its motivation.</p>
<div class="section" id="simple-example-monkeypatching-functions">
<h2>Simple example: monkeypatching functions<a class="headerlink" href="#simple-example-monkeypatching-functions" title="Permalink to this headline"></a></h2>
<p>If you want to pretend that <tt class="docutils literal"><span class="pre">os.expanduser</span></tt> returns a certain
directory, you can use the <a class="reference internal" href="#_pytest.monkeypatch.monkeypatch.setattr" title="_pytest.monkeypatch.monkeypatch.setattr"><tt class="xref py py-meth docutils literal"><span class="pre">monkeypatch.setattr()</span></tt></a> method to
patch this function before calling into a function which uses it:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># content of test_module.py</span>
<span class="kn">import</span> <span class="nn">os.path</span>
<span class="k">def</span> <span class="nf">getssh</span><span class="p">():</span> <span class="c"># pseudo application code</span>
    <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s">&quot;~admin&quot;</span><span class="p">),</span> <span class="s">&#39;.ssh&#39;</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">test_mytest</span><span class="p">(</span><span class="n">monkeypatch</span><span class="p">):</span>
    <span class="k">def</span> <span class="nf">mockreturn</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
        <span class="k">return</span> <span class="s">&#39;/abc&#39;</span>
    <span class="n">monkeypatch</span><span class="o">.</span><span class="n">setattr</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s">&#39;expanduser&#39;</span><span class="p">,</span> <span class="n">mockreturn</span><span class="p">)</span>
    <span class="n">x</span> <span class="o">=</span> <span class="n">getssh</span><span class="p">()</span>
    <span class="k">assert</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&#39;/abc/.ssh&#39;</span>
</pre></div>
</div>
<p>Here our test function monkeypatches <tt class="docutils literal"><span class="pre">os.path.expanduser</span></tt> and
then calls into an function that calls it.  After the test function
finishes the <tt class="docutils literal"><span class="pre">os.path.expanduser</span></tt> modification will be undone.</p>
</div>
<div class="section" id="example-preventing-requests-from-remote-operations">
<h2>example: preventing &#8220;requests&#8221; from remote operations<a class="headerlink" href="#example-preventing-requests-from-remote-operations" title="Permalink to this headline"></a></h2>
<p>If you want to prevent the &#8220;requests&#8221; library from performing http
requests in all your tests, you can do:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># content 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">autouse</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">no_requests</span><span class="p">(</span><span class="n">monkeypatch</span><span class="p">):</span>
    <span class="n">monkeypatch</span><span class="o">.</span><span class="n">delattr</span><span class="p">(</span><span class="s">&quot;requests.sessions.Session.request&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>This autouse fixture will be executed for each test function and it
will delete the method <tt class="docutils literal"><span class="pre">request.session.Session.request</span></tt>
so that any attempts within tests to create http requests will fail.</p>
</div>
<div class="section" id="example-setting-an-attribute-on-some-class">
<h2>example: setting an attribute on some class<a class="headerlink" href="#example-setting-an-attribute-on-some-class" title="Permalink to this headline"></a></h2>
<p>If you need to patch out <tt class="docutils literal"><span class="pre">os.getcwd()</span></tt> to return an artifical
value:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">test_some_interaction</span><span class="p">(</span><span class="n">monkeypatch</span><span class="p">):</span>
    <span class="n">monkeypatch</span><span class="o">.</span><span class="n">setattr</span><span class="p">(</span><span class="s">&quot;os.getcwd&quot;</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="s">&quot;/&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>which is equivalent to the long form:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">test_some_interaction</span><span class="p">(</span><span class="n">monkeypatch</span><span class="p">):</span>
    <span class="kn">import</span> <span class="nn">os</span>
    <span class="n">monkeypatch</span><span class="o">.</span><span class="n">setattr</span><span class="p">(</span><span class="n">os</span><span class="p">,</span> <span class="s">&quot;getcwd&quot;</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="s">&quot;/&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="method-reference-of-the-monkeypatch-function-argument">
<h2>Method reference of the monkeypatch function argument<a class="headerlink" href="#method-reference-of-the-monkeypatch-function-argument" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_pytest.monkeypatch.monkeypatch">
<em class="property">class </em><tt class="descname">monkeypatch</tt><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch" title="Permalink to this definition"></a></dt>
<dd><p>object keeping a record of setattr/item/env/syspath changes.</p>
<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.setattr">
<tt class="descname">setattr</tt><big>(</big><em>target</em>, <em>name</em>, <em>value=&lt;notset&gt;</em>, <em>raising=True</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.setattr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.setattr" title="Permalink to this definition"></a></dt>
<dd><p>set attribute value on target, memorizing the old value.
By default raise AttributeError if the attribute did not exist.</p>
<p>For convenience you can specify a string as <tt class="docutils literal"><span class="pre">target</span></tt> which
will be interpreted as a dotted import path, with the last part
being the attribute name.  Example:
<tt class="docutils literal"><span class="pre">monkeypatch.setattr(&quot;os.getcwd&quot;,</span> <span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">&quot;/&quot;)</span></tt>
would set the <tt class="docutils literal"><span class="pre">getcwd</span></tt> function of the <tt class="docutils literal"><span class="pre">os</span></tt> module.</p>
<p>The <tt class="docutils literal"><span class="pre">raising</span></tt> value determines if the setattr should fail
if the attribute is not already present (defaults to True
which means it will raise).</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.delattr">
<tt class="descname">delattr</tt><big>(</big><em>target</em>, <em>name=&lt;notset&gt;</em>, <em>raising=True</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.delattr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.delattr" title="Permalink to this definition"></a></dt>
<dd><p>delete attribute <tt class="docutils literal"><span class="pre">name</span></tt> from <tt class="docutils literal"><span class="pre">target</span></tt>, by default raise
AttributeError it the attribute did not previously exist.</p>
<p>If no <tt class="docutils literal"><span class="pre">name</span></tt> is specified and <tt class="docutils literal"><span class="pre">target</span></tt> is a string
it will be interpreted as a dotted import path with the
last part being the attribute name.</p>
<p>If raising is set to false, the attribute is allowed to not
pre-exist.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.setitem">
<tt class="descname">setitem</tt><big>(</big><em>dic</em>, <em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.setitem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.setitem" title="Permalink to this definition"></a></dt>
<dd><p>set dictionary entry <tt class="docutils literal"><span class="pre">name</span></tt> to value.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.delitem">
<tt class="descname">delitem</tt><big>(</big><em>dic</em>, <em>name</em>, <em>raising=True</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.delitem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.delitem" title="Permalink to this definition"></a></dt>
<dd><p>delete <tt class="docutils literal"><span class="pre">name</span></tt> from dict, raise KeyError if it doesn&#8217;t exist.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.setenv">
<tt class="descname">setenv</tt><big>(</big><em>name</em>, <em>value</em>, <em>prepend=None</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.setenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.setenv" title="Permalink to this definition"></a></dt>
<dd><p>set environment variable <tt class="docutils literal"><span class="pre">name</span></tt> to <tt class="docutils literal"><span class="pre">value</span></tt>.  if <tt class="docutils literal"><span class="pre">prepend</span></tt>
is a character, read the current environment variable value
and prepend the <tt class="docutils literal"><span class="pre">value</span></tt> adjoined with the <tt class="docutils literal"><span class="pre">prepend</span></tt> character.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.delenv">
<tt class="descname">delenv</tt><big>(</big><em>name</em>, <em>raising=True</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.delenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.delenv" title="Permalink to this definition"></a></dt>
<dd><p>delete <tt class="docutils literal"><span class="pre">name</span></tt> from environment, raise KeyError it not exists.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.syspath_prepend">
<tt class="descname">syspath_prepend</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.syspath_prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.syspath_prepend" title="Permalink to this definition"></a></dt>
<dd><p>prepend <tt class="docutils literal"><span class="pre">path</span></tt> to <tt class="docutils literal"><span class="pre">sys.path</span></tt> list of import locations.</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.chdir">
<tt class="descname">chdir</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.chdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.chdir" title="Permalink to this definition"></a></dt>
<dd><p>change the current working directory to the specified path
path can be a string or a py.path.local object</p>
</dd></dl>

<dl class="method">
<dt id="_pytest.monkeypatch.monkeypatch.undo">
<tt class="descname">undo</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/_pytest/monkeypatch.html#monkeypatch.undo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.monkeypatch.monkeypatch.undo" title="Permalink to this definition"></a></dt>
<dd><p>undo previous changes.  This call consumes the
undo stack.  Calling it a second time has no effect unless
you  do more monkeypatching after the undo call.</p>
</dd></dl>

</dd></dl>

<p><tt class="docutils literal"><span class="pre">monkeypatch.setattr/delattr/delitem/delenv()</span></tt> all
by default raise an Exception if the target does not exist.
Pass <tt class="docutils literal"><span class="pre">raising=False</span></tt> if you want to skip this check.</p>
</div>
</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>
  <hr>
  <ul>
<li><a class="reference internal" href="#">Monkeypatching/mocking modules and environments</a><ul>
<li><a class="reference internal" href="#simple-example-monkeypatching-functions">Simple example: monkeypatching functions</a></li>
<li><a class="reference internal" href="#example-preventing-requests-from-remote-operations">example: preventing &#8220;requests&#8221; from remote operations</a></li>
<li><a class="reference internal" href="#example-setting-an-attribute-on-some-class">example: setting an attribute on some class</a></li>
<li><a class="reference internal" href="#method-reference-of-the-monkeypatch-function-argument">Method reference of the monkeypatch function argument</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
  <li><a href="contents.html">Documentation overview</a><ul>
  <li><a href="apiref.html">pytest reference documentation</a><ul>
      <li>Previous: <a href="capture.html" title="previous chapter">Capturing of the stdout/stderr output</a></li>
      <li>Next: <a href="xdist.html" title="next chapter">xdist: pytest distributed testing plugin</a></li>
  </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">
    &copy; Copyright 2014, holger krekel.
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  </div>
  

  </body>
</html>