summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorMichael Foord <michael@voidspace.org.uk>2012-04-21 14:52:11 (GMT)
committerMichael Foord <michael@voidspace.org.uk>2012-04-21 14:52:11 (GMT)
commit2cd48738ba0a593a6edf6f4f41b420ead3719e71 (patch)
tree767327ab8cb7c811e009645623cd29ecc588cc20 /Doc/library
parent24117a748b02e0d2d028956c7b118f4ecd55361c (diff)
downloadcpython-2cd48738ba0a593a6edf6f4f41b420ead3719e71.zip
cpython-2cd48738ba0a593a6edf6f4f41b420ead3719e71.tar.gz
cpython-2cd48738ba0a593a6edf6f4f41b420ead3719e71.tar.bz2
Closes issue 14636. mock objects raise exceptions from an iterable side_effect
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/unittest.mock-examples.rst50
-rw-r--r--Doc/library/unittest.mock.rst14
2 files changed, 14 insertions, 50 deletions
diff --git a/Doc/library/unittest.mock-examples.rst b/Doc/library/unittest.mock-examples.rst
index 0fc32d2..8e1e88a 100644
--- a/Doc/library/unittest.mock-examples.rst
+++ b/Doc/library/unittest.mock-examples.rst
@@ -838,56 +838,6 @@ and the `return_value` will use your subclass automatically. That means all
children of a `CopyingMock` will also have the type `CopyingMock`.
-Multiple calls with different effects
--------------------------------------
-
-Handling code that needs to behave differently on subsequent calls during the
-test can be tricky. For example you may have a function that needs to raise
-an exception the first time it is called but returns a response on the second
-call (testing retry behaviour).
-
-One approach is to use a :attr:`side_effect` function that replaces itself. The
-first time it is called the `side_effect` sets a new `side_effect` that will
-be used for the second call. It then raises an exception:
-
- >>> def side_effect(*args):
- ... def second_call(*args):
- ... return 'response'
- ... mock.side_effect = second_call
- ... raise Exception('boom')
- ...
- >>> mock = Mock(side_effect=side_effect)
- >>> mock('first')
- Traceback (most recent call last):
- ...
- Exception: boom
- >>> mock('second')
- 'response'
- >>> mock.assert_called_with('second')
-
-Another perfectly valid way would be to pop return values from a list. If the
-return value is an exception, raise it instead of returning it:
-
- >>> returns = [Exception('boom'), 'response']
- >>> def side_effect(*args):
- ... result = returns.pop(0)
- ... if isinstance(result, Exception):
- ... raise result
- ... return result
- ...
- >>> mock = Mock(side_effect=side_effect)
- >>> mock('first')
- Traceback (most recent call last):
- ...
- Exception: boom
- >>> mock('second')
- 'response'
- >>> mock.assert_called_with('second')
-
-Which approach you prefer is a matter of taste. The first approach is actually
-a line shorter but maybe the second approach is more readable.
-
-
Nesting Patches
---------------
diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index ed6775a..12b0275 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -823,6 +823,20 @@ a `StopIteration` is raised):
...
StopIteration
+If any members of the iterable are exceptions they will be raised instead of
+returned::
+
+ >>> iterable = (33, ValueError, 66)
+ >>> m = MagicMock(side_effect=iterable)
+ >>> m()
+ 33
+ >>> m()
+ Traceback (most recent call last):
+ ...
+ ValueError
+ >>> m()
+ 66
+
.. _deleting-attributes: