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

Add support for `venv --prompt` (#1570) 

## Summary

This PR adds the `--prompt` option to `venv` subcommand.

The default behavior for `uv venv` is to create a virtual environment in
the current directory with `.venv` name. This is different from `venv` /
`virtualenv` where a user always needs to provide the virtual
environment path. This allows us to define our own behavior in the
default scenario (`uv venv`). We've decided to use the current
directory's name in that case.

Workflows:
| Command | Virtual Environment Name | Prompt |
|--------|--------|--------|
| `uv venv` | `.venv` (default) | Current directory name |
| `uv venv project` | `project` | `project` |
| `uv venv --prompt .` | `.venv` | Current directory name |
| `uv venv --prompt foobar` | `.venv` | `foobar` | 
| `uv venv project --prompt foobar` | `project` | `foobar` | 


Fixes #1445

## Test Plan

This is my first Rust code and I don't know how to write tests yet.
I just checked the behavior manually:

```
$ cargo build
$ mkdir t
$ cd t
$ ../target/debug/uv venv -p 3.11
$ rg -w t .venv/bin/acti*
.venv/bin/activate.csh
13:setenv VIRTUAL_ENV '/Users/inada-n/work/uv/t/.venv'
20:if ('t' != "") then
21:    setenv VIRTUAL_ENV_PROMPT 't'
23:    setenv VIRTUAL_ENV_PROMPT "$VIRTUAL_ENV:t:q"
38:    # in which case, $prompt is undefined and we wouldn't

.venv/bin/activate
48:VIRTUAL_ENV='/Users/inada-n/work/uv/t/.venv'
59:    VIRTUAL_ENV_PROMPT="t"

.venv/bin/activate.fish
61:set -gx VIRTUAL_ENV '/Users/inada-n/work/uv/t/.venv'
73:if test -n 't'
74:    set -gx VIRTUAL_ENV_PROMPT 't'

.venv/bin/activate.ps1
40:if ("t" -ne "") {
41:    $env:VIRTUAL_ENV_PROMPT = "t"

.venv/bin/activate.nu
6:# but then simply `deactivate` won't work because it is just an alias to hide
35:    let virtual_env = '/Users/inada-n/work/uv/t/.venv'
50:    let virtual_env_prompt = (if ('t' | is-empty) {
53:        't'
```

---------

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
This commit is contained in:
Inada Naoki 2024-02-20 04:13:20 +09:00 committed by GitHub
parent cd1f619d21
commit 9efbc1fc25
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 106 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/gourgeist/src/activator/activate
View File

@ -76,8 +76,8 @@ _OLD_VIRTUAL_PATH="$PATH"
PATH="$VIRTUAL_ENV/{{ BIN_NAME }}:$PATH"
export PATH
if [ "x" != x ] ; then
VIRTUAL_ENV_PROMPT=""
if [ "x{{ VIRTUAL_PROMPT }}" != x ] ; then
VIRTUAL_ENV_PROMPT="{{ VIRTUAL_PROMPT }}"
else
VIRTUAL_ENV_PROMPT=$(basename "$VIRTUAL_ENV")
fi

4
crates/gourgeist/src/activator/activate.bat
View File

@ -21,7 +21,7 @@
@set "VIRTUAL_ENV={{ VIRTUAL_ENV_DIR }}"
@set "VIRTUAL_ENV_PROMPT=venv"
@set "VIRTUAL_ENV_PROMPT={{ VIRTUAL_PROMPT }}"
@if NOT DEFINED VIRTUAL_ENV_PROMPT (
@for %%d in ("%VIRTUAL_ENV%") do @set "VIRTUAL_ENV_PROMPT=%%~nxd"
)
@ -56,4 +56,4 @@
@set "_OLD_VIRTUAL_PATH=%PATH%"
:ENDIFVPATH2
@set "PATH=%VIRTUAL_ENV%\{{ BIN_NAME }};%PATH%"
@set "PATH=%VIRTUAL_ENV%\{{ BIN_NAME }};%PATH%"

4
crates/gourgeist/src/activator/activate.csh
View File

@ -38,8 +38,8 @@ setenv PATH "$VIRTUAL_ENV:q/{{ BIN_NAME }}:$PATH:q"
if ('' != "") then
setenv VIRTUAL_ENV_PROMPT ''
if ('{{ VIRTUAL_PROMPT }}' != "") then
setenv VIRTUAL_ENV_PROMPT '{{ VIRTUAL_PROMPT }}'
else
setenv VIRTUAL_ENV_PROMPT "$VIRTUAL_ENV:t:q"
endif

4
crates/gourgeist/src/activator/activate.fish
View File

@ -91,8 +91,8 @@ set -gx PATH "$VIRTUAL_ENV"'/{{ BIN_NAME }}' $PATH
# Prompt override provided?
# If not, just use the environment name.
if test -n ''
set -gx VIRTUAL_ENV_PROMPT ''
if test -n '{{ VIRTUAL_PROMPT }}'
set -gx VIRTUAL_ENV_PROMPT '{{ VIRTUAL_PROMPT }}'
else
set -gx VIRTUAL_ENV_PROMPT (basename "$VIRTUAL_ENV")
end

4
crates/gourgeist/src/activator/activate.nu
View File

@ -68,10 +68,10 @@ export-env {
let new_path = ($env | get $path_name | prepend $venv_path)
# If there is no default prompt, then use the env name instead
let virtual_env_prompt = (if ('' | is-empty) {
let virtual_env_prompt = (if ('{{ VIRTUAL_PROMPT }}' | is-empty) {
($virtual_env | path basename)
} else {
''
'{{ VIRTUAL_PROMPT }}'
})
let new_env = {

4
crates/gourgeist/src/activator/activate.ps1
View File

@ -58,8 +58,8 @@ deactivate -nondestructive
$VIRTUAL_ENV = $BASE_DIR
$env:VIRTUAL_ENV = $VIRTUAL_ENV
if ("" -ne "") {
$env:VIRTUAL_ENV_PROMPT = ""
if ("{{ VIRTUAL_PROMPT }}" -ne "") {
$env:VIRTUAL_ENV_PROMPT = "{{ VIRTUAL_PROMPT }}"
}
else {
$env:VIRTUAL_ENV_PROMPT = $( Split-Path $env:VIRTUAL_ENV -Leaf )

28
crates/gourgeist/src/bare.rs
View File

@ -1,5 +1,6 @@
//! Create a bare virtualenv without any packages install
use std::env;
use std::env::consts::EXE_SUFFIX;
use std::io;
use std::io::{BufWriter, Write};
@ -11,6 +12,8 @@ use tracing::info;
use uv_interpreter::Interpreter;
use crate::Prompt;
/// The bash activate scripts with the venv dependent paths patches out
const ACTIVATE_TEMPLATES: &[(&str, &str)] = &[
("activate", include_str!("activator/activate")),
@ -29,10 +32,17 @@ const ACTIVATE_TEMPLATES: &[(&str, &str)] = &[
const VIRTUALENV_PATCH: &str = include_str!("_virtualenv.py");
/// Very basic `.cfg` file format writer.
fn write_cfg(f: &mut impl Write, data: &[(&str, String); 8]) -> io::Result<()> {
fn write_cfg(
f: &mut impl Write,
data: &[(&str, String); 8],
prompt: Option<String>,
) -> io::Result<()> {
for (key, value) in data {
writeln!(f, "{key} = {value}")?;
}
if let Some(prompt) = prompt {
writeln!(f, "prompt = {prompt}")?;
}
Ok(())
}
@ -58,7 +68,11 @@ pub struct VenvPaths {
}
/// Write all the files that belong to a venv without any packages installed.
pub fn create_bare_venv(location: &Utf8Path, interpreter: &Interpreter) -> io::Result<VenvPaths> {
pub fn create_bare_venv(
location: &Utf8Path,
interpreter: &Interpreter,
prompt: Prompt,
) -> io::Result<VenvPaths> {
// We have to canonicalize the interpreter path, otherwise the home is set to the venv dir instead of the real root.
// This would make python-build-standalone fail with the encodings module not being found because its home is wrong.
let base_python: Utf8PathBuf = fs_err::canonicalize(interpreter.sys_executable())?
@ -107,6 +121,13 @@ pub fn create_bare_venv(location: &Utf8Path, interpreter: &Interpreter) -> io::R
unimplemented!("Only Windows and Unix are supported")
};
let bin_dir = location.join(bin_name);
let prompt = match prompt {
Prompt::CurrentDirectoryName => env::current_dir()?
.file_name()
.map(|name| name.to_string_lossy().to_string()),
Prompt::Static(value) => Some(value),
Prompt::None => None,
};
// Add the CACHEDIR.TAG.
cachedir::ensure_tag(&location)?;
@ -164,6 +185,7 @@ pub fn create_bare_venv(location: &Utf8Path, interpreter: &Interpreter) -> io::R
let activator = template
.replace("{{ VIRTUAL_ENV_DIR }}", location.as_str())
.replace("{{ BIN_NAME }}", bin_name)
.replace("{{ VIRTUAL_PROMPT }}", prompt.as_deref().unwrap_or(""))
.replace(
"{{ RELATIVE_SITE_PACKAGES }}",
&format!(
@ -217,7 +239,7 @@ pub fn create_bare_venv(location: &Utf8Path, interpreter: &Interpreter) -> io::R
("base-executable", base_python.to_string()),
];
let mut pyvenv_cfg = BufWriter::new(File::create(location.join("pyvenv.cfg"))?);
write_cfg(&mut pyvenv_cfg, pyvenv_cfg_data)?;
write_cfg(&mut pyvenv_cfg, pyvenv_cfg_data, prompt)?;
drop(pyvenv_cfg);
let site_packages = if cfg!(unix) {

31
crates/gourgeist/src/lib.rs
View File

@ -23,12 +23,39 @@ pub enum Error {
Platform(#[from] PlatformError),
}
/// The value to use for the shell prompt when inside a virtual environment.
#[derive(Debug)]
pub enum Prompt {
/// Use the current directory name as the prompt.
CurrentDirectoryName,
/// Use the fixed string as the prompt.
Static(String),
/// Default to no prompt. The prompt is then set by the activator script
/// to the virtual environment's directory name.
None,
}
impl Prompt {
/// Determine the prompt value to be used from the command line arguments.
pub fn from_args(prompt: Option<String>) -> Self {
match prompt {
Some(prompt) if prompt == "." => Prompt::CurrentDirectoryName,
Some(prompt) => Prompt::Static(prompt),
None => Prompt::None,
}
}
}
/// Create a virtualenv.
pub fn create_venv(location: &Path, interpreter: Interpreter) -> Result<Virtualenv, Error> {
pub fn create_venv(
location: &Path,
interpreter: Interpreter,
prompt: Prompt,
) -> Result<Virtualenv, Error> {
let location: &Utf8Path = location
.try_into()
.map_err(|err: FromPathError| err.into_io_error())?;
let paths = create_bare_venv(location, &interpreter)?;
let paths = create_bare_venv(location, &interpreter, prompt)?;
Ok(Virtualenv::from_interpreter(
interpreter,
paths.root.as_std_path(),

6
crates/gourgeist/src/main.rs
View File

@ -11,7 +11,7 @@ use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::util::SubscriberInitExt;
use tracing_subscriber::{fmt, EnvFilter};
use gourgeist::{create_bare_venv, parse_python_cli};
use gourgeist::{create_bare_venv, parse_python_cli, Prompt};
use platform_host::Platform;
use uv_cache::Cache;
use uv_interpreter::Interpreter;
@ -21,6 +21,8 @@ struct Cli {
path: Option<Utf8PathBuf>,
#[clap(short, long)]
python: Option<Utf8PathBuf>,
#[clap(long)]
prompt: Option<String>,
}
fn run() -> Result<(), gourgeist::Error> {
@ -34,7 +36,7 @@ fn run() -> Result<(), gourgeist::Error> {
Cache::from_path(".gourgeist_cache")?
};
let info = Interpreter::query(python.as_std_path(), &platform, &cache).unwrap();
create_bare_venv(&location, &info)?;
create_bare_venv(&location, &info, Prompt::from_args(cli.prompt))?;
Ok(())
}

6
crates/uv-build/src/lib.rs
View File

@ -323,7 +323,11 @@ impl SourceBuild {
let pep517_backend = Self::get_pep517_backend(setup_py, &source_tree, &default_backend)
.map_err(|err| *err)?;
let venv = gourgeist::create_venv(&temp_dir.path().join(".venv"), interpreter.clone())?;
let venv = gourgeist::create_venv(
&temp_dir.path().join(".venv"),
interpreter.clone(),
gourgeist::Prompt::None,
)?;
// Setup the build environment.
let resolved_requirements = Self::get_resolved_requirements(

6
crates/uv/src/commands/venv.rs
View File

@ -11,6 +11,7 @@ use owo_colors::OwoColorize;
use thiserror::Error;
use distribution_types::{DistributionMetadata, IndexLocations, Name};
use gourgeist::Prompt;
use pep508_rs::Requirement;
use platform_host::Platform;
use uv_cache::Cache;
@ -31,6 +32,7 @@ pub(crate) async fn venv(
path: &Path,
python_request: Option<&str>,
index_locations: &IndexLocations,
prompt: Prompt,
connectivity: Connectivity,
seed: bool,
exclude_newer: Option<DateTime<Utc>>,
@ -41,6 +43,7 @@ pub(crate) async fn venv(
path,
python_request,
index_locations,
prompt,
connectivity,
seed,
exclude_newer,
@ -82,6 +85,7 @@ async fn venv_impl(
path: &Path,
python_request: Option<&str>,
index_locations: &IndexLocations,
prompt: Prompt,
connectivity: Connectivity,
seed: bool,
exclude_newer: Option<DateTime<Utc>>,
@ -115,7 +119,7 @@ async fn venv_impl(
.into_diagnostic()?;
// Create the virtual environment.
let venv = gourgeist::create_venv(path, interpreter).map_err(VenvError::Creation)?;
let venv = gourgeist::create_venv(path, interpreter, prompt).map_err(VenvError::Creation)?;
// Install seed packages.
if seed {

27
crates/uv/src/main.rs
View File

@ -49,6 +49,8 @@ mod logging;
mod printer;
mod requirements;
const DEFAULT_VENV_NAME: &str = ".venv";
#[derive(Parser)]
#[command(author, version, about)]
#[command(propagate_version = true)]
@ -652,9 +654,21 @@ struct VenvArgs {
seed: bool,
/// The path to the virtual environment to create.
#[clap(default_value = ".venv")]
#[clap(default_value = DEFAULT_VENV_NAME)]
name: PathBuf,
/// Provide an alternative prompt prefix for the virtual environment.
///
/// The default behavior depends on whether the virtual environment path is provided:
/// - If provided (`uv venv project`), the prompt is set to the virtual environment's directory name.
/// - If not provided (`uv venv`), the prompt is set to the current directory's name.
///
/// Possible values:
/// - `.`: Use the current directory name.
/// - Any string: Use the given string.
#[clap(long, verbatim_doc_comment)]
prompt: Option<String>,
/// The URL of the Python Package Index.
#[clap(long, short, default_value = IndexUrl::Pypi.as_str(), env = "UV_INDEX_URL")]
index_url: IndexUrl,
@ -1016,10 +1030,21 @@ async fn run() -> Result<ExitStatus> {
Vec::new(),
args.no_index,
);
// Since we use ".venv" as the default name, we use "." as the default prompt.
let prompt = args.prompt.or_else(|| {
if args.name == PathBuf::from(DEFAULT_VENV_NAME) {
Some(".".to_string())
} else {
None
}
});
commands::venv(
&args.name,
args.python.as_deref(),
&index_locations,
gourgeist::Prompt::from_args(prompt),
if args.offline {
Connectivity::Offline
} else {