Add the ability to specify --venv to change the location from .venv t…

…o the location of choice.

.gitignore

@@ -7,3 +7,4 @@ __pycache__
 .idea
 token.txt
 dist
+rye/tests/.*

docs/guide/commands/add.md

@@ -83,4 +83,6 @@ Added packagename @ file:///path/to/packagename as regular dependency
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with `-h`)

docs/guide/commands/build.md

@@ -54,4 +54,6 @@ By default you will find the artifacts in the `dist` folder.
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help

docs/guide/commands/fetch.md

@@ -56,4 +56,6 @@ $ rye fetch [email protected] --target-path=my-interpreter
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/fmt.md

@@ -70,4 +70,6 @@ rye fmt src/foo.py
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/install.md

@@ -73,4 +73,6 @@ $ pycowsay "Great Stuff"
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/lint.md

@@ -62,4 +62,6 @@ rye lint src/foo.py
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/list.md

@@ -26,4 +26,6 @@ Werkzeug==3.0.1
 
 * `--pyproject`: Use this `pyproject.toml` file
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/lock.md

@@ -40,4 +40,6 @@ Done!
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/make-req.md

@@ -35,4 +35,6 @@ flask @ git+https://github.com/pallets/flask@4df377cfbf
 
 * `--features <FEATURES>`: Adds a dependency with a specific feature
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/publish.md

@@ -48,4 +48,6 @@ $ rye publish dist/example-0.1.0.tar.gz
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/remove.md

@@ -36,4 +36,6 @@ Removed flask>=3.0.1
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/run.md

@@ -34,4 +34,6 @@ python3.9
 
 * `--pyproject`: Use this `pyproject.toml` file
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/show.md

@@ -29,4 +29,6 @@ virtual: false
 
 * `--pyproject`: Use this `pyproject.toml` file
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/sync.md

@@ -63,4 +63,6 @@ To exit the sub shell run `exit`.
 
 * `-q, --quiet`: Turns off all output
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/commands/test.md

@@ -55,4 +55,6 @@ stuff/tests/test_batch.py .                                            [100%]
 
 * `-s`, `--no-capture`: Disable stdout/stderr capture for the test runner
 
+* `--venv <VENV>`: Use this virtual environment
+
 * `-h, --help`: Print help (see a summary with '-h')

docs/guide/faq.md

@@ -191,6 +191,10 @@ of known supported cloud synchronization systems.
 For override this behavior you can set the `behavior.venv-mark-sync-ignore` configuration
 key to `false`.
 
+Various CI and test tools can be aided in intentionally setting a location for the virtualenv,
+as such there is an additional `--venv` option on several commands. For the given invocation 
+the command will override `.venv` to the specified location.
+
 ## Why Does Rye Contain Trojan "Bearfoos"?
 
 Unfortunately Windows likes to complain that Rye contains the trojan "Win32/Bearfoos.A!ml".

docs/philosophy.md

@@ -293,9 +293,9 @@ Preferably over time the structure of virtualenvs aligns between different Pytho
 (eg: Windows vs Linux) and the deeply nested `lib/py-ver/site-packages` structure is flattened
 out.
 
-**What needs to be done:**
-
-* Agree on a name for where managed virtualenvs are placed (eg: `.venv` in the workspace root)
+For better integration with external CI tools such as tox and nox we did introduce an optional
+parameter on many of the commands, `--venv` which allows the main `.venv` to be overridden for 
+the given command. 
 
 #### Dev and Tool Dependencies
 

rye/src/cli/add.rs

@@ -122,7 +122,11 @@ impl ReqExtras {
         self.absolute = true;
     }
 
-    pub fn apply_to_requirement(&self, req: &mut Requirement) -> Result<(), Error> {
+    pub fn apply_to_requirement(
+        &self,
+        req: &mut Requirement,
+        venv: Option<&PathBuf>,
+    ) -> Result<(), Error> {
         if let Some(ref git) = self.git {
             // XXX: today they are all aliases, it might be better to change
             // tag to refs/tags/<tag> and branch to refs/heads/<branch> but
@@ -158,7 +162,7 @@ impl ReqExtras {
             // but this not supported by pip-tools,
             // and use ${PROJECT_ROOT} will cause error in hatchling, so force absolute path.
             let is_hatchling =
-                PyProject::discover()?.build_backend() == Some(BuildSystem::Hatchling);
+                PyProject::discover(venv)?.build_backend() == Some(BuildSystem::Hatchling);
             let file_url = if self.absolute || is_hatchling {
                 Url::from_file_path(env::current_dir()?.join(path))
                     .map_err(|_| anyhow!("unable to interpret '{}' as path", path.display()))?
@@ -236,6 +240,9 @@ pub struct Args {
     /// Attempt to use `keyring` for authentication for index URLs.
     #[arg(long, value_enum, default_value_t)]
     keyring_provider: KeyringProvider,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
@@ -244,7 +251,7 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
     let python_path = self_venv.join(VENV_BIN).join("python");
     let cfg = Config::current();
 
-    let mut pyproject_toml = PyProject::discover()?;
+    let mut pyproject_toml = PyProject::discover(cmd.venv.as_ref())?;
     let py_ver = pyproject_toml.venv_python_version()?;
     let dep_kind = if cmd.dev {
         DependencyKind::Dev
@@ -267,14 +274,19 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
     let mut requirements = Vec::new();
     for str_requirement in &cmd.requirements {
         let mut requirement = Requirement::from_str(str_requirement)?;
-        cmd.req_extras.apply_to_requirement(&mut requirement)?;
+        cmd.req_extras
+            .apply_to_requirement(&mut requirement, cmd.venv.as_ref())?;
         requirements.push(requirement);
     }
 
     if !cmd.excluded {
         if cfg.use_uv() {
-            sync(SyncOptions::python_only().pyproject(None))
-                .context("failed to sync ahead of add")?;
+            sync(
+                SyncOptions::python_only()
+                    .pyproject(None)
+                    .with_venv(cmd.venv.clone()),
+            )
+            .context("failed to sync ahead of add")?;
             resolve_requirements_with_uv(
                 &pyproject_toml,
                 &py_ver,
@@ -326,6 +338,7 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
             cmd.with_sources,
             cmd.generate_hashes,
             cmd.keyring_provider,
+            cmd.venv,
         )?;
     }
 

rye/src/cli/build.rs

@@ -42,12 +42,15 @@ pub struct Args {
     /// Turns off all output.
     #[arg(short, long, conflicts_with = "verbose")]
     quiet: bool,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
     let output = CommandOutput::from_quiet_and_verbose(cmd.quiet, cmd.verbose);
     let self_venv = ensure_self_venv(output)?;
-    let project = PyProject::load_or_discover(cmd.pyproject.as_deref())?;
+    let project = PyProject::load_or_discover(cmd.pyproject.as_deref(), cmd.venv.as_ref())?;
 
     let out = match cmd.out {
         Some(path) => path,

rye/src/cli/fetch.rs

@@ -35,6 +35,9 @@ pub struct Args {
     /// Turns off all output.
     #[arg(short, long, conflicts_with = "verbose")]
     quiet: bool,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
@@ -43,7 +46,7 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
     let version: PythonVersionRequest = match cmd.version {
         Some(version) => version.parse()?,
         None => {
-            if let Ok(pyproject) = PyProject::discover() {
+            if let Ok(pyproject) = PyProject::discover(cmd.venv.as_ref()) {
                 pyproject.venv_python_version()?.into()
             } else {
                 match get_python_version_request_from_pyenv_pin(&std::env::current_dir()?) {

rye/src/cli/install.rs

@@ -1,4 +1,4 @@
-use std::path::Path;
+use std::path::{Path, PathBuf};
 
 use anyhow::{Context, Error};
 use clap::Parser;
@@ -39,6 +39,9 @@ pub struct Args {
     /// Turns off all output.
     #[arg(short, long, conflicts_with = "verbose")]
     quiet: bool,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(mut cmd: Args) -> Result<(), Error> {
@@ -50,7 +53,8 @@ pub fn execute(mut cmd: Args) -> Result<(), Error> {
     // installations here always use absolute paths for local references
     // because we do not have a rye workspace to work with.
     cmd.req_extras.force_absolute();
-    cmd.req_extras.apply_to_requirement(&mut requirement)?;
+    cmd.req_extras
+        .apply_to_requirement(&mut requirement, cmd.venv.as_ref())?;
 
     for req in cmd.extra_requirement {
         extra_requirements.push(handle_requirement(&req, output, false)?);

rye/src/cli/list.rs

@@ -17,10 +17,13 @@ pub struct Args {
     /// Use this pyproject.toml file
     #[arg(long, value_name = "PYPROJECT_TOML")]
     pub(crate) pyproject: Option<PathBuf>,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    pub(crate) venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
-    let project = PyProject::load_or_discover(cmd.pyproject.as_deref())?;
+    let project = PyProject::load_or_discover(cmd.pyproject.as_deref(), cmd.venv.as_ref())?;
     let python = get_venv_python_bin(&project.venv_path());
     if !python.is_file() {
         return Ok(());

rye/src/cli/lock.rs

@@ -49,6 +49,9 @@ pub struct Args {
     /// Use this pyproject.toml file.
     #[arg(long, value_name = "PYPROJECT_TOML")]
     pyproject: Option<PathBuf>,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
@@ -66,6 +69,7 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
             reset: cmd.reset,
             generate_hashes: cmd.generate_hashes,
             universal: cmd.universal,
+            venv: cmd.venv,
         },
         pyproject: cmd.pyproject,
         keyring_provider: cmd.keyring_provider,

rye/src/cli/make_req.rs

@@ -1,3 +1,4 @@
+use std::path::PathBuf;
 use std::str::FromStr;
 
 use anyhow::{Context, Error};
@@ -14,13 +15,17 @@ pub struct Args {
     requirements: Vec<String>,
     #[command(flatten)]
     req_extras: ReqExtras,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
     for requirement_str in cmd.requirements {
         let mut requirement = Requirement::from_str(&requirement_str)
             .with_context(|| format!("unable to parse requirement '{}'", requirement_str))?;
-        cmd.req_extras.apply_to_requirement(&mut requirement)?;
+        cmd.req_extras
+            .apply_to_requirement(&mut requirement, cmd.venv.as_ref())?;
         echo!("{}", format_requirement(&requirement));
     }
 

rye/src/cli/pin.rs

@@ -31,6 +31,9 @@ pub struct Args {
     /// Use this pyproject.toml file
     #[arg(long, value_name = "PYPROJECT_TOML")]
     pyproject: Option<PathBuf>,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
@@ -41,7 +44,7 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
     let to_write = get_pinnable_version(&req, cmd.relaxed)
         .ok_or_else(|| anyhow!("unsupported/unknown version for this platform"))?;
 
-    let pyproject = match PyProject::load_or_discover(cmd.pyproject.as_deref()) {
+    let pyproject = match PyProject::load_or_discover(cmd.pyproject.as_deref(), cmd.venv.as_ref()) {
         Ok(proj) => Some(proj),
         Err(err) => {
             if err.is::<DiscoveryUnsuccessful>() {

rye/src/cli/publish.rs

@@ -54,6 +54,9 @@ pub struct Args {
     /// Turns off all output.
     #[arg(short, long, conflicts_with = "verbose")]
     quiet: bool,
+    /// Use this virtual environment.
+    #[arg(long, value_name = "VENV")]
+    venv: Option<PathBuf>,
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
@@ -64,7 +67,7 @@ pub fn execute(cmd: Args) -> Result<(), Error> {
     let files = match cmd.dist {
         Some(paths) => paths,
         None => {
-            let project = PyProject::discover()?;
+            let project = PyProject::discover(cmd.venv.as_ref())?;
             if project.is_virtual() {
                 bail!("virtual packages cannot be published");
             }