Commit 54b3db8c authored by Michael Foord's avatar Michael Foord

Minor unittest.mock.patch doc / docstring improvement

parent a9e6fb20
...@@ -920,17 +920,20 @@ patch ...@@ -920,17 +920,20 @@ patch
`patch` acts as a function decorator, class decorator or a context `patch` acts as a function decorator, class decorator or a context
manager. Inside the body of the function or with statement, the `target` manager. Inside the body of the function or with statement, the `target`
(specified in the form `'package.module.ClassName'`) is patched is patched with a `new` object. When the function/with statement exits
with a `new` object. When the function/with statement exits the patch is the patch is undone.
undone.
If `new` is omitted, then the target is replaced with a
The `target` is imported and the specified attribute patched with the new :class:`MagicMock`. If `patch` is used as a decorator and `new` is
object, so it must be importable from the environment you are calling the omitted, the created mock is passed in as an extra argument to the
decorator from. The target is imported when the decorated function is decorated function. If `patch` is used as a context manager the created
executed, not at decoration time. mock is returned by the context manager.
If `new` is omitted, then a new `MagicMock` is created and passed in as an `target` should be a string in the form `'package.module.ClassName'`. The
extra argument to the decorated function. `target` is imported and the specified object replaced with the `new`
object, so the `target` must be importable from the environment you are
calling `patch` from. The target is imported when the decorated function
is executed, not at decoration time.
The `spec` and `spec_set` keyword arguments are passed to the `MagicMock` The `spec` and `spec_set` keyword arguments are passed to the `MagicMock`
if patch is creating one for you. if patch is creating one for you.
......
...@@ -1351,18 +1351,23 @@ def patch( ...@@ -1351,18 +1351,23 @@ def patch(
): ):
""" """
`patch` acts as a function decorator, class decorator or a context `patch` acts as a function decorator, class decorator or a context
manager. Inside the body of the function or with statement, the `target`
(specified in the form `'package.module.ClassName'`) is patched
with a `new` object. When the function/with statement exits the patch is
undone.
The `target` is imported and the specified attribute patched with the new
object, so it must be importable from the environment you are calling the
decorator from. The target is imported when the decorated function is
executed, not at decoration time.
If `new` is omitted, then a new `MagicMock` is created and passed in as an `patch` acts as a function decorator, class decorator or a context
extra argument to the decorated function. manager. Inside the body of the function or with statement, the `target`
is patched with a `new` object. When the function/with statement exits
the patch is undone.
If `new` is omitted, then the target is replaced with a
`MagicMock`. If `patch` is used as a decorator and `new` is
omitted, the created mock is passed in as an extra argument to the
decorated function. If `patch` is used as a context manager the created
mock is returned by the context manager.
`target` should be a string in the form `'package.module.ClassName'`. The
`target` is imported and the specified object replaced with the `new`
object, so the `target` must be importable from the environment you are
calling `patch` from. The target is imported when the decorated function
is executed, not at decoration time.
The `spec` and `spec_set` keyword arguments are passed to the `MagicMock` The `spec` and `spec_set` keyword arguments are passed to the `MagicMock`
if patch is creating one for you. if patch is creating one for you.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment