mirror of https://github.com/astral-sh/uv
Rename `uv sync --no-clean` to `uv sync --inexact` (#6241)
This commit is contained in:
Zanie Blue
parent
2f86c674a8
commit
c64326255e
|
|
@ -609,18 +609,22 @@ pub enum ProjectCommand {
|
|||
Remove(RemoveArgs),
|
||||
/// Update the project's environment.
|
||||
///
|
||||
/// Syncing ensures that all project dependencies are installed and
|
||||
/// up-to-date with the lockfile. Syncing also removes packages that are not
|
||||
/// declared as dependencies of the project.
|
||||
/// Syncing ensures that all project dependencies are installed and up-to-date with the
|
||||
/// lockfile.
|
||||
///
|
||||
/// If the project virtual environment (`.venv`) does not exist, it will be
|
||||
/// created.
|
||||
/// By default, an exact sync is performed: uv removes packages that are not declared as
|
||||
/// dependencies of the project. Use the `--inexact` flag to keep extraneous packages. Note that
|
||||
/// if an extraneous package conflicts with a project dependency, it will still be removed.
|
||||
/// Additionally, if `--no-build-isolation` is used, uv will not remove extraneous packages to
|
||||
/// avoid removing possible build dependencies.
|
||||
///
|
||||
/// The project is re-locked before syncing unless the `--locked` or
|
||||
/// `--frozen` flag is provided.
|
||||
/// If the project virtual environment (`.venv`) does not exist, it will be created.
|
||||
///
|
||||
/// uv will search for a project in the current directory or any parent
|
||||
/// directory. If a project cannot be found, uv will exit with an error.
|
||||
/// The project is re-locked before syncing unless the `--locked` or `--frozen` flag is
|
||||
/// provided.
|
||||
///
|
||||
/// uv will search for a project in the current directory or any parent directory. If a project
|
||||
/// cannot be found, uv will exit with an error.
|
||||
///
|
||||
/// Note that, when installing from a lockfile, uv will not provide warnings for yanked package
|
||||
/// versions.
|
||||
|
|
@ -2247,16 +2251,19 @@ pub struct SyncArgs {
|
|||
#[arg(long, overrides_with("dev"))]
|
||||
pub no_dev: bool,
|
||||
|
||||
/// Do not remove extraneous packages.
|
||||
/// Do not remove extraneous packages present in the environment.
|
||||
///
|
||||
/// When enabled, uv will make the minimum necessary changes to satisfy the
|
||||
/// requirements.
|
||||
/// When enabled, uv will make the minimum necessary changes to satisfy the requirements.
|
||||
///
|
||||
/// By default, syncing will remove any extraneous packages from the
|
||||
/// environment, unless `--no-build-isolation` is enabled, in which case
|
||||
/// extra packages are considered necessary for builds.
|
||||
#[arg(long)]
|
||||
pub no_clean: bool,
|
||||
/// By default, syncing will remove any extraneous packages from the environment, unless
|
||||
/// `--no-build-isolation` is enabled, in which case extra packages are considered necessary for
|
||||
/// builds.
|
||||
#[arg(long, overrides_with("exact"), alias = "no-exact")]
|
||||
pub inexact: bool,
|
||||
|
||||
/// Perform an exact sync, removing extraneous packages.
|
||||
#[arg(long, overrides_with("inexact"), hide = true)]
|
||||
pub exact: bool,
|
||||
|
||||
/// Assert that the `uv.lock` will remain unchanged.
|
||||
///
|
||||
|
|
|
|||
|
|
@ -627,7 +627,8 @@ impl SyncSettings {
|
|||
no_all_extras,
|
||||
dev,
|
||||
no_dev,
|
||||
no_clean,
|
||||
inexact,
|
||||
exact,
|
||||
installer,
|
||||
build,
|
||||
refresh,
|
||||
|
|
@ -640,9 +641,11 @@ impl SyncSettings {
|
|||
filesystem,
|
||||
);
|
||||
|
||||
let exact = flag(exact, inexact).unwrap_or(true);
|
||||
|
||||
// By default, sync with exact semantics, unless the user set `--no-build-isolation`;
|
||||
// otherwise, we'll end up removing build dependencies.
|
||||
let modifications = if no_clean || settings.no_build_isolation {
|
||||
let modifications = if !exact || settings.no_build_isolation {
|
||||
Modifications::Sufficient
|
||||
} else {
|
||||
Modifications::Exact
|
||||
|
|
|
|||
|
|
@ -2187,9 +2187,9 @@ fn update_source_replace_url() -> Result<()> {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
/// Adding a dependency does not clean the environment.
|
||||
/// Adding a dependency does not remove untracked dependencies from the environment.
|
||||
#[test]
|
||||
fn add_no_clean() -> Result<()> {
|
||||
fn add_inexact() -> Result<()> {
|
||||
let context = TestContext::new("3.12");
|
||||
|
||||
let pyproject_toml = context.temp_dir.child("pyproject.toml");
|
||||
|
|
@ -2303,8 +2303,8 @@ fn add_no_clean() -> Result<()> {
|
|||
);
|
||||
});
|
||||
|
||||
// Install from the lockfile without cleaning the environment.
|
||||
uv_snapshot!(context.filters(), context.sync().arg("--frozen").arg("--no-clean"), @r###"
|
||||
// Install from the lockfile without removing extraneous packages from the environment.
|
||||
uv_snapshot!(context.filters(), context.sync().arg("--frozen").arg("--inexact"), @r###"
|
||||
success: true
|
||||
exit_code: 0
|
||||
----- stdout -----
|
||||
|
|
@ -2313,7 +2313,7 @@ fn add_no_clean() -> Result<()> {
|
|||
Audited 2 packages in [TIME]
|
||||
"###);
|
||||
|
||||
// Install from the lockfile, cleaning the environment.
|
||||
// Install from the lockfile, performing an exact sync.
|
||||
uv_snapshot!(context.filters(), context.sync().arg("--frozen"), @r###"
|
||||
success: true
|
||||
exit_code: 0
|
||||
|
|
|
|||
|
|
@ -9704,7 +9704,6 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
Resolved 7 packages in [TIME]
|
||||
"###);
|
||||
|
||||
|
|
@ -9726,7 +9725,7 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
]
|
||||
|
||||
[options]
|
||||
exclude-newer = "2024-03-25 00:00:00 UTC"
|
||||
exclude-newer = "2024-03-25T00:00:00Z"
|
||||
|
||||
[[package]]
|
||||
name = "black"
|
||||
|
|
@ -9814,7 +9813,6 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
Resolved 7 packages in [TIME]
|
||||
"###);
|
||||
|
||||
|
|
@ -9826,7 +9824,6 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
Resolved 7 packages in [TIME]
|
||||
"###);
|
||||
|
||||
|
|
@ -9852,7 +9849,6 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
Resolved 7 packages in [TIME]
|
||||
"###);
|
||||
|
||||
|
|
@ -9875,7 +9871,6 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
Ignoring existing lockfile due to change in supported environments
|
||||
Resolved 8 packages in [TIME]
|
||||
error: The lockfile at `uv.lock` needs to be updated, but `--locked` was provided. To update the lockfile, run `uv lock`.
|
||||
|
|
@ -9887,7 +9882,6 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
Ignoring existing lockfile due to change in supported environments
|
||||
Resolved 8 packages in [TIME]
|
||||
Added colorama v0.4.6
|
||||
|
|
@ -9905,7 +9899,7 @@ fn lock_constrained_environment() -> Result<()> {
|
|||
requires-python = ">=3.12"
|
||||
|
||||
[options]
|
||||
exclude-newer = "2024-03-25 00:00:00 UTC"
|
||||
exclude-newer = "2024-03-25T00:00:00Z"
|
||||
|
||||
[[package]]
|
||||
name = "black"
|
||||
|
|
@ -10026,7 +10020,6 @@ fn lock_overlapping_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv lock` is experimental and may change without warning
|
||||
error: Supported environments must be disjoint, but the following markers overlap: `platform_system != 'Windows'` and `python_full_version >= '3.11'`.
|
||||
|
||||
hint: replace `python_full_version >= '3.11'` with `python_full_version >= '3.11' and platform_system == 'Windows'`.
|
||||
|
|
|
|||
|
|
@ -783,7 +783,6 @@ fn sync_environment() -> Result<()> {
|
|||
----- stdout -----
|
||||
|
||||
----- stderr -----
|
||||
warning: `uv sync` is experimental and may change without warning
|
||||
Resolved 2 packages in [TIME]
|
||||
error: The current Python platform is not compatible with the lockfile's supported environments: `python_full_version < '3.11'`
|
||||
"###);
|
||||
|
|
|
|||
|
|
@ -999,7 +999,9 @@ uv remove [OPTIONS] <PACKAGES>...
|
|||
|
||||
Update the project's environment.
|
||||
|
||||
Syncing ensures that all project dependencies are installed and up-to-date with the lockfile. Syncing also removes packages that are not declared as dependencies of the project.
|
||||
Syncing ensures that all project dependencies are installed and up-to-date with the lockfile.
|
||||
|
||||
By default, an exact sync is performed: uv removes packages that are not declared as dependencies of the project. Use the `--inexact` flag to keep extraneous packages. Note that if an extraneous package conflicts with a project dependency, it will still be removed. Additionally, if `--no-build-isolation` is used, uv will not remove extraneous packages to avoid removing possible build dependencies.
|
||||
|
||||
If the project virtual environment (`.venv`) does not exist, it will be created.
|
||||
|
||||
|
|
@ -1092,6 +1094,12 @@ uv sync [OPTIONS]
|
|||
|
||||
<p>The index given by this flag is given lower priority than all other indexes specified via the <code>--extra-index-url</code> flag.</p>
|
||||
|
||||
</dd><dt><code>--inexact</code></dt><dd><p>Do not remove extraneous packages present in the environment.</p>
|
||||
|
||||
<p>When enabled, uv will make the minimum necessary changes to satisfy the requirements.</p>
|
||||
|
||||
<p>By default, syncing will remove any extraneous packages from the environment, unless <code>--no-build-isolation</code> is enabled, in which case extra packages are considered necessary for builds.</p>
|
||||
|
||||
</dd><dt><code>--keyring-provider</code> <i>keyring-provider</i></dt><dd><p>Attempt to use <code>keyring</code> for authentication for index URLs.</p>
|
||||
|
||||
<p>At present, only <code>--keyring-provider subprocess</code> is supported, which configures uv to use the <code>keyring</code> CLI to handle authentication.</p>
|
||||
|
|
@ -1152,12 +1160,6 @@ uv sync [OPTIONS]
|
|||
|
||||
</dd><dt><code>--no-cache</code>, <code>-n</code></dt><dd><p>Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation</p>
|
||||
|
||||
</dd><dt><code>--no-clean</code></dt><dd><p>Do not remove extraneous packages.</p>
|
||||
|
||||
<p>When enabled, uv will make the minimum necessary changes to satisfy the requirements.</p>
|
||||
|
||||
<p>By default, syncing will remove any extraneous packages from the environment, unless <code>--no-build-isolation</code> is enabled, in which case extra packages are considered necessary for builds.</p>
|
||||
|
||||
</dd><dt><code>--no-config</code></dt><dd><p>Avoid discovering configuration files (<code>pyproject.toml</code>, <code>uv.toml</code>).</p>
|
||||
|
||||
<p>Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.</p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue