unittest.mock.patch of a subclass poisons base class
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Bug report
Bug description:
this is an entirely silly example boiled down from a much more complex one to demonstrate the behaviour. the actual code here is nonsensical (Test2 will always fail) but Test1 should work just fine -- the decoration of the subclass Test2 seems to also decorate Test1's methods unexpectedly
from unittest import mock
s = 0
@mock.patch(f"{__name__}.s", 5)
class Test1:
def test_1(self):
assert s == 5, s
@mock.patch(f"{__name__}.s", 2)
class Test2(Test1): pass
Test1().test_1()
$ python3.12 t2.py
Traceback (most recent call last):
File "/Users/asottile/workspace/sentry/t2.py", line 14, in <module>
Test1().test_1()
File "/opt/homebrew/Cellar/python@3.12/3.12.2_1/Frameworks/Python.framework/Versions/3.12/lib/python3.12/unittest/mock.py", line 1387, in patched
return func(*newargs, **newkeywargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/asottile/workspace/sentry/t2.py", line 8, in test_1
assert s == 5, s
AssertionError: 2
the problem appears to be here: https://github.com/python/cpython/blob/ea94b3b149eeadf33c2f7c46f16dcda0adc7cf4e/Lib/unittest/mock.py#L1412
whereas I think it should always return a new callable instead of mutating a potentially unrelated method
CPython versions tested on:
3.12
Operating systems tested on:
macOS
Linked PRs
- gh-117665
- gh-117667
- gh-117687
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Run the supplied Python 3.12 reproducer and inspect Lib/unittest/mock.py around line 1412, where the issue identifies the problematic behavior. Review linked PRs gh-117665, gh-117667, and gh-117687 before making changes; done means patching a subclass no longer changes the inherited method behavior observed through Test1.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing-qa
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100