`PyImport_CreateModuleFromInitfunc()`: wrong `__name__` for submodules, non-ASCII names rejected, inittab name clashes
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
Bug report
Bug description:
Since PyImport_CreateModuleFromInitfunc() was added (in 3.15, gh-116146), I ran into some issues from real world use internally at Meta (with 3.15+, as well as our 3.14 fork, which has this backported). Collected here as a single issue for convenience - let me know if splitting is preferred.
The API is built on the internal create_builtin() helper, and inherits a few inittab behaviors that don't make sense for an explicitly-passed init function.
- Single-phase submodules get the short name. The package context is never set while
initfuncruns, so a single-phase init that creates its module assub(what pybind11'sPYBIND11_MODULE(sub, m)does) ends up with__name__ == 'sub'while the spec sayspkg.sub. The original impl handled that, but it was lost somewhere on the way. - Non-ASCII spec names raise
UnicodeEncodeError, even for multi-phase modules, which the dynamic loader accepts. - Names registered in
PyImport_Inittabare handled silently. Depending on the state of the builtin,initfuncis ignored, or the module created here replaces the builtin for later imports, or (multi-phase builtin)initfunc's module overwrites the real one insys.modules.sysandbuiltinsfall in the first bucket. - Undocumented semantics. Single-phase modules are added to
sys.modulesby the call itself, multi-phase ones aren't. The spec name is the module's identity, so a second call with the same name and a differentinitfuncreturns the cached module and never calls the new function.
The existing test only covers one top-level single-phase and one top-level multi-phase module, so none of this was caught.
AI disclosure: I ran into the first issue in production, used Claude Opus 5 and Fable 5.1 to root cause, which flagged the other issues while investigating. Fable 5.1 prepared the fixes.
Demo output before any fix:
pkg.sub: repr=<module 'sub'> __name__=sub
non-ASCII name: UnicodeEncodeError: 'ascii' codec can't encode character '\xf6'
same name, initfunc B after A: which=A calls_a=1 calls_b=0
'_random' via custom initfunc, then `import _random`: <module 'same'> hasattr(Random)=False
Tests demonstrating all of the above: https://github.com/itamaro/cpython/tree/gh-116146-initfunc-tests-only
Plan
One PR each:
- Set the package context while calling
initfunc, like the dynamic loader does (1) - Accept non-ASCII names for multi-phase init; single-phase gets the same
SystemErroras dynamic loading (2) - Raise
ImportErrorfor names registered inPyImport_Inittab(3) - Document the
sys.modulesand name-identity behavior (4)
CPython versions tested on:
CPython main branch, 3.15
Operating systems tested on:
Linux, macOS
Linked PRs
- gh-157387
- gh-157388
- gh-157389
- gh-157390
- gh-157758
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 PyImport_CreateModuleFromInitfunc()、现有的顶层单阶段和多阶段模块测试,以及链接的 gh-116146-initfunc-tests-only 测试分支开始。将其行为与 PyImport_Inittab 和动态加载器进行比较。完成的标准是四个检查项都已处理,包括对 sys.modules 和名称同一性语义的文档说明;链接的 PR gh-157387 至 gh-157390 以及 gh-157758 表明相关工作已经在进行中。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- backend
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100