/usr/share/doc/python-pytest-doc/html/_modules/_pytest/monkeypatch.html is in python-pytest-doc 2.8.7-4.
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 | <!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.monkeypatch</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.8.7',
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="../../contents.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 role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="../../contents.html">pytest-2.8.7</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for _pytest.monkeypatch</h1><div class="highlight"><pre>
<span class="sd">""" monkeypatching and mocking functionality. """</span>
<span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">py.builtin</span> <span class="kn">import</span> <span class="n">_basestring</span>
<span class="n">RE_IMPORT_ERROR_NAME</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">"^No module named (.*)$"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pytest_funcarg__monkeypatch</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
<span class="sd">"""The returned ``monkeypatch`` funcarg provides these</span>
<span class="sd"> helper methods to modify objects, dictionaries or os.environ::</span>
<span class="sd"> monkeypatch.setattr(obj, name, value, raising=True)</span>
<span class="sd"> monkeypatch.delattr(obj, name, raising=True)</span>
<span class="sd"> monkeypatch.setitem(mapping, name, value)</span>
<span class="sd"> monkeypatch.delitem(obj, name, raising=True)</span>
<span class="sd"> monkeypatch.setenv(name, value, prepend=False)</span>
<span class="sd"> monkeypatch.delenv(name, value, raising=True)</span>
<span class="sd"> monkeypatch.syspath_prepend(path)</span>
<span class="sd"> monkeypatch.chdir(path)</span>
<span class="sd"> All modifications will be undone after the requesting</span>
<span class="sd"> test function has finished. The ``raising``</span>
<span class="sd"> parameter determines if a KeyError or AttributeError</span>
<span class="sd"> will be raised if the set/deletion operation has no target.</span>
<span class="sd"> """</span>
<span class="n">mpatch</span> <span class="o">=</span> <span class="n">monkeypatch</span><span class="p">()</span>
<span class="n">request</span><span class="o">.</span><span class="n">addfinalizer</span><span class="p">(</span><span class="n">mpatch</span><span class="o">.</span><span class="n">undo</span><span class="p">)</span>
<span class="k">return</span> <span class="n">mpatch</span>
<span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="c1"># simplified from zope.dottedname</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
<span class="n">used</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">found</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">used</span><span class="p">)</span>
<span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">parts</span><span class="p">:</span>
<span class="n">used</span> <span class="o">+=</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="n">part</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">found</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">found</span><span class="p">,</span> <span class="n">part</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">continue</span>
<span class="c1"># we use explicit un-nesting of the handling block in order</span>
<span class="c1"># to avoid nested exceptions on python 3</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">__import__</span><span class="p">(</span><span class="n">used</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
<span class="c1"># str is used for py2 vs py3</span>
<span class="n">expected</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">expected</span> <span class="o">==</span> <span class="n">used</span><span class="p">:</span>
<span class="k">raise</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
<span class="s1">'import error in </span><span class="si">%s</span><span class="s1">: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">used</span><span class="p">,</span> <span class="n">ex</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">found</span> <span class="o">=</span> <span class="n">annotated_getattr</span><span class="p">(</span><span class="n">found</span><span class="p">,</span> <span class="n">part</span><span class="p">,</span> <span class="n">used</span><span class="p">)</span>
<span class="k">return</span> <span class="n">found</span>
<span class="k">def</span> <span class="nf">annotated_getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ann</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span>
<span class="s1">'</span><span class="si">%r</span><span class="s1"> object at </span><span class="si">%s</span><span class="s1"> has no attribute </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span>
<span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">ann</span><span class="p">,</span> <span class="n">name</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">obj</span>
<span class="k">def</span> <span class="nf">derive_importpath</span><span class="p">(</span><span class="n">import_path</span><span class="p">,</span> <span class="n">raising</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">import_path</span><span class="p">,</span> <span class="n">_basestring</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">"."</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">import_path</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"must be absolute import path string, not </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">import_path</span><span class="p">,))</span>
<span class="n">module</span><span class="p">,</span> <span class="n">attr</span> <span class="o">=</span> <span class="n">import_path</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">resolve</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
<span class="k">if</span> <span class="n">raising</span><span class="p">:</span>
<span class="n">annotated_getattr</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">ann</span><span class="o">=</span><span class="n">module</span><span class="p">)</span>
<span class="k">return</span> <span class="n">attr</span><span class="p">,</span> <span class="n">target</span>
<span class="k">class</span> <span class="nc">Notset</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="s2">"<notset>"</span>
<span class="n">notset</span> <span class="o">=</span> <span class="n">Notset</span><span class="p">()</span>
<div class="viewcode-block" id="monkeypatch"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch">[docs]</a><span class="k">class</span> <span class="nc">monkeypatch</span><span class="p">:</span>
<span class="sd">""" Object keeping a record of setattr/item/env/syspath changes. """</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">_setattr</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setitem</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cwd</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_savesyspath</span> <span class="o">=</span> <span class="bp">None</span>
<div class="viewcode-block" id="monkeypatch.setattr"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.setattr">[docs]</a> <span class="k">def</span> <span class="nf">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">notset</span><span class="p">,</span> <span class="n">raising</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">""" Set attribute value on target, memorizing the old value.</span>
<span class="sd"> By default raise AttributeError if the attribute did not exist.</span>
<span class="sd"> For convenience you can specify a string as ``target`` which</span>
<span class="sd"> will be interpreted as a dotted import path, with the last part</span>
<span class="sd"> being the attribute name. Example:</span>
<span class="sd"> ``monkeypatch.setattr("os.getcwd", lambda x: "/")``</span>
<span class="sd"> would set the ``getcwd`` function of the ``os`` module.</span>
<span class="sd"> The ``raising`` value determines if the setattr should fail</span>
<span class="sd"> if the attribute is not already present (defaults to True</span>
<span class="sd"> which means it will raise).</span>
<span class="sd"> """</span>
<span class="n">__tracebackhide__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="n">notset</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">target</span><span class="p">,</span> <span class="n">_basestring</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"use setattr(target, name, value) or "</span>
<span class="s2">"setattr(target, value) with target being a dotted "</span>
<span class="s2">"import string"</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">name</span>
<span class="n">name</span><span class="p">,</span> <span class="n">target</span> <span class="o">=</span> <span class="n">derive_importpath</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">raising</span><span class="p">)</span>
<span class="n">oldval</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">notset</span><span class="p">)</span>
<span class="k">if</span> <span class="n">raising</span> <span class="ow">and</span> <span class="n">oldval</span> <span class="ow">is</span> <span class="n">notset</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="s2">"</span><span class="si">%r</span><span class="s2"> has no attribute </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="c1"># avoid class descriptors like staticmethod/classmethod</span>
<span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">target</span><span class="p">):</span>
<span class="n">oldval</span> <span class="o">=</span> <span class="n">target</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">notset</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setattr</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">oldval</span><span class="p">))</span>
<span class="nb">setattr</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="monkeypatch.delattr"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.delattr">[docs]</a> <span class="k">def</span> <span class="nf">delattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">notset</span><span class="p">,</span> <span class="n">raising</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">""" Delete attribute ``name`` from ``target``, by default raise</span>
<span class="sd"> AttributeError it the attribute did not previously exist.</span>
<span class="sd"> If no ``name`` is specified and ``target`` is a string</span>
<span class="sd"> it will be interpreted as a dotted import path with the</span>
<span class="sd"> last part being the attribute name.</span>
<span class="sd"> If ``raising`` is set to False, no exception will be raised if the</span>
<span class="sd"> attribute is missing.</span>
<span class="sd"> """</span>
<span class="n">__tracebackhide__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="n">notset</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">target</span><span class="p">,</span> <span class="n">_basestring</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"use delattr(target, name) or "</span>
<span class="s2">"delattr(target) with target being a dotted "</span>
<span class="s2">"import string"</span><span class="p">)</span>
<span class="n">name</span><span class="p">,</span> <span class="n">target</span> <span class="o">=</span> <span class="n">derive_importpath</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">raising</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">target</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">if</span> <span class="n">raising</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setattr</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">notset</span><span class="p">)))</span>
<span class="nb">delattr</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
<div class="viewcode-block" id="monkeypatch.setitem"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.setitem">[docs]</a> <span class="k">def</span> <span class="nf">setitem</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dic</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">""" Set dictionary entry ``name`` to value. """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setitem</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">dic</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">dic</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">notset</span><span class="p">)))</span>
<span class="n">dic</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="monkeypatch.delitem"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.delitem">[docs]</a> <span class="k">def</span> <span class="nf">delitem</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dic</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">raising</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">""" Delete ``name`` from dict. Raise KeyError if it doesn't exist.</span>
<span class="sd"> If ``raising`` is set to False, no exception will be raised if the</span>
<span class="sd"> key is missing.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">dic</span><span class="p">:</span>
<span class="k">if</span> <span class="n">raising</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setitem</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">dic</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">dic</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">notset</span><span class="p">)))</span>
<span class="k">del</span> <span class="n">dic</span><span class="p">[</span><span class="n">name</span><span class="p">]</span></div>
<div class="viewcode-block" id="monkeypatch.setenv"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.setenv">[docs]</a> <span class="k">def</span> <span class="nf">setenv</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">prepend</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">""" Set environment variable ``name`` to ``value``. If ``prepend``</span>
<span class="sd"> is a character, read the current environment variable value</span>
<span class="sd"> and prepend the ``value`` adjoined with the ``prepend`` character."""</span>
<span class="n">value</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">prepend</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">prepend</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">setitem</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="monkeypatch.delenv"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.delenv">[docs]</a> <span class="k">def</span> <span class="nf">delenv</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">raising</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">""" Delete ``name`` from the environment. Raise KeyError it does not</span>
<span class="sd"> exist.</span>
<span class="sd"> If ``raising`` is set to False, no exception will be raised if the</span>
<span class="sd"> environment variable is missing.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">delitem</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">raising</span><span class="o">=</span><span class="n">raising</span><span class="p">)</span></div>
<div class="viewcode-block" id="monkeypatch.syspath_prepend"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.syspath_prepend">[docs]</a> <span class="k">def</span> <span class="nf">syspath_prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">""" Prepend ``path`` to ``sys.path`` list of import locations. """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_savesyspath</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_savesyspath</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[:]</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">))</span></div>
<div class="viewcode-block" id="monkeypatch.chdir"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.chdir">[docs]</a> <span class="k">def</span> <span class="nf">chdir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">""" Change the current working directory to the specified path.</span>
<span class="sd"> Path can be a string or a py.path.local object.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cwd</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">"chdir"</span><span class="p">):</span>
<span class="n">path</span><span class="o">.</span><span class="n">chdir</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>
<div class="viewcode-block" id="monkeypatch.undo"><a class="viewcode-back" href="../../monkeypatch.html#_pytest.monkeypatch.monkeypatch.undo">[docs]</a> <span class="k">def</span> <span class="nf">undo</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Undo previous changes. This call consumes the</span>
<span class="sd"> undo stack. Calling it a second time has no effect unless</span>
<span class="sd"> you do more monkeypatching after the undo call.</span>
<span class="sd"> </span>
<span class="sd"> There is generally no need to call `undo()`, since it is</span>
<span class="sd"> called automatically during tear-down.</span>
<span class="sd"> </span>
<span class="sd"> Note that the same `monkeypatch` fixture is used across a</span>
<span class="sd"> single test function invocation. If `monkeypatch` is used both by</span>
<span class="sd"> the test function itself and one of the test fixtures,</span>
<span class="sd"> calling `undo()` will undo all of the changes made in</span>
<span class="sd"> both functions.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_setattr</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">notset</span><span class="p">:</span>
<span class="nb">setattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">delattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setattr</span><span class="p">[:]</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">dictionary</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_setitem</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="n">notset</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">del</span> <span class="n">dictionary</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span> <span class="c1"># was already deleted, so we have the desired state</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">dictionary</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setitem</span><span class="p">[:]</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_savesyspath</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[:]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_savesyspath</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_savesyspath</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cwd</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cwd</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cwd</span> <span class="o">=</span> <span class="bp">None</span></div></div>
</pre></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>
</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://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="http://pytest.org/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">
<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 2015, holger krekel and pytest-dev team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|