Inappropriateness in unittest documentation with actual behavior

[AliyevH]

Documentation

https://docs.python.org/3/library/unittest.mock.html#auto-speccing

cpython/Doc/library/unittest.mock.rst

Line 2615 in c444362

Your tests can pass silently and incorrectly because of the typo.

mock = Mock(name='Thing', return_value=None)
mock(1, 2, 3)
mock.assret_called_once_with(4, 5, 6)  # Intentional typo!

Your tests can pass silently and incorrectly because of the typo.

---

Expected that tests will pass as written in doc.

But actually script fails with raising error.

raise AttributeError(
AttributeError: 'assret_called_once_with' is not a valid assertion. Use a spec for the mock if 'assret_called_once_with' is meant to be an attribute.. Did you mean: 'assert_called_once_with'?

Am i missing something? I have tested this in Python3.11 and Python 3.12.
Looks like documentation must be updated or script must work as said in documenation.

Thanks for attention

Linked PRs

• gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide #119232
• [3.12] gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232) #119283
• [3.13] gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232) #119284

[blhsing]

Note that the doc describes the pre-Python 3.5 behavior. Since Python 3.5, one has to enable the unsafe option to achieve the same behavior:

cpython/Doc/library/unittest.mock.rst

Line 269 in c444362

:exc:`AttributeError`. Passing ``unsafe=True`` will allow access to

unsafe: By default, accessing any attribute whose name starts with assert, assret, asert, aseert or assrt will raise an AttributeError. Passing unsafe=True will allow access to these attributes.

Added in version 3.5.

[shaunagm]

I am working on this issue! I hope to finish it today (at the PyCon sprints)