python / python/cpython

unittest.mock.patch('path') neither forwards or backwards compatible starting from Python >= v3.11

未关闭
#117,860 13 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

topic-importlib type-bug
主要语言
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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 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

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。