summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Foord <michael@voidspace.org.uk>2013-03-18 22:04:03 (GMT)
committerMichael Foord <michael@voidspace.org.uk>2013-03-18 22:04:03 (GMT)
commitf5752309813368f1a511d79c8b64a0888245932a (patch)
tree2c6f510e2a6c2de50807f205e9f353a1f2740058
parentf0efea0841a825b8aa68e2ff97ff24ae31037f80 (diff)
downloadcpython-f5752309813368f1a511d79c8b64a0888245932a.zip
cpython-f5752309813368f1a511d79c8b64a0888245932a.tar.gz
cpython-f5752309813368f1a511d79c8b64a0888245932a.tar.bz2
Documentation corrections for unittest.mock
-rw-r--r--Doc/library/unittest.mock.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index ec316db..6d1a57e 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -867,6 +867,25 @@ will raise an `AttributeError`.
AttributeError: f
+Mock names and the name attribute
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Since "name" is an argument to the :class:`Mock` constructor, if you want your
+mock object to have a "name" attribute you can't just pass it in at creation
+time. There are two alternatives. One option is to use
+:meth:`~Mock.configure_mock`::
+
+ >>> mock = MagicMock()
+ >>> mock.configure_mock(name='my_name')
+ >>> mock.name
+ 'my_name'
+
+A simpler option is to simply set the "name" attribute after mock creation::
+
+ >>> mock = MagicMock()
+ >>> mock.name = "foo"
+
+
Attaching Mocks as Attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~