Issue #20804: Document the limitation of the unittest.mock.sentinel attributes.

This commit is contained in:
Serhiy Storchaka 2017-01-11 20:16:44 +02:00
parent 924aaae4c2
commit 87006a3d4a
1 changed files with 3 additions and 0 deletions

View File

@ -1795,6 +1795,9 @@ sentinel
the same attribute will always return the same object. The objects
returned have a sensible repr so that test failure messages are readable.
The ``sentinel`` attributes don't preserve their identity when they are
:mod:`copied <copy>` or :mod:`pickled <pickle>`.
Sometimes when testing you need to test that a specific object is passed as an
argument to another method, or returned. It can be common to create named
sentinel objects to test this. :data:`sentinel` provides a convenient way of