Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use path file instead of `sitecustomize.py` (#7161) 

## Summary

Use a path file (`.pth`) instead of `sitecustomize.py` for configuring
path in emphemeral virtualenvs, overlaying the ephemeral venv on top of
the base `.venv`.

`sitecustomize.py` is a module in the python installation and as such a
unique resource - homebrew pythons on macos already install such a file
and thus uv's `sitecustomize.py`, placed in the ephemeral env, did not
have any effect.

I don't find any documentation explicitly saying that addsitedir is
valid in `.pth` files but from trial it seems to be - and there is the
precedent of the existing _virtualenv.pth _virtualenv.py pair that do
nontrivial operations.

## Test Plan

- Testing on ephemeral venv, resolving to base venv including editable
install in base: done (py3.7, 3.12)
- Testing on homebrew python/macos: done (py3.11)
- tests: run_editable

Fixes #7152
This commit is contained in:
bluss 2024-09-09 15:19:55 +02:00 committed by GitHub
parent 947619657c
commit fdde92b539
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/uv/src/commands/project/run.rs
View File

@ -612,9 +612,11 @@ pub(crate) async fn run(
}) })
}; };
// If we're running in an ephemeral environment, add a `sitecustomize.py` to enable loading of // If we're running in an ephemeral environment, add a path file to enable loading of
// the base environment's site packages. Setting `PYTHONPATH` is insufficient, as it doesn't // the base environment's site packages. Setting `PYTHONPATH` is insufficient, as it doesn't
// resolve `.pth` files in the base environment. // resolve `.pth` files in the base environment.
// And `sitecustomize.py` would be an alternative but it can be shadowed by an existing such
// module in the python installation.
if let Some(ephemeral_env) = ephemeral_env.as_ref() { if let Some(ephemeral_env) = ephemeral_env.as_ref() {
let ephemeral_site_packages = ephemeral_env let ephemeral_site_packages = ephemeral_env
.site_packages() .site_packages()
@ -626,7 +628,7 @@ pub(crate) async fn run(
.ok_or_else(|| anyhow!("Base environment has no site packages directory"))?; .ok_or_else(|| anyhow!("Base environment has no site packages directory"))?;
fs_err::write( fs_err::write(
ephemeral_site_packages.join("sitecustomize.py"), ephemeral_site_packages.join("_uv_ephemeral_overlay.pth"),
format!( format!(
"import site; site.addsitedir(\"{}\")", "import site; site.addsitedir(\"{}\")",
base_site_packages.escape_for_python() base_site_packages.escape_for_python()