-
Notifications
You must be signed in to change notification settings - Fork 57
Expand file tree
/
Copy pathinstallPythonDependencies.ts
More file actions
224 lines (202 loc) · 6.77 KB
/
Copy pathinstallPythonDependencies.ts
File metadata and controls
224 lines (202 loc) · 6.77 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
import { existsSync, readFileSync } from "node:fs";
import { join } from "node:path";
import { log } from "../utils/cli.ts";
import { filterEnvForUntrustedCode } from "../utils/secrets.ts";
import { spawn } from "../utils/subprocess.ts";
import type {
PrepDefinition,
PrepOptions,
PythonPackageManager,
PythonPrepResult,
} from "./types.ts";
interface PythonConfig {
file: string;
tool: PythonPackageManager;
installCmd: string[];
/** extra applicability check beyond file existence (defaults to always applies). */
applies?: (path: string) => boolean;
}
/**
* heuristic proxy for "this pyproject.toml is a distributable package."
*
* `[build-system]` is NOT a pip requirement — pip treats a pyproject without it
* as the legacy `setuptools.build_meta:__legacy__` backend and proceeds. but
* modern scaffolds (hatchling/flit/poetry-core/setuptools>=61) all emit
* `[build-system]`, so its presence is a good signal. gating on it trades a rare
* false-negative (a hand-written PEP 621 package that omits `[build-system]` is
* skipped) to kill the common false-positive: a tooling-only pyproject (ruff/mypy,
* PEP 735 dependency groups under uv) where `pip install .` triggers setuptools
* flat-layout auto-discovery and hard-fails on a non-package repo like hey-api
* (root holds web/, packages/, node_modules/).
*/
function declaresBuildSystem(path: string): boolean {
return /^\s*\[\s*build-system\s*\]/m.test(readFileSync(path, "utf8"));
}
function configApplies(config: PythonConfig, cwd: string): boolean {
const path = join(cwd, config.file);
return existsSync(path) && (config.applies?.(path) ?? true);
}
// python dependency file patterns in priority order
const PYTHON_CONFIGS: PythonConfig[] = [
{
file: "requirements.txt",
tool: "pip",
installCmd: ["pip", "install", "-r", "requirements.txt"],
},
{
file: "pyproject.toml",
tool: "pip",
installCmd: ["pip", "install", "."],
applies: declaresBuildSystem,
},
{
file: "Pipfile",
tool: "pipenv",
installCmd: ["pipenv", "install"],
},
{
file: "Pipfile.lock",
tool: "pipenv",
installCmd: ["pipenv", "sync"],
},
{
file: "poetry.lock",
tool: "poetry",
installCmd: ["poetry", "install", "--no-interaction"],
},
{
file: "setup.py",
tool: "pip",
installCmd: ["pip", "install", "-e", "."],
},
];
// tool install commands (via pip)
const TOOL_INSTALL_COMMANDS: Record<string, string[]> = {
pipenv: ["pip", "install", "pipenv"],
poetry: ["pip", "install", "poetry"],
};
async function isCommandAvailable(command: string): Promise<boolean> {
const result = await spawn({
cmd: "which",
args: [command],
env: filterEnvForUntrustedCode(),
});
return result.exitCode === 0;
}
async function installTool(name: string): Promise<string | null> {
const installCmd = TOOL_INSTALL_COMMANDS[name];
if (!installCmd) {
// tool doesn't need installation (e.g., pip)
return null;
}
log.info(`» installing ${name}...`);
const [cmd, ...args] = installCmd;
const result = await spawn({
cmd,
args,
env: filterEnvForUntrustedCode(),
onStderr: (chunk) => process.stderr.write(chunk),
});
if (result.exitCode !== 0) {
return result.stderr || `failed to install ${name}`;
}
log.info(`» installed ${name}`);
return null;
}
export const installPythonDependencies: PrepDefinition = {
name: "installPythonDependencies",
shouldRun: async () => {
// check if python is available
const hasPython = (await isCommandAvailable("python3")) || (await isCommandAvailable("python"));
if (!hasPython) {
return false;
}
// check if any applicable python config file exists
const cwd = process.cwd();
return PYTHON_CONFIGS.some((config) => configApplies(config, cwd));
},
run: async (options: PrepOptions): Promise<PythonPrepResult> => {
const cwd = process.cwd();
// find the first applicable config
const config = PYTHON_CONFIGS.find((c) => configApplies(c, cwd));
if (!config) {
return {
language: "python",
packageManager: "pip",
configFile: "unknown",
dependenciesInstalled: false,
issues: ["no python config file found"],
};
}
log.info(`» detected python config: ${config.file} (using ${config.tool})`);
// SECURITY: when shell is disabled, skip ALL python dependency installation.
// every python install path can potentially execute arbitrary code:
// - setup.py / pyproject.toml: directly execute build backends
// - requirements.txt: can contain "-e ." or local path references that
// trigger setup.py execution
// - Pipfile/poetry.lock: can contain path dependencies pointing to local
// directories with malicious setup.py
// - source distributions from PyPI also execute setup.py
// there is no equivalent of npm's --ignore-scripts for pip.
if (options.ignoreScripts) {
log.info(
`» skipping python install (shell disabled, python packages can execute arbitrary code)`
);
return {
language: "python",
packageManager: config.tool,
configFile: config.file,
dependenciesInstalled: false,
issues: [
`skipped: python dependency installation can execute arbitrary code (setup.py, build backends, local path references), which is blocked when shell is disabled`,
],
};
}
// check if the tool is available, install if needed
const isAvailable = await isCommandAvailable(config.tool);
if (!isAvailable) {
log.info(`» ${config.tool} not found, attempting to install...`);
const installError = await installTool(config.tool);
if (installError) {
return {
language: "python",
packageManager: config.tool,
configFile: config.file,
dependenciesInstalled: false,
issues: [installError],
};
}
}
// run the install command
const [cmd, ...args] = config.installCmd;
const fullCommand = `${cmd} ${args.join(" ")}`;
log.info(`» running: ${fullCommand}`);
const result = await spawn({
cmd,
args,
env: filterEnvForUntrustedCode(),
});
const output = [result.stdout, result.stderr].filter(Boolean).join("\n").trim();
if (output) {
log.startGroup(`${fullCommand} output`);
log.info(output);
log.endGroup();
}
if (result.exitCode !== 0) {
return {
language: "python",
packageManager: config.tool,
configFile: config.file,
dependenciesInstalled: false,
issues: [output || `${cmd} exited with code ${result.exitCode}`],
};
}
return {
language: "python",
packageManager: config.tool,
configFile: config.file,
dependenciesInstalled: true,
issues: [],
};
},
};