`PyImport_CreateModuleFromInitfunc()`: wrong `__name__` for submodules, non-ASCII names rejected, inittab name clashes
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con PyImport_CreateModuleFromInitfunc(), las pruebas existentes para módulos de nivel superior de una y varias fases, y la rama de pruebas vinculada gh-116146-initfunc-tests-only. Compara su comportamiento con PyImport_Inittab y el cargador dinámico. Se considera terminado cuando se hayan abordado los cuatro elementos de la lista de comprobación, incluida la semántica documentada de sys.modules y de la identidad de nombres; los PR vinculados gh-157387 a gh-157390 y gh-157758 muestran que el trabajo ya está en marcha.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- backend
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100