Skip to content

Can't call mocked methods after create_autospec() and seal() #91803

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

Jump to bottom
Closed
dseomn opened this issue Apr 21, 2022 · 3 comments
Closed

Can't call mocked methods after create_autospec() and seal() #91803

dseomn opened this issue Apr 21, 2022 · 3 comments
Labels
stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error

Comments

@dseomn
Copy link

dseomn commented Apr 21, 2022 •
edited by bedevere-bot
Loading

Bug report

The code below raises the error below. If I'm understanding the documentation for mock.seal correctly, it's supposed to prevent the creation of new attributes on the sealed mock, not prevent calls to existing methods, right?

from unittest import mock
class Foo:
    def foo(self) -> int:
        return 0
foo = mock.create_autospec(Foo, instance=True)
mock.seal(foo)
foo.foo()
Traceback (most recent call last):
  File "/tmp/tmp.8toUu9Dy3T/foo.py", line 7, in <module>
    foo.foo()
  File "/usr/lib/python3.9/unittest/mock.py", line 1092, in __call__
    return self._mock_call(*args, **kwargs)
  File "/usr/lib/python3.9/unittest/mock.py", line 1096, in _mock_call
    return self._execute_mock_call(*args, **kwargs)
  File "/usr/lib/python3.9/unittest/mock.py", line 1168, in _execute_mock_call
    return self.return_value
  File "/usr/lib/python3.9/unittest/mock.py", line 630, in __getattr__
    raise AttributeError("Mock object has no attribute %r" % name)
AttributeError: Mock object has no attribute 'return_value'

Your environment

  • CPython versions tested on: 3.9.9
  • Operating system and architecture: Debian testing / amd64
@dseomn dseomn added the type-bug An unexpected behavior, bug, or error label Apr 21, 2022
@AlexWaygood AlexWaygood added the stdlib Python modules in the Lib dir label Apr 21, 2022
@eugenetriguba
Copy link
Contributor

eugenetriguba commented Apr 24, 2022 •
edited
Loading

If you set the return value beforehand or make a call to that method, you can.

$ ./python
Python 3.11.0a7+ (heads/main:090721721b, Apr 24 2022, 14:58:17) [GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from unittest import mock
>>> class Foo:
...     def foo(self) -> int:
...         return 0
... 
>>> foo = mock.create_autospec(Foo, instance=True)
>>> foo.foo.return_value = 1
>>> mock.seal(foo)
>>> foo.foo()
1

$ ./python
Python 3.11.0a7+ (heads/main:090721721b, Apr 24 2022, 14:58:17) [GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from unittest import mock
>>> class Foo:
...     def foo(self) -> int:
...         return 0
... 
>>> foo = mock.create_autospec(Foo, instance=True)
>>> foo.foo()
<MagicMock name='mock.foo()' id='140365640689440'>
>>> mock.seal(foo)
>>> foo.foo()
<MagicMock name='mock.foo()' id='140365640689440'>

This may be related to how mock.create_autospec is creating the mock. For instance:

$ ./python
Python 3.11.0a7+ (heads/main:090721721b, Apr 24 2022, 14:58:17) [GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from unittest import mock
>>> foo = mock.Mock()
>>> def f(): return 1
... 
>>> f()
1
>>> foo.foo = f
>>> mock.seal(foo)
>>> foo.foo()
1

I'll look into it a little more

@akulakov
Copy link
Contributor

akulakov commented May 3, 2022

I've added a draft PR #92213 , but I need to work on it a bit more.

@akulakov
Copy link
Contributor

akulakov commented May 3, 2022

I think the PR may be good, if we consider Mock return value of methods as part of the autospec. That's what such methods return if there is no seal.

However I haven't used seal() before and I haven't used autospec in any advanced way, so I hope this can be looked at by an expert in mock module.

@bedevere-bot bedevere-bot mentioned this issue Jun 25, 2022
Merged
@cjw296 cjw296 closed this as completed in c6325b1 Nov 7, 2022
@cjw296 cjw296 moved this to Done in Unittest issues Nov 7, 2022
cjw296 pushed a commit to cjw296/mock that referenced this issue Dec 28, 2022
@akulakov @tirkarthi
@iritkatriel @cjw296
gh-91803: Mock - fix error when using autospec methods with seal (#92…
6cb4e6b 
…213)

Fixes python/cpython#91803.

Co-authored-by: Karthikeyan Singaravelan <tir.karthi@gmail.com>
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Backports: c6325b1c9fe60f72bb3fa4b8570a699e9e97af53
Signed-off-by: Chris Withers <chris@simplistix.co.uk>
cjw296 pushed a commit to testing-cabal/mock that referenced this issue Dec 28, 2022
@akulakov @tirkarthi
@iritkatriel @cjw296
gh-91803: Mock - fix error when using autospec methods with seal (#92…
4d3f197 
…213)

Fixes python/cpython#91803.

Co-authored-by: Karthikeyan Singaravelan <tir.karthi@gmail.com>
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Backports: c6325b1c9fe60f72bb3fa4b8570a699e9e97af53
Signed-off-by: Chris Withers <chris@simplistix.co.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
Projects
Unittest issues
Status: Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@akulakov @dseomn @eugenetriguba @AlexWaygood