From eddeeaf9b016e9f499963785389fe157bdb9a01e Mon Sep 17 00:00:00 2001
From: Michael Foord <michael@voidspace.org.uk>
Date: Mon, 13 Jun 2011 14:17:40 +0100
Subject: [PATCH] New example
---
README.txt | 6 ++++++
docs/examples.txt | 48 +++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 54 insertions(+)
diff --git a/README.txt b/README.txt
index cdceb99..183ad40 100644
--- a/README.txt
+++ b/README.txt
@@ -6,6 +6,12 @@ needed attributes in the normal way.
mock is tested on Python versions 2.4-2.7 and Python 3.
+.. note::
+
+ You can install the latest alpha version of `mock (0.8 alpha 1)
+ <http://www.voidspace.org.uk/downloads/mock-0.8.0alpha1.tar.gz#egg=mock-dev>`_
+ with `pip install mock==dev`.
+
The mock module also provides utility functions / objects to assist with
testing, particularly monkey patching.
diff --git a/docs/examples.txt b/docs/examples.txt
index a4644ee..6408c94 100644
--- a/docs/examples.txt
+++ b/docs/examples.txt
@@ -245,6 +245,54 @@ function in the module under test instead of patching it globally:
>>> file_handle.write.assert_called_with('something')
+Mocking a Generator Method
+==========================
+
+A generator method is a method that uses the `yield statement
+<http://docs.python.org/reference/simple_stmts.html#the-yield-statement>`_ to
+return a series of values when iterated over.
+
+A generator method is called to return the generator object. It is the generator
+object that is then iterated over. The protocol method for iteration is
+`__iter__ <http://docs.python.org/library/stdtypes.html#container.__iter__>`_,
+so we can mock this using a `MagicMock`.
+
+Here's an example class:
+
+.. doctest::
+
+ >>> class Foo(object):
+ ... def iter(self):
+ ... for i in [1, 2, 3]:
+ ... yield i
+ ...
+ >>> foo = Foo()
+ >>> list(foo.iter())
+ [1, 2, 3]
+
+To configure the values returned from the iteration (implicit in the call to
+`list`), we need to configure the iterator returned by the call to `foo.iter()`.
+
+.. doctest::
+
+ >>> values = [1, 2, 3]
+ >>> mock_foo = MagicMock()
+ >>> iterable = mock_foo.iter.return_value
+ >>> iterator = iter(values)
+ >>> iterable.__iter__.return_value = iterator
+ >>> list(mock_foo.iter())
+ [1, 2, 3]
+
+The above example is done step-by-step. The shorter version is:
+
+.. doctest::
+
+ >>> mock_foo = MagicMock()
+ >>> mock_foo.iter.return_value.__iter__.return_value = iter([1, 2, 3])
+ >>> list(mock_foo.iter())
+ [1, 2, 3]
+
+
Applying the same patch to every test method
============================================
--
GitLab