unittest.mock.patch('path') neither forwards or backwards compatible starting from Python >= v3.11
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
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
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
使用 Apprise 範例透過 unittest.mock.patch 重現該行為,並比較連結專案和 GitHub Actions 執行中顯示的 Python 3.10、3.11 和 3.12 結果。閱讀 apprise/init.py 和 patch 目標解析的進入點,然後檢視連結的 PR gh-118176 和 gh-118432。當已在所回報的 Python 版本中確立預期的 patch 目標行為,並具備回歸測試涵蓋時,即視為完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- testing-qa
- Issue 類型
- 缺陷
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 30/100