Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix margin in sentinel and mock_open #8188

Merged
merged 1 commit into from
Jul 9, 2018
Merged

Fix margin in sentinel and mock_open #8188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions Doc/library/unittest.mock.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1825,12 +1825,12 @@ sentinel

.. data:: sentinel

The ``sentinel`` object provides a convenient way of providing unique
objects for your tests.
The ``sentinel`` object provides a convenient way of providing unique
objects for your tests.

Attributes are created on demand when you access them by name. Accessing
the same attribute will always return the same object. The objects
returned have a sensible repr so that test failure messages are readable.
Attributes are created on demand when you access them by name. Accessing
the same attribute will always return the same object. The objects
returned have a sensible repr so that test failure messages are readable.

.. versionchanged:: 3.7
The ``sentinel`` attributes now preserve their identity when they are
Expand Down Expand Up @@ -2070,22 +2070,22 @@ mock_open

.. function:: mock_open(mock=None, read_data=None)

A helper function to create a mock to replace the use of :func:`open`. It works
for :func:`open` called directly or used as a context manager.

The *mock* argument is the mock object to configure. If ``None`` (the
default) then a :class:`MagicMock` will be created for you, with the API limited
to methods or attributes available on standard file handles.

*read_data* is a string for the :meth:`~io.IOBase.read`,
:meth:`~io.IOBase.readline`, and :meth:`~io.IOBase.readlines` methods
of the file handle to return. Calls to those methods will take data from
*read_data* until it is depleted. The mock of these methods is pretty
simplistic: every time the *mock* is called, the *read_data* is rewound to
the start. If you need more control over the data that you are feeding to
the tested code you will need to customize this mock for yourself. When that
is insufficient, one of the in-memory filesystem packages on `PyPI
<https://pypi.org>`_ can offer a realistic filesystem for testing.
A helper function to create a mock to replace the use of :func:`open`. It works
for :func:`open` called directly or used as a context manager.

The *mock* argument is the mock object to configure. If ``None`` (the
default) then a :class:`MagicMock` will be created for you, with the API limited
to methods or attributes available on standard file handles.

*read_data* is a string for the :meth:`~io.IOBase.read`,
:meth:`~io.IOBase.readline`, and :meth:`~io.IOBase.readlines` methods
of the file handle to return. Calls to those methods will take data from
*read_data* until it is depleted. The mock of these methods is pretty
simplistic: every time the *mock* is called, the *read_data* is rewound to
the start. If you need more control over the data that you are feeding to
the tested code you will need to customize this mock for yourself. When that
is insufficient, one of the in-memory filesystem packages on `PyPI
<https://pypi.org>`_ can offer a realistic filesystem for testing.

.. versionchanged:: 3.4
Added :meth:`~io.IOBase.readline` and :meth:`~io.IOBase.readlines` support.
Expand Down