unittest.mock.patch('path') neither forwards or backwards compatible starting from Python >= v3.11
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Bug report
Bug description:
Issue
It appears that Python v3.11 and v3.12 are not respecting project functions and classes relative to the module root (module.__init__) when running tests and leveraging unittest.mock.
Proof of Failure
👉 I created a project that can be found here which demonstrates the entire situation.
You can review the import failures across the multiple versions of Python here
Expected Behavior
That the following would work in Python >= 3.11 as it does with all previous versions:
import sys
from unittest import mock
# This actually retrieves apprise.Apprise.Apprise().notify when using
# earlier versions of py.test (hence apprise.__init__.__all__ is respected)
@mock.patch("apprise.Apprise.notify")
def test_py11_and_higher_fails(mock_notify):
"""
Only works with Python v3.10
Python v3.11+ produces (where ?? is swapped with 11, or 12 respectively to whichever version of Python is being tested):
AttributeError: <module 'apprise.Apprise' from '/usr/local/lib/python3.??/site-packages/apprise/Apprise.py'> does not have the attribute 'notify
"""
pass
For it to work in newer versions of Python, the modules internal object placements are ignored. The following does however work (but incompatible with Python v3.10 and less):
# ...
@mock.patch("apprise.Apprise.Apprise.notify")
def test_py10_and_lower_fails(mock_notify):
...
Apprise Background
I'm not sure if this information is relavant; but perhaps the issue is centered around the module itself I'm testing against that makes use of the __all__ setting. Just incase; here are details that surround it:
The __init__ residing in the Apprise Module identifies:
# Get our class Apprise() from within the Apprise.py file
from .Apprise import Apprise
__all__ = [
'Apprise', #...
]
Regular Usage Works
Despite testing failing, all versions of the Python continue to respect import and correctly source the class/function refernced within the modules (inconsisent with unittest). The following works great:
# pip install apprise
# All versions of Python correctly respect module definitions here.
from apprise import Apprise
# Do our magic with it.
obj = Apprise()
After Thoughts
At first I thought there was an issue with py.test but since Pytest v8.1.1 works in Python v3.10 but not in Python v3.11 or v3.12, I decided to open the ticket here. But the issue seems to be related to unittest.mock.patch and centers around Python v3.11 and higher.
Personally, I feel I've exhausted all avenues with my own research, so hopefully you can help me share what could have been introduced. Any tips/help would be much appreciated. 🙏
CPython versions tested on:
3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12
- bolded are impacted by issue.
Operating systems tested on:
Linux
Linked PRs
- gh-118176
- gh-118432
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Reproduziere das Verhalten mit unittest.mock.patch anhand des Apprise-Beispiels und vergleiche die im verlinkten Projekt und im GitHub Actions-Lauf gezeigten Ergebnisse von Python 3.10, 3.11 und 3.12. Lies apprise/init.py und den Einstiegspunkt für die Auflösung des Patch-Ziels und prüfe anschließend die verlinkten PRs gh-118176 und gh-118432. Erledigt ist die Aufgabe, wenn das beabsichtigte Verhalten des Patch-Ziels über die gemeldeten Python-Versionen hinweg festgestellt und durch Regressionstests abgedeckt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- testing-qa
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100