1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
#-----------------------------------------------------------------------------
# Copyright (c) 2021-2023, PyInstaller Development Team.
#
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
#-----------------------------------------------------------------------------
#
# These tests run a test script (scripts/pyi_importlib_resources.py) in unfrozen and frozen form, in combination with
# a custom test package (modules/pyi_pkg_resources_provider/package). In contrast to test_pkg_resources_provider.py,
# only source package form is used (zipped egg form is nor tested).
#
# Running the unfrozen test script allows us to verify the behavior of importlib.resources (or its importlib_resources
# back-port for python 3.8 and earlier) and thereby also validate the test script itself. Running the frozen test
# validates the behavior of the resource reader provided by PyInstaller's PyiFrozenLoader.
#
# For details on the structure of the test and the contents of the test package, see the top comment in the test script
# itself.
import os
import pathlib
import pytest
from PyInstaller.utils.tests import skipif
from PyInstaller.compat import is_darwin, is_py39, is_py310, exec_python_rc
from PyInstaller.utils.hooks import check_requirement
pytestmark = [
skipif(
not is_py39 and not check_requirement('importlib_resources'),
reason="Python prior to 3.9 requires importlib_resources."
)
]
# Directory with testing modules used in some tests.
_MODULES_DIR = pathlib.Path(__file__).parent / 'modules'
def __exec_python_script(script_filename, pathex):
# Prepare the environment - default to 'os.environ'...
env = os.environ.copy()
# ... and prepend PYTHONPATH with pathex
if 'PYTHONPATH' in env:
pathex = os.pathsep.join([pathex, env['PYTHONPATH']])
env['PYTHONPATH'] = pathex
# Run the test script
return exec_python_rc(script_filename, env=env)
def test_importlib_resources_source(script_dir):
# Run the test script unfrozen - to validate it is working and to verify the behavior of importlib.resources
# (or importlib_resources back-port).
pathex = _MODULES_DIR / 'pyi_pkg_resources_provider' / 'package'
test_script = script_dir / 'pyi_importlib_resources.py'
ret = __exec_python_script(str(test_script), pathex=str(pathex))
assert ret == 0, "Test script failed!"
def test_importlib_resources_frozen(pyi_builder, script_dir):
# Run the test script as a frozen program
pathex = _MODULES_DIR / 'pyi_pkg_resources_provider' / 'package'
test_script = 'pyi_importlib_resources.py'
hooks_dir = _MODULES_DIR / 'pyi_pkg_resources_provider' / 'hooks'
pyi_args = [
'--paths', str(pathex),
'--hidden-import', 'pyi_pkgres_testpkg',
'--additional-hooks-dir', str(hooks_dir),
] # yapf: disable
if is_darwin:
pyi_args += ['--windowed'] # Also build and test .app bundle executable
pyi_builder.test_script(
test_script,
pyi_args=pyi_args,
)
# A separate test for verifying that `importlib.resources.files()` works with PEP-420 namespace packages. See #7921.
# The sub-directory containing the data files is also a PEP-410 namespace (sub)package. However, in the context of
# PyInstaller, there are actually two slightly different possibilities:
# - if we collect only the data files, and the namespace package itself is not collected into PYZ, the situation is
# the same as in unfrozen python - python's built-in import machinery takes care of the namespace package and the
# associated resource reader.
# - if the namespace package is collected into PYZ (in addition to resources being collected as data files), the
# namespace package ends up being handled by PyInstaller's `PyiFrozenFinder`, which requires extra care to ensure
# compatibility with `importlib` resource reader.
# The test covers both scenarios via `as_package` parameter.
#
# NOTE: the handling of resources in PEP-420 namespace packages as expected by this test was introduced in stdlib
# version of `importlib.resources` in python 3.10 (equivalent of importlib-resources >= 5.0).
@pytest.mark.parametrize('as_package', [True, False])
@skipif(
not is_py310 and not check_requirement('importlib_resources >= 5.0'),
reason="Requires python <= 3.10 or importlib_resources >= 5.0."
)
def test_importlib_resources_namespace_package_data_files(pyi_builder, as_package):
pathex = _MODULES_DIR / 'pyi_namespace_package_with_data' / 'package'
hooks_dir = _MODULES_DIR / 'pyi_namespace_package_with_data' / 'hooks'
if as_package:
hidden_imports = ['--hidden-import', 'pyi_test_nspkg', '--hidden-import', 'pyi_test_nspkg.data']
else:
hidden_imports = ['--hidden-import', 'pyi_test_nspkg']
pyi_args = [
'--paths', str(pathex),
*hidden_imports,
'--additional-hooks-dir', str(hooks_dir),
] # yapf: disable
if is_darwin:
pyi_args += ['--windowed'] # Also build and test .app bundle executable
pyi_builder.test_source(
"""
import importlib
try:
import importlib_resources
except ModuleNotFoundError:
import importlib.resources as importlib_resources
# Get the package's directory (= our data directory)
data_dir = importlib_resources.files("pyi_test_nspkg.data")
# Sanity check; verify the directory's base name
assert data_dir.name == "data"
# Check that data files exist
assert (data_dir / "data_file1.txt").is_file()
assert (data_dir / "data_file2.txt").is_file()
assert (data_dir / "data_file3.txt").is_file()
# Force cache invalidation and check again.
importlib.invalidate_caches()
data_dir = importlib_resources.files("pyi_test_nspkg.data")
assert (data_dir / "data_file1.txt").is_file()
""",
pyi_args=pyi_args,
)
|
