Skip to content

Inappropriateness in unittest documentation with actual behavior #118912

Closed
#119232
Closed
Inappropriateness in unittest documentation with actual behavior#118912
#119232
Labels
docsDocumentation in the Doc dir

Description

@AliyevH
AliyevH
opened on May 10, 2024

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

Activity

  1. AliyevH
    added
    docsDocumentation in the Doc dir
    on May 10, 2024
  2. AlexWaygood
    added this to Unittest & doctest issueson May 10, 2024
  3. github-project-automation
    moved this to Todo in Unittest & doctest issueson May 10, 2024

  4. blhsing commented on May 16, 2024

    @blhsing
    blhsing
    on May 16, 2024
    Contributor

    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.

  5. shaunagm commented on May 20, 2024

    @shaunagm
    shaunagm
    on May 20, 2024
    SponsorContributor

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

  6. willingc
    closed this as completedin #119232on May 20, 2024
  7. willingc
    added a commit that references this issue on May 20, 2024

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

    7e57640
  8. github-project-automation
    moved this from Todo to Done in Unittest & doctest issueson May 20, 2024
  9. miss-islington
    added 2 commits that reference this issue on May 20, 2024

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

    d86ae9c

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

    96e5553
  10. willingc
    added 2 commits that reference this issue on May 20, 2024

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

    d8981ab

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

    24b0e8d
  11. estyxx
    added a commit that references this issue on Jul 17, 2024

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

    b03e63c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions