From: Michael Foord Date: Fri, 13 Apr 2012 19:51:20 +0000 (+0100) Subject: Minor docstring / docs corrections for unittest.mock X-Git-Tag: v3.3.0a3~238 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0682a0c0a925c52bf4d8d3030681b82796bdc6e2;p=thirdparty%2FPython%2Fcpython.git Minor docstring / docs corrections for unittest.mock --- diff --git a/Doc/library/unittest.mock-examples.rst b/Doc/library/unittest.mock-examples.rst index d220bb34eadb..0fc32d2077b4 100644 --- a/Doc/library/unittest.mock-examples.rst +++ b/Doc/library/unittest.mock-examples.rst @@ -99,7 +99,7 @@ by looking at the return value of the mocked class. In the example below we have a function `some_function` that instantiates `Foo` and calls a method on it. The call to `patch` replaces the class `Foo` with a mock. The `Foo` instance is the result of calling the mock, so it is configured -by modify the mock :attr:`~Mock.return_value`. +by modifying the mock :attr:`~Mock.return_value`. >>> def some_function(): ... instance = module.Foo() diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst index f00d29f028e8..ed6775a4878e 100644 --- a/Doc/library/unittest.mock.rst +++ b/Doc/library/unittest.mock.rst @@ -236,10 +236,10 @@ the `new_callable` argument to `patch`. * `wraps`: Item for the mock object to wrap. If `wraps` is not None then calling the Mock will pass the call through to the wrapped object - (returning the real result and ignoring `return_value`). Attribute access - on the mock will return a Mock object that wraps the corresponding - attribute of the wrapped object (so attempting to access an attribute - that doesn't exist will raise an `AttributeError`). + (returning the real result). Attribute access on the mock will return a + Mock object that wraps the corresponding attribute of the wrapped + object (so attempting to access an attribute that doesn't exist will + raise an `AttributeError`). If the mock has an explicit `return_value` set then calls are not passed to the wrapped object and the `return_value` is returned instead. diff --git a/Lib/unittest/mock.py b/Lib/unittest/mock.py index 04eba918cc4f..8cedcb4e7180 100644 --- a/Lib/unittest/mock.py +++ b/Lib/unittest/mock.py @@ -941,12 +941,12 @@ class Mock(CallableMixin, NonCallableMock): this is a new Mock (created on first access). See the `return_value` attribute. - * `wraps`: Item for the mock object to wrap. If `wraps` is not None - then calling the Mock will pass the call through to the wrapped object - (returning the real result and ignoring `return_value`). Attribute - access on the mock will return a Mock object that wraps the corresponding - attribute of the wrapped object (so attempting to access an attribute that - doesn't exist will raise an `AttributeError`). + * `wraps`: Item for the mock object to wrap. If `wraps` is not None then + calling the Mock will pass the call through to the wrapped object + (returning the real result). Attribute access on the mock will return a + Mock object that wraps the corresponding attribute of the wrapped object + (so attempting to access an attribute that doesn't exist will raise an + `AttributeError`). If the mock has an explicit `return_value` set then calls are not passed to the wrapped object and the `return_value` is returned instead.