Repository navigation
Expand file tree
/
Copy pathcheck_system_python.py
More file actions
executable file
·348 lines (305 loc) · 11.8 KB
/
Copy pathcheck_system_python.py
File metadata and controls
executable file
·348 lines (305 loc) · 11.8 KB
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
#!/usr/bin/env python3
"""Install `pylint` and packages with native extensions into the system Python.
To run locally, create a venv with seed packages.
"""
import argparse
import logging
import os
import shutil
import subprocess
import sys
import tempfile
from pathlib import Path
from typing import Optional
logger = logging.getLogger(__name__)
def install_package(
*,
uv: str,
package: str,
version: Optional[str] = None,
path: Optional[Path] = None,
import_check: Optional[str] = None,
):
"""Install a package into the system Python."""
if path is not None:
requirement = str(path)
elif version is not None:
requirement = f"{package}=={version}"
else:
requirement = package
logger.info(f"Installing the package `{requirement}`.")
subprocess.run(
[uv, "pip", "install", requirement, "--system"] + allow_externally_managed,
cwd=temp_dir,
check=True,
)
logger.info(f"Checking that `{package}` can be imported with `{sys.executable}`.")
code = subprocess.run(
[sys.executable, "-c", import_check or f"import {package}"],
cwd=temp_dir,
check=False,
)
if code.returncode != 0:
raise RuntimeError(f"Could not import {package}.")
code = subprocess.run([uv, "pip", "show", package, "--system"], check=False)
if code.returncode != 0:
raise RuntimeError(f"Could not show {package}.")
def install_native_extension(*, uv: str):
"""Build, install, and run a small native extension with the system Python."""
fixture = Path(__file__).resolve().parents[1] / "test/packages/native_extension"
path = Path(temp_dir) / "native_extension"
shutil.copytree(fixture, path)
install_package(
uv=uv,
package="uv_test_native_extension",
path=path,
import_check=(
"import uv_test_native_extension as extension; "
"assert extension.answer() == 42"
),
)
if __name__ == "__main__":
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
parser = argparse.ArgumentParser(description="Check a Python interpreter.")
parser.add_argument("--uv", help="Path to a uv binary.")
parser.add_argument(
"--externally-managed",
action="store_true",
help="Set if the Python installation has an EXTERNALLY-MANAGED marker.",
)
parser.add_argument(
"--python",
required=False,
help="Set if the system Python version must be explicitly specified, e.g., for prereleases.",
)
parser.add_argument(
"--check-python-version",
required=False,
help="Verify that this tool has been started with the specified python version. Omitting the patch number will match any patch number.",
)
parser.add_argument(
"--check-path",
required=False,
action="store_true",
help="Attempt to verify that the PATH is set up so that this tool's python will match the python version that uv would automatically pick up.",
)
args = parser.parse_args()
uv: str = os.path.abspath(args.uv) if args.uv else "uv"
allow_externally_managed = (
["--break-system-packages"] if args.externally_managed else []
)
python = ["--python", args.python] if args.python else []
# Pin packages to the last versions that support older Python interpreters.
if sys.version_info < (3, 7):
pylint_version = "2.12.2"
pydantic_core_version = None
elif sys.version_info < (3, 8):
pylint_version = "2.17.7"
pydantic_core_version = "2.14.6"
else:
pylint_version = None
pydantic_core_version = None
pylint_requirement = (
f"pylint=={pylint_version}" if pylint_version is not None else "pylint"
)
if args.check_python_version:
version = ".".join(map(str, sys.version_info[:3]))
if args.check_python_version != version and not version.startswith(
args.check_python_version + "."
):
raise RuntimeError(
f"Expected to be running {args.check_python_version} but we are on {version}."
)
if args.check_path:
process = subprocess.run(
[
"python",
"-c",
"import os, sys; sys.stdout.buffer.write(os.fsencode(sys.executable))",
],
check=True,
stdout=subprocess.PIPE,
)
system_python_path = os.path.normcase(
os.path.normpath(os.fsdecode(process.stdout))
)
our_python_path = os.path.normcase(os.path.normpath(sys.executable))
if our_python_path != system_python_path:
raise RuntimeError(
f"Script was ran with {our_python_path} but `python` resolves to {system_python_path}"
)
# Ensure that pip is available (e.g., the Chainguard distroless image ships
# Python but not pip).
try:
import pip # noqa: F401
except ModuleNotFoundError:
logger.info("pip not found, running ensurepip...")
subprocess.run(
[sys.executable, "-m", "ensurepip"],
check=True,
)
# Create a temporary directory.
with tempfile.TemporaryDirectory() as temp_dir:
# Ensure that the package (`pylint`) isn't installed.
logger.info("Checking that `pylint` isn't installed.")
code = subprocess.run(
[sys.executable, "-m", "pip", "show", "pylint"],
cwd=temp_dir,
check=False,
)
if code.returncode == 0:
raise RuntimeError("The package `pylint` is installed (but shouldn't be).")
# Install the package (`pylint`).
logger.info("Installing the package `pylint`.")
subprocess.run(
[uv, "pip", "install", pylint_requirement, "--system", "--verbose"]
+ allow_externally_managed
+ python,
cwd=temp_dir,
check=True,
)
# Ensure that the package (`pylint`) is installed.
logger.info(
f"Checking that `pylint` is installed with `{sys.executable} -m pip`."
)
code = subprocess.run(
[sys.executable, "-m", "pip", "show", "pylint"],
cwd=temp_dir,
check=False,
)
if code.returncode != 0:
raise RuntimeError("The package `pylint` isn't installed (but should be).")
logger.info("Checking that `pylint` is in the path.")
if shutil.which("pylint") is None:
raise RuntimeError("The package `pylint` isn't in the path.")
# Uninstall the package (`pylint`).
logger.info("Uninstalling the package `pylint`.")
subprocess.run(
[uv, "pip", "uninstall", "pylint", "--system"]
+ allow_externally_managed
+ python,
cwd=temp_dir,
check=True,
)
# Ensure that the package (`pylint`) isn't installed.
logger.info("Checking that `pylint` isn't installed.")
code = subprocess.run(
[sys.executable, "-m", "pip", "show", "pylint"],
cwd=temp_dir,
check=False,
)
if code.returncode == 0:
raise RuntimeError("The package `pylint` is installed (but shouldn't be).")
# Create a virtual environment with `uv`.
logger.info("Creating virtual environment with `uv`...")
subprocess.run(
[uv, "venv", ".venv", "--seed", "--python", sys.executable],
cwd=temp_dir,
check=True,
)
if os.name == "nt":
executable = os.path.join(temp_dir, ".venv", "Scripts", "python.exe")
else:
executable = os.path.join(temp_dir, ".venv", "bin", "python")
logger.info("Querying virtual environment...")
subprocess.run(
[executable, "--version"],
cwd=temp_dir,
check=True,
)
logger.info("Installing into `uv` virtual environment...")
# Disable the `CONDA_PREFIX` and `VIRTUAL_ENV` environment variables, so that
# we only rely on virtual environment discovery via the `.venv` directory.
# Our "system Python" here might itself be a Conda environment!
env = os.environ.copy()
env["CONDA_PREFIX"] = ""
env["VIRTUAL_ENV"] = ""
subprocess.run(
[uv, "pip", "install", pylint_requirement, "--verbose"],
cwd=temp_dir,
check=True,
env=env,
)
# Ensure that the package (`pylint`) isn't installed globally.
logger.info("Checking that `pylint` isn't installed.")
code = subprocess.run(
[sys.executable, "-m", "pip", "show", "pylint"],
cwd=temp_dir,
check=False,
)
if code.returncode == 0:
raise RuntimeError(
"The package `pylint` is installed globally (but shouldn't be)."
)
# Ensure that the package (`pylint`) is installed in the virtual environment.
logger.info("Checking that `pylint` is installed.")
code = subprocess.run(
[executable, "-m", "pip", "show", "pylint"],
cwd=temp_dir,
check=False,
)
if code.returncode != 0:
raise RuntimeError(
"The package `pylint` isn't installed in the virtual environment."
)
# Uninstall the package (`pylint`).
logger.info("Uninstalling the package `pylint`.")
subprocess.run(
[uv, "pip", "uninstall", "pylint", "--verbose"],
cwd=temp_dir,
check=True,
env=env,
)
# Ensure that the package (`pylint`) isn't installed in the virtual environment.
logger.info("Checking that `pylint` isn't installed.")
code = subprocess.run(
[executable, "-m", "pip", "show", "pylint"],
cwd=temp_dir,
check=False,
)
if code.returncode == 0:
raise RuntimeError(
"The package `pylint` is installed in the virtual environment (but shouldn't be)."
)
# Build and import a native extension on interpreters with build tools in CI.
if sys.version_info < (3, 13) and sys.implementation.name != "graalpy":
install_native_extension(uv=uv)
# Attempt to install `pydantic_core`.
# This ensures that we can successfully install and recognize a package that may
# be installed into `platlib`.
#
# `pydantic_core` doesn't distribute wheels for non-CPython interpreters, nor
# for Python 3.13 (at time of writing).
if (
sys.version_info >= (3, 7)
and sys.version_info < (3, 13)
and sys.implementation.name == "cpython"
):
install_package(
uv=uv, package="pydantic_core", version=pydantic_core_version
)
# Next, create a virtual environment with `venv`, to ensure that `uv` can
# interoperate with `venv` virtual environments.
shutil.rmtree(os.path.join(temp_dir, ".venv"))
logger.info("Creating virtual environment with `venv`...")
subprocess.run(
[sys.executable, "-m", "venv", ".venv"],
cwd=temp_dir,
check=True,
)
# Install the package (`pylint`) into the virtual environment.
logger.info("Installing into `venv` virtual environment...")
subprocess.run(
[uv, "pip", "install", pylint_requirement, "--verbose"],
cwd=temp_dir,
check=True,
env=env,
)
# Uninstall the package (`pylint`).
logger.info("Uninstalling the package `pylint`.")
subprocess.run(
[uv, "pip", "uninstall", "pylint", "--verbose"],
cwd=temp_dir,
check=True,
env=env,
)