Deprecate the --isolated flag (#5466)

## Summary This PR deprecates the `--isolated` flag. The treatment varies across the APIs: - For non-preview APIs, we warn but treat it as equivalent to `--no-config`. - For preview APIs, we warn and ignore it, with two exceptions... - For `tool run` and `run` specifically, we don't even warn, because we can't differentiate the command-specific `--isolated` from the global `--isolated`.
astral-sh · Jul 30, 2024 · 5d727cb · 5d727cb
1 parent f971631
commit 5d727cb
Show file tree

Hide file tree

Showing 15 changed files with 69 additions and 71 deletions.
diff --git a/.github/workflows/sync-python-releases.yml b/.github/workflows/sync-python-releases.yml
@@ -20,8 +20,8 @@ jobs:
       - uses: hynek/setup-cached-uv@v2
       - name: Sync Python Releases
         run: |
-          uv run --isolated -- fetch-download-metadata.py
-          uv run --isolated -- template-download-metadata.py
+          uv run -- fetch-download-metadata.py
+          uv run -- template-download-metadata.py
         working-directory: ./crates/uv-python
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/README.md b/README.md
@@ -255,7 +255,7 @@ project-level settings appearing earlier in the merged array.
 Settings provided via environment variables take precedence over persistent configuration, and
 settings provided via the command line take precedence over both.
 
-uv accepts a `--isolated` command-line argument which, when provided, disables the discovery of any
+uv accepts a `--no-config` command-line argument which, when provided, disables the discovery of any
 persistent configuration.
 
 uv also accepts a `--config-file` command-line argument, which accepts a path to a `uv.toml` to use

diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs
@@ -154,7 +154,7 @@ pub struct GlobalArgs {
 
     /// Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
     /// parent directories.
-    #[arg(global = true, long)]
+    #[arg(global = true, long, hide = true)]
     pub isolated: bool,
 
     /// Show the resolved settings for the current command.

diff --git a/crates/uv-python/fetch-download-metadata.py b/crates/uv-python/fetch-download-metadata.py
@@ -11,7 +11,7 @@
 
 Usage:
 
-    uv run --isolated -- crates/uv-python/fetch-download-metadata.py
+    uv run -- crates/uv-python/fetch-download-metadata.py
 
 Acknowledgements:
 

diff --git a/crates/uv-python/template-download-metadata.py b/crates/uv-python/template-download-metadata.py
@@ -11,7 +11,7 @@
 
 Usage:
 
-    uv run --isolated -- crates/uv-python/template-download-metadata.py
+    uv run -- crates/uv-python/template-download-metadata.py
 """
 
 import argparse

diff --git a/crates/uv/src/lib.rs b/crates/uv/src/lib.rs
@@ -24,6 +24,7 @@ use uv_configuration::Concurrency;
 use uv_fs::CWD;
 use uv_requirements::RequirementsSource;
 use uv_settings::{Combine, FilesystemOptions};
+use uv_warnings::warn_user;
 use uv_workspace::{DiscoveryOptions, Workspace};
 
 use crate::commands::{ExitStatus, ToolRunCommand};
@@ -67,6 +68,39 @@ async fn run(cli: Cli) -> Result<ExitStatus> {
         std::env::set_current_dir(directory)?;
     }
 
+    // The `--isolated` argument is deprecated on preview APIs, and warns on non-preview APIs.
+    let deprecated_isolated = if cli.global_args.isolated {
+        match &*cli.command {
+            // Supports `--isolated` as its own argument, so we can't warn either way.
+            Commands::Tool(ToolNamespace {
+                command: ToolCommand::Run(_),
+            }) => false,
+
+            // Supports `--isolated` as its own argument, so we can't warn either way.
+            Commands::Project(command) if matches!(**command, ProjectCommand::Run(_)) => false,
+
+            // `--isolated` moved to `--no-workspace`.
+            Commands::Project(command) if matches!(**command, ProjectCommand::Init(_)) => {
+                warn_user!("The `--isolated` flag is deprecated and has no effect. Instead, use `--no-config` to prevent uv from discovering configuration files or `--no-workspace` to prevent uv from adding the initialized project to the containing workspace.");
+                false
+            }
+
+            // Preview APIs. Ignore `--isolated` and warn.
+            Commands::Project(_) | Commands::Tool(_) | Commands::Python(_) => {
+                warn_user!("The `--isolated` flag is deprecated and has no effect. Instead, use `--no-config` to prevent uv from discovering configuration files.");
+                false
+            }
+
+            // Non-preview APIs. Continue to support `--isolated`, but warn.
+            _ => {
+                warn_user!("The `--isolated` flag is deprecated. Instead, use `--no-config` to prevent uv from discovering configuration files.");
+                true
+            }
+        }
+    } else {
+        false
+    };
+
     // Load configuration from the filesystem, prioritizing (in order):
     // 1. The configuration file specified on the command-line.
     // 2. The configuration file in the current workspace (i.e., the `pyproject.toml` or `uv.toml`
@@ -77,7 +111,7 @@ async fn run(cli: Cli) -> Result<ExitStatus> {
     //    search for `pyproject.toml` files, since we're not in a workspace.
     let filesystem = if let Some(config_file) = cli.config_file.as_ref() {
         Some(FilesystemOptions::from_file(config_file)?)
-    } else if cli.global_args.isolated || cli.no_config {
+    } else if deprecated_isolated || cli.no_config {
         None
     } else if let Ok(project) = Workspace::discover(&CWD, &DiscoveryOptions::default()).await {
         let project = FilesystemOptions::from_directory(project.install_path())?;
@@ -654,7 +688,7 @@ async fn run(cli: Cli) -> Result<ExitStatus> {
                 args.python,
                 args.settings,
                 invocation_source,
-                args.isolated || globals.isolated,
+                args.isolated,
                 globals.preview,
                 globals.python_preference,
                 globals.python_fetch,
@@ -780,7 +814,7 @@ async fn run(cli: Cli) -> Result<ExitStatus> {
                 globals.native_tls,
                 globals.connectivity,
                 globals.preview,
-                cli.no_config || globals.isolated,
+                cli.no_config,
                 printer,
             )
             .await
@@ -826,7 +860,7 @@ async fn run(cli: Cli) -> Result<ExitStatus> {
                 args.resolved,
                 globals.python_preference,
                 globals.preview,
-                args.no_workspace || globals.isolated,
+                args.no_workspace,
                 &cache,
                 printer,
             )
@@ -876,7 +910,7 @@ async fn run_project(
                 args.r#virtual,
                 args.no_readme,
                 args.python,
-                args.no_workspace || globals.isolated,
+                args.no_workspace,
                 globals.preview,
                 globals.python_preference,
                 globals.python_fetch,
@@ -916,7 +950,7 @@ async fn run_project(
                 args.frozen,
                 args.isolated,
                 args.package,
-                args.no_project || globals.isolated,
+                args.no_project,
                 args.extras,
                 args.dev,
                 args.python,

diff --git a/crates/uv/src/settings.rs b/crates/uv/src/settings.rs
@@ -43,7 +43,6 @@ pub(crate) struct GlobalSettings {
     pub(crate) color: ColorChoice,
     pub(crate) native_tls: bool,
     pub(crate) connectivity: Connectivity,
-    pub(crate) isolated: bool,
     pub(crate) show_settings: bool,
     pub(crate) preview: PreviewMode,
     pub(crate) python_preference: PythonPreference,
@@ -108,7 +107,6 @@ impl GlobalSettings {
             } else {
                 Connectivity::Online
             },
-            isolated: args.isolated,
             show_settings: args.show_settings,
             preview,
             python_preference: args

diff --git a/crates/uv/tests/help.rs b/crates/uv/tests/help.rs
@@ -43,9 +43,6 @@ fn help() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache
@@ -109,9 +106,6 @@ fn help_flag() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache
@@ -174,9 +168,6 @@ fn help_short_flag() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache
@@ -280,10 +271,6 @@ fn help_subcommand() {
               - manual:    Do not automatically fetch managed Python installations; require explicit
                 installation
 
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
-
           --no-progress
               Hides all progress outputs when set
 
@@ -408,10 +395,6 @@ fn help_subsubcommand() {
               - manual:    Do not automatically fetch managed Python installations; require explicit
                 installation
 
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
-
           --no-progress
               Hides all progress outputs when set
 
@@ -490,9 +473,6 @@ fn help_flag_subcommand() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache
@@ -552,9 +532,6 @@ fn help_flag_subsubcommand() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache
@@ -671,9 +648,6 @@ fn help_with_global_option() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache
@@ -770,9 +744,6 @@ fn test_with_no_pager() {
           --python-fetch <PYTHON_FETCH>
               Whether to automatically download Python when required [possible values: automatic,
               manual]
-          --isolated
-              Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any
-              parent directories
           --no-progress
               Hides all progress outputs when set
       -n, --no-cache

diff --git a/crates/uv/tests/init.rs b/crates/uv/tests/init.rs
@@ -612,7 +612,9 @@ fn init_isolated() -> Result<()> {
     ----- stdout -----
 
     ----- stderr -----
+    warning: The `--isolated` flag is deprecated and has no effect. Instead, use `--no-config` to prevent uv from discovering configuration files or `--no-workspace` to prevent uv from adding the initialized project to the containing workspace.
     warning: `uv init` is experimental and may change without warning
+    Adding `foo` as member of workspace `[TEMP_DIR]/`
     Initialized project `foo`
     "###);
 
@@ -627,6 +629,9 @@ fn init_isolated() -> Result<()> {
         name = "project"
         version = "0.1.0"
         requires-python = ">=3.12"
+
+        [tool.uv.workspace]
+        members = ["foo"]
         "###
         );
     });