Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for --system-site-packages in uv venv #2101

Merged
merged 1 commit into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion crates/gourgeist/src/bare.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ pub fn create_bare_venv(
location: &Utf8Path,
interpreter: &Interpreter,
prompt: Prompt,
system_site_packages: bool,
extra_cfg: Vec<(String, String)>,
) -> Result<VenvPaths, Error> {
// We have to canonicalize the interpreter path, otherwise the home is set to the venv dir instead of the real root.
Expand Down Expand Up @@ -251,7 +252,11 @@ pub fn create_bare_venv(
),
(
"include-system-site-packages".to_string(),
"false".to_string(),
if system_site_packages {
"true".to_string()
} else {
"false".to_string()
},
),
(
"base-prefix".to_string(),
Expand Down
9 changes: 8 additions & 1 deletion crates/gourgeist/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,19 @@ pub fn create_venv(
location: &Path,
interpreter: Interpreter,
prompt: Prompt,
system_site_packages: bool,
extra_cfg: Vec<(String, String)>,
) -> Result<PythonEnvironment, Error> {
let location: &Utf8Path = location
.try_into()
.map_err(|err: FromPathError| err.into_io_error())?;
let paths = create_bare_venv(location, &interpreter, prompt, extra_cfg)?;
let paths = create_bare_venv(
location,
&interpreter,
prompt,
system_site_packages,
extra_cfg,
)?;
Ok(PythonEnvironment::from_interpreter(
interpreter,
paths.root.as_std_path(),
Expand Down
3 changes: 3 additions & 0 deletions crates/gourgeist/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ struct Cli {
python: Option<String>,
#[clap(long)]
prompt: Option<String>,
#[clap(long)]
system_site_packages: bool,
}

fn run() -> Result<(), gourgeist::Error> {
Expand All @@ -45,6 +47,7 @@ fn run() -> Result<(), gourgeist::Error> {
&location,
&interpreter,
Prompt::from_args(cli.prompt),
cli.system_site_packages,
Vec::new(),
)?;
Ok(())
Expand Down
1 change: 1 addition & 0 deletions crates/uv-build/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@ impl SourceBuild {
&temp_dir.path().join(".venv"),
interpreter.clone(),
gourgeist::Prompt::None,
false,
Vec::new(),
)?;

Expand Down
5 changes: 4 additions & 1 deletion crates/uv/src/commands/venv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ pub(crate) async fn venv(
python_request: Option<&str>,
index_locations: &IndexLocations,
prompt: Prompt,
system_site_packages: bool,
connectivity: Connectivity,
seed: bool,
exclude_newer: Option<DateTime<Utc>>,
Expand All @@ -45,6 +46,7 @@ pub(crate) async fn venv(
python_request,
index_locations,
prompt,
system_site_packages,
connectivity,
seed,
exclude_newer,
Expand Down Expand Up @@ -87,6 +89,7 @@ async fn venv_impl(
python_request: Option<&str>,
index_locations: &IndexLocations,
prompt: Prompt,
system_site_packages: bool,
connectivity: Connectivity,
seed: bool,
exclude_newer: Option<DateTime<Utc>>,
Expand Down Expand Up @@ -123,7 +126,7 @@ async fn venv_impl(
let extra_cfg = vec![("uv".to_string(), env!("CARGO_PKG_VERSION").to_string())];

// Create the virtual environment.
let venv = gourgeist::create_venv(path, interpreter, prompt, extra_cfg)
let venv = gourgeist::create_venv(path, interpreter, prompt, system_site_packages, extra_cfg)
.map_err(VenvError::Creation)?;

// Install seed packages.
Expand Down
11 changes: 11 additions & 0 deletions crates/uv/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -936,6 +936,16 @@ struct VenvArgs {
#[clap(long, verbatim_doc_comment)]
prompt: Option<String>,

/// Give the virtual environment access to the system site packages directory.
///
/// Unlike `pip`, when a virtual environment is created with `--system-site-packages`, `uv` will
/// _not_ take system site packages into account when running commands like `uv pip list` or
/// `uv pip install`. The `--system-site-packages` flag will provide the virtual environment
/// with access to the system site packages directory at runtime, but it will not affect the
/// behavior of `uv` commands.
#[clap(long)]
system_site_packages: bool,

/// The URL of the Python package index (by default: <https://pypi.org/simple>).
///
/// The index given by this flag is given lower priority than all other
Expand Down Expand Up @@ -1388,6 +1398,7 @@ async fn run() -> Result<ExitStatus> {
args.python.as_deref(),
&index_locations,
gourgeist::Prompt::from_args(prompt),
args.system_site_packages,
if args.offline {
Connectivity::Offline
} else {
Expand Down