Bug report
Bug description:
Context: In Python 3.12 the function importlib.resources.files() was updated:
https://docs.python.org/3/library/importlib.resources.html#importlib.resources.files
Changed in version 3.12: package parameter was renamed to anchor. anchor can now be a non-package module and if omitted will default to the caller’s module. package is still accepted for compatibility but will raise a
. Consider passing the anchor positionally or using importlib_resources >= 5.10 for a compatible interface on older Pythons.
The Issue: When using importlib.resources.files(), I am able to open and read a text file included as package data in my package. However, if I zip up my package with zipapp and run the .pyz file, it is unable to read the text file.
If I use importlib.resources.files("mypkg") it will work in both cases.
Minimal example:
Create a project directory named mypkg with the
.
Create the following files.
mypkg/src/mypkg/a.py
importimportlib.resourcesdefmain(): x=importlib.resources.files() /"data.txt"print(x.read_text())mypkg/src/mypkg/data.txt
datadata In pyproject.toml make sure to set up the entry script and include the data file.
mypkg/pyproject.toml
[project.scripts] myscript = "mypkg.a:main" [tool.setuptools.package-data] mypkg = ["*.txt"] Install the package into a fresh Python (virtual) environment with pip.
Run myscript and verify it prints datadata.
Now back in the mypkg project root folder, we will generate a .pyz file with zipapp and run the program from the .pyz file.
Run pip install . --target buildtemp --upgrade && python3 -m zipapp buildtemp --main mypkg.a:main -p '/usr/bin/env python3' -o mypkg.pyz in the terminal.
Run ./mypkg.pyz. This results in an error:
Traceback (most recent call last): File "<frozen runpy>", line 198, in _run_module_as_main File "<frozen runpy>", line 88, in _run_code File "/home/win/code/sandbox/python/mypkg/./mypkg.pyz/__main__.py", line 3, in <module> File "/home/win/code/sandbox/python/mypkg/./mypkg.pyz/mypkg/a.py", line 6, in main File "/home/win/.local/share/mise/installs/python/3.12.4/lib/python3.12/importlib/resources/abc.py", line 89, in read_text with self.open(encoding=encoding) as strm: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/win/.local/share/mise/installs/python/3.12.4/lib/python3.12/importlib/resources/_adapters.py", line 139, in open raise FileNotFoundError("Can't open orphan path") FileNotFoundError: Can't open orphan path Note that if you change x = importlib.resources.files() / "data.txt" to x = importlib.resources.files("mypkg") / "data.txt", it will work when running the .pyz file.
CPython versions tested on:
3.12
Operating systems tested on:
Linux, macOS
Linked PRs
gh-121735: Fix module-adjacent references in zip files #123037
[3.13] gh-121735: Fix module-adjacent references in zip files (GH-123037) #123986
[3.12] gh-121735: Fix module-adjacent references in zip files (gh-123037) #124011