Merge pull request #982 from codewarrior0/patch-1

Add notes to docstring of `monkeypatch.undo()`
This commit is contained in:
Bruno Oliveira 2015-08-31 21:18:53 -03:00
commit 06a70b6d6d
1 changed files with 11 additions and 1 deletions

View File

@ -191,7 +191,17 @@ class monkeypatch:
def undo(self):
""" 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."""
you do more monkeypatching after the undo call.
There is generally no need to call `undo()`, since it is
called automatically during tear-down.
Note that the same `monkeypatch` fixture is used across a
single test function invocation. If `monkeypatch` is used both by
the test function itself and one of the test fixtures,
calling `undo()` will undo all of the changes made in
both functions.
"""
for obj, name, value in self._setattr:
if value is not notset:
setattr(obj, name, value)