From 3e09a9e23b7b402c79af3112313d2dcbd18d4b99 Mon Sep 17 00:00:00 2001 From: "Huang, Hong-Chang" Date: Mon, 23 Sep 2024 00:28:20 +0800 Subject: [PATCH 1/3] Remove double whitespaces from the code --- CHANGELOG.md | 10 +++++----- crates/uv-cli/src/lib.rs | 14 +++++++------- crates/uv/tests/lock.rs | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 477adcdc14c7..274ce11666e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -331,7 +331,7 @@ ### Enhancements -- Adding support for `.pyc` files in `uv run` ([#6886](https://github.com/astral-sh/uv/pull/6886)) +- Adding support for `.pyc` files in `uv run` ([#6886](https://github.com/astral-sh/uv/pull/6886)) - Treat missing `top_level.txt` as non-fatal ([#6881](https://github.com/astral-sh/uv/pull/6881)) ### Bug fixes @@ -371,7 +371,7 @@ - Add docs for inline exclude newer in PEP 723 scripts ([#6831](https://github.com/astral-sh/uv/pull/6831)) - Enumerate available Docker tags ([#6768](https://github.com/astral-sh/uv/pull/6768)) - Omit `[pip]` section from configuration file docs ([#6814](https://github.com/astral-sh/uv/pull/6814)) -- Update `project.urls` in `pyproject.toml` ([#6844](https://github.com/astral-sh/uv/pull/6844)) +- Update `project.urls` in `pyproject.toml` ([#6844](https://github.com/astral-sh/uv/pull/6844)) - Add docs for AWS CodeArtifact usage ([#6816](https://github.com/astral-sh/uv/pull/6816)) ### Other changes @@ -402,7 +402,7 @@ See the latest documentation on [build systems in projects](http://docs.astral.s - Add first-class support for non-packaged projects ([#6585](https://github.com/astral-sh/uv/pull/6585)) - Add `--app` and `--lib` options to `uv init` ([#6689](https://github.com/astral-sh/uv/pull/6689)) - Use `virtual` source label in lockfile for non-packaged dependencies ([#6728](https://github.com/astral-sh/uv/pull/6728)) -- Read hash from URL fragment if `--hashes` are omitted ([#6731](https://github.com/astral-sh/uv/pull/6731)) +- Read hash from URL fragment if `--hashes` are omitted ([#6731](https://github.com/astral-sh/uv/pull/6731)) - Support `{package}@{version}` in `uv tool install` ([#6762](https://github.com/astral-sh/uv/pull/6762)) - Publish additional Docker tags without patch version ([#6734](https://github.com/astral-sh/uv/pull/6734)) @@ -1163,7 +1163,7 @@ in `cache clean` ([#5353](https://github.com/astral-sh/uv/pull/5353)) provided ([#5354](https://github.com/astral-sh/uv/pull/5354)) - Show symbolic links in `uv python list` ([#5343](https://github.com/astral-sh/uv/pull/5343)) - Discover workspace from target path in `uv init` ([#5250](https://github.com/astral-sh/uv/pull/5250)) -- Do not create nested workspace in `uv init` ([#5293](https://github.com/astral-sh/uv/pull/5293)) +- Do not create nested workspace in `uv init` ([#5293](https://github.com/astral-sh/uv/pull/5293)) ## 0.2.27 @@ -1172,7 +1172,7 @@ provided ([#5354](https://github.com/astral-sh/uv/pull/5354)) - Add GraalPy support ([#5141](https://github.com/astral-sh/uv/pull/5141)) - Add a `--verify-hashes` hash-checking mode ([#4007](https://github.com/astral-sh/uv/pull/4007)) - Discover all `python3.x` executables in the `PATH` ([#5148](https://github.com/astral-sh/uv/pull/5148)) -- Support `--link-mode=symlink` ([#5208](https://github.com/astral-sh/uv/pull/5208)) +- Support `--link-mode=symlink` ([#5208](https://github.com/astral-sh/uv/pull/5208)) - Warn about unconstrained direct deps in lowest resolution ([#5142](https://github.com/astral-sh/uv/pull/5142)) - Log origin of version selection ([#5186](https://github.com/astral-sh/uv/pull/5186)) - Key hash policy on version, rather than package ([#5169](https://github.com/astral-sh/uv/pull/5169)) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 84614fab322e..d088978f7eaa 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -289,7 +289,7 @@ pub enum Commands { /// Manage Python versions and installations /// /// Generally, uv first searches for Python in a virtual environment, either active or in a - /// `.venv` directory in the current working directory or any parent directory. If a virtual + /// `.venv` directory in the current working directory or any parent directory. If a virtual /// environment is not required, uv will then search for a Python interpreter. Python /// interpreters are found by searching for Python executables in the `PATH` environment /// variable. @@ -366,7 +366,7 @@ pub enum Commands { /// /// By default, if passed a directory, `uv build` will build a source /// distribution ("sdist") from the source directory, and a binary - /// distribution ("wheel") from the source distribution. + /// distribution ("wheel") from the source distribution. /// /// `uv build --sdist` can be used to build only the source distribution, /// `uv build --wheel` can be used to build only the binary distribution, @@ -374,7 +374,7 @@ pub enum Commands { /// from source. /// /// If passed a source distribution, `uv build --wheel` will build a wheel - /// from the source distribution. + /// from the source distribution. #[command( after_help = "Use `uv help build` for more details.", after_long_help = "" @@ -410,7 +410,7 @@ pub enum Commands { ", after_help = format!("\ {heading}Options:{heading:#} - {option}--no-pager{option:#} Disable pager when printing help + {option}--no-pager{option:#} Disable pager when printing help ", heading = Style::new().bold().underline(), option = Style::new().bold(), @@ -470,7 +470,7 @@ pub enum CacheCommand { /// Show the cache directory. /// /// - /// By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and + /// By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and /// `%LOCALAPPDATA%\uv\cache` on Windows. /// /// When `--no-cache` is used, the cache is stored in a temporary directory and discarded when @@ -4018,7 +4018,7 @@ pub struct ResolverArgs { /// Disable isolation when building source distributions for a specific package. /// - /// Assumes that the packages' build dependencies specified by PEP 518 are already installed. + /// Assumes that the packages' build dependencies specified by PEP 518 are already installed. #[arg(long, help_heading = "Build options")] pub no_build_isolation_package: Vec, @@ -4210,7 +4210,7 @@ pub struct ResolverInstallerArgs { /// Disable isolation when building source distributions for a specific package. /// - /// Assumes that the packages' build dependencies specified by PEP 518 are already installed. + /// Assumes that the packages' build dependencies specified by PEP 518 are already installed. #[arg(long, help_heading = "Build options")] pub no_build_isolation_package: Vec, diff --git a/crates/uv/tests/lock.rs b/crates/uv/tests/lock.rs index 7c14ab160d11..d93c7fe06a77 100644 --- a/crates/uv/tests/lock.rs +++ b/crates/uv/tests/lock.rs @@ -9940,7 +9940,7 @@ fn lock_remove_member_non_project() -> Result<()> { Ok(()) } -/// Lock a `pyproject.toml`, then rename the project, and ensure that the lockfile is updated on +/// Lock a `pyproject.toml`, then rename the project, and ensure that the lockfile is updated on /// the next run. #[test] fn lock_rename_project() -> Result<()> { From f02034f85578fb26347cb42fbb7b5c7c342e3324 Mon Sep 17 00:00:00 2001 From: "Huang, Hong-Chang" Date: Mon, 23 Sep 2024 18:31:16 +0000 Subject: [PATCH 2/3] Fix typos in CLI documentation --- docs/reference/cli.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 8a6e8a2e75b8..4ddef7ef0f09 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -233,7 +233,7 @@ uv run [OPTIONS]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -725,7 +725,7 @@ uv add [OPTIONS] >

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -1033,7 +1033,7 @@ uv remove [OPTIONS] ...

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -1333,7 +1333,7 @@ uv sync [OPTIONS]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -1624,7 +1624,7 @@ uv lock [OPTIONS]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -1907,7 +1907,7 @@ uv export [OPTIONS]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -2199,7 +2199,7 @@ uv tree [OPTIONS]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -2556,7 +2556,7 @@ uv tool run [OPTIONS] [COMMAND]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -2834,7 +2834,7 @@ uv tool install [OPTIONS]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -3106,7 +3106,7 @@ uv tool upgrade [OPTIONS] ...

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -3615,7 +3615,7 @@ uv tool dir [OPTIONS] Manage Python versions and installations Generally, uv first searches for Python in a virtual environment, either active or in a -`.venv` directory in the current working directory or any parent directory. If a virtual +`.venv` directory in the current working directory or any parent directory. If a virtual environment is not required, uv will then search for a Python interpreter. Python interpreters are found by searching for Python executables in the `PATH` environment variable. @@ -4585,7 +4585,7 @@ uv pip compile [OPTIONS] ...

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-cache, -n

Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

@@ -5293,7 +5293,7 @@ uv pip install [OPTIONS] |--editable May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-cache, -n

Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

@@ -6482,11 +6482,11 @@ Build Python packages into source distributions and wheels. `uv build` accepts a path to a directory or source distribution, which defaults to the current working directory. -By default, if passed a directory, `uv build` will build a source distribution ("sdist") from the source directory, and a binary distribution ("wheel") from the source distribution. +By default, if passed a directory, `uv build` will build a source distribution ("sdist") from the source directory, and a binary distribution ("wheel") from the source distribution. `uv build --sdist` can be used to build only the source distribution, `uv build --wheel` can be used to build only the binary distribution, and `uv build --sdist --wheel` can be used to build both distributions from source. -If passed a source distribution, `uv build --wheel` will build a wheel from the source distribution. +If passed a source distribution, `uv build --wheel` will build a wheel from the source distribution.

Usage

@@ -6639,7 +6639,7 @@ uv build [OPTIONS] [SRC]

May also be set with the UV_NO_BUILD_ISOLATION environment variable.

--no-build-isolation-package no-build-isolation-package

Disable isolation when building source distributions for a specific package.

-

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

+

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

--no-build-package no-build-package

Don’t build source distributions for a specific package

@@ -7002,7 +7002,7 @@ uv cache prune [OPTIONS] Show the cache directory. -By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and `%LOCALAPPDATA%\uv\cache` on Windows. +By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and `%LOCALAPPDATA%\uv\cache` on Windows. When `--no-cache` is used, the cache is stored in a temporary directory and discarded when the process exits. From 4b09c24e6f9bd27a8b6b0d4e254c0eaccac19a38 Mon Sep 17 00:00:00 2001 From: konstin Date: Mon, 23 Sep 2024 22:05:27 +0200 Subject: [PATCH 3/3] Update test snapshots --- crates/uv/tests/help.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/uv/tests/help.rs b/crates/uv/tests/help.rs index 70f695a4f334..05b101ecabc3 100644 --- a/crates/uv/tests/help.rs +++ b/crates/uv/tests/help.rs @@ -209,7 +209,7 @@ fn help_subcommand() { Manage Python versions and installations Generally, uv first searches for Python in a virtual environment, either active or in a - `.venv` directory in the current working directory or any parent directory. If a virtual + `.venv` directory in the current working directory or any parent directory. If a virtual environment is not required, uv will then search for a Python interpreter. Python interpreters are found by searching for Python executables in the `PATH` environment variable. @@ -797,7 +797,7 @@ fn help_with_help() { Usage: uv help [OPTIONS] [COMMAND]... Options: - --no-pager Disable pager when printing help + --no-pager Disable pager when printing help ----- stderr ----- "###);