Inappropriateness in unittest documentation with actual behavior

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

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.

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

gh-118912: Remove description of issue fixed in 3.5 from autospeccing…

pythongh-118912: Remove description of issue fixed in 3.5 from autosp…

[3.12] gh-118912: Remove description of issue fixed in 3.5 from autos…

[3.13] gh-118912: Remove description of issue fixed in 3.5 from autos…

pythongh-118912: Remove description of issue fixed in 3.5 from autosp…

Navigation Menu

Repository navigation

Inappropriateness in unittest documentation with actual behavior #118912

Documentation

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Inappropriateness in unittest documentation with actual behavior #118912

Description

Documentation

Linked PRs

Activity

blhsing commented on May 16, 2024

shaunagm commented on May 20, 2024

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions