rename to no-editable

astral-sh · Sep 17, 2024 · f0301eb · f0301eb
1 parent db575a6
commit f0301eb
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 25 deletions.
diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs
@@ -2408,9 +2408,10 @@ pub struct RunArgs {
     #[arg(long, conflicts_with("no_dev"))]
     pub only_dev: bool,
 
-    /// Install the project and any local dependencies as non-editable.
+    /// Install any editable dependencies, including the project and any workspace members, as
+    /// non-editable.
     #[arg(long)]
-    pub non_editable: bool,
+    pub no_editable: bool,
 
     /// The command to run.
     ///
@@ -2564,9 +2565,10 @@ pub struct SyncArgs {
     #[arg(long, conflicts_with("no_dev"))]
     pub only_dev: bool,
 
-    /// Install the project and any local dependencies as non-editable.
+    /// Install any editable dependencies, including the project and any workspace members, as
+    /// non-editable.
     #[arg(long)]
-    pub non_editable: bool,
+    pub no_editable: bool,
 
     /// Do not remove extraneous packages present in the environment.
     ///
@@ -3010,9 +3012,10 @@ pub struct ExportArgs {
     #[arg(long, conflicts_with("no_dev"))]
     pub only_dev: bool,
 
-    /// Install the project and any local dependencies as non-editable.
+    /// Install any editable dependencies, including the project and any workspace members, as
+    /// non-editable.
     #[arg(long)]
-    pub non_editable: bool,
+    pub no_editable: bool,
 
     /// Include hashes for all dependencies.
     #[arg(long, overrides_with("no_hashes"), hide = true)]

diff --git a/crates/uv-configuration/src/editable.rs b/crates/uv-configuration/src/editable.rs
@@ -7,8 +7,8 @@ pub enum EditableMode {
 
 impl EditableMode {
     /// Determine the editable mode based on the command-line arguments.
-    pub fn from_args(non_editable: bool) -> Self {
-        if non_editable {
+    pub fn from_args(no_editable: bool) -> Self {
+        if no_editable {
             Self::NonEditable
         } else {
             Self::Editable

diff --git a/crates/uv/src/settings.rs b/crates/uv/src/settings.rs
@@ -235,7 +235,7 @@ impl RunSettings {
             dev,
             no_dev,
             only_dev,
-            non_editable,
+            no_editable,
             command: _,
             with,
             with_editable,
@@ -261,7 +261,7 @@ impl RunSettings {
                 extra.unwrap_or_default(),
             ),
             dev: DevMode::from_args(dev, no_dev, only_dev),
-            editable: EditableMode::from_args(non_editable),
+            editable: EditableMode::from_args(no_editable),
             with,
             with_editable,
             with_requirements: with_requirements
@@ -684,7 +684,7 @@ impl SyncSettings {
             dev,
             no_dev,
             only_dev,
-            non_editable,
+            no_editable,
             inexact,
             exact,
             no_install_project,
@@ -712,7 +712,7 @@ impl SyncSettings {
                 extra.unwrap_or_default(),
             ),
             dev: DevMode::from_args(dev, no_dev, only_dev),
-            editable: EditableMode::from_args(non_editable),
+            editable: EditableMode::from_args(no_editable),
             install_options: InstallOptions::new(
                 no_install_project,
                 no_install_workspace,
@@ -991,7 +991,7 @@ impl ExportSettings {
             dev,
             no_dev,
             only_dev,
-            non_editable,
+            no_editable,
             hashes,
             no_hashes,
             output_file,
@@ -1014,7 +1014,7 @@ impl ExportSettings {
                 extra.unwrap_or_default(),
             ),
             dev: DevMode::from_args(dev, no_dev, only_dev),
-            editable: EditableMode::from_args(non_editable),
+            editable: EditableMode::from_args(no_editable),
             hashes: flag(hashes, no_hashes).unwrap_or(true),
             install_options: InstallOptions::new(
                 no_emit_project,

diff --git a/crates/uv/tests/export.rs b/crates/uv/tests/export.rs
@@ -907,7 +907,7 @@ fn no_emit() -> Result<()> {
 }
 
 #[test]
-fn non_editable() -> Result<()> {
+fn no_editable() -> Result<()> {
     let context = TestContext::new("3.12");
 
     let pyproject_toml = context.temp_dir.child("pyproject.toml");
@@ -948,12 +948,12 @@ fn non_editable() -> Result<()> {
 
     context.lock().assert().success();
 
-    uv_snapshot!(context.filters(), context.export().arg("--non-editable"), @r###"
+    uv_snapshot!(context.filters(), context.export().arg("--no-editable"), @r###"
     success: true
     exit_code: 0
     ----- stdout -----
     # This file was autogenerated by uv via the following command:
-    #    uv export --cache-dir [CACHE_DIR] --non-editable
+    #    uv export --cache-dir [CACHE_DIR] --no-editable
     .
     ./child
     anyio==3.7.0 \

diff --git a/crates/uv/tests/sync.rs b/crates/uv/tests/sync.rs
@@ -2394,7 +2394,7 @@ fn transitive_dev() -> Result<()> {
 
 /// Avoid installing dev dependencies of transitive dependencies.
 #[test]
-fn sync_non_editable() -> Result<()> {
+fn sync_no_editable() -> Result<()> {
     let context = TestContext::new("3.12");
 
     let pyproject_toml = context.temp_dir.child("pyproject.toml");
@@ -2405,11 +2405,14 @@ fn sync_non_editable() -> Result<()> {
         version = "0.1.0"
         requires-python = ">=3.12"
         dependencies = ["child"]
+
         [build-system]
         requires = ["setuptools>=42"]
         build-backend = "setuptools.build_meta"
+
         [tool.uv.sources]
         child = { workspace = true }
+
         [tool.uv.workspace]
         members = ["child"]
         "#,
@@ -2431,6 +2434,7 @@ fn sync_non_editable() -> Result<()> {
         name = "child"
         version = "0.1.0"
         requires-python = ">=3.12"
+
         [build-system]
         requires = ["setuptools>=42"]
         build-backend = "setuptools.build_meta"
@@ -2443,7 +2447,7 @@ fn sync_non_editable() -> Result<()> {
     let init = src.child("__init__.py");
     init.touch()?;
 
-    uv_snapshot!(context.filters(), context.sync().arg("--non-editable"), @r###"
+    uv_snapshot!(context.filters(), context.sync().arg("--no-editable"), @r###"
     success: true
     exit_code: 0
     ----- stdout -----

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -249,6 +249,8 @@ uv run [OPTIONS] <COMMAND>
 
 <p>This option is only available when running in a project.</p>
 
+</dd><dt><code>--no-editable</code></dt><dd><p>Install any editable dependencies, including the project and any workspace members, as non-editable</p>
+
 </dd><dt><code>--no-index</code></dt><dd><p>Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via <code>--find-links</code></p>
 
 </dd><dt><code>--no-progress</code></dt><dd><p>Hide all progress outputs.</p>
@@ -269,8 +271,6 @@ uv run [OPTIONS] <COMMAND>
 
 <p>Implies <code>--frozen</code>, as the project dependencies will be ignored (i.e., the lockfile will not be updated, since the environment will not be synced regardless).</p>
 
-</dd><dt><code>--non-editable</code></dt><dd><p>Install the project and any local dependencies as non-editable</p>
-
 </dd><dt><code>--offline</code></dt><dd><p>Disable network access.</p>
 
 <p>When disabled, uv will only use locally cached data and locally available files.</p>
@@ -1315,6 +1315,8 @@ uv sync [OPTIONS]
 <p>May also be set with the <code>UV_NO_CONFIG</code> environment variable.</p>
 </dd><dt><code>--no-dev</code></dt><dd><p>Omit development dependencies</p>
 
+</dd><dt><code>--no-editable</code></dt><dd><p>Install any editable dependencies, including the project and any workspace members, as non-editable</p>
+
 </dd><dt><code>--no-index</code></dt><dd><p>Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via <code>--find-links</code></p>
 
 </dd><dt><code>--no-install-package</code> <i>no-install-package</i></dt><dd><p>Do not install the given package(s).</p>
@@ -1337,8 +1339,6 @@ uv sync [OPTIONS]
 
 </dd><dt><code>--no-sources</code></dt><dd><p>Ignore the <code>tool.uv.sources</code> table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any local or Git sources</p>
 
-</dd><dt><code>--non-editable</code></dt><dd><p>Install the project and any local dependencies as non-editable</p>
-
 </dd><dt><code>--offline</code></dt><dd><p>Disable network access.</p>
 
 <p>When disabled, uv will only use locally cached data and locally available files.</p>
@@ -1873,6 +1873,8 @@ uv export [OPTIONS]
 <p>May also be set with the <code>UV_NO_CONFIG</code> environment variable.</p>
 </dd><dt><code>--no-dev</code></dt><dd><p>Omit development dependencies</p>
 
+</dd><dt><code>--no-editable</code></dt><dd><p>Install any editable dependencies, including the project and any workspace members, as non-editable</p>
+
 </dd><dt><code>--no-emit-package</code> <i>no-emit-package</i></dt><dd><p>Do not emit the given package(s).</p>
 
 <p>By default, all of the project&#8217;s dependencies are included in the exported requirements file. The <code>--no-install-package</code> option allows exclusion of specific packages.</p>
@@ -1897,8 +1899,6 @@ uv export [OPTIONS]
 
 </dd><dt><code>--no-sources</code></dt><dd><p>Ignore the <code>tool.uv.sources</code> table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any local or Git sources</p>
 
-</dd><dt><code>--non-editable</code></dt><dd><p>Install the project and any local dependencies as non-editable</p>
-
 </dd><dt><code>--offline</code></dt><dd><p>Disable network access.</p>
 
 <p>When disabled, uv will only use locally cached data and locally available files.</p>