Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix references to `--python-downloads` (it is `--no-python-downloads`) (#6439) 

Noticed in https://github.com/astral-sh/uv/pull/6409
This commit is contained in:
Zanie Blue 2024-08-22 09:22:55 -05:00 committed by GitHub
parent 3c7b169bf2
commit 3dd39e6d35
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 54 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
crates/uv-cli/src/lib.rs
View File

@ -256,17 +256,16 @@ pub enum Commands {
/// Manage Python versions and installations /// Manage Python versions and installations
/// ///
/// Generally, uv first searches for Python in a virtual environment, either /// Generally, uv first searches for Python in a virtual environment, either active or in a
/// active or in a `.venv` directory in the current working directory or /// `.venv` directory in the current working directory or any parent directory. If a virtual
/// any parent directory. If a virtual environment is not required, uv will /// environment is not required, uv will then search for a Python interpreter. Python
/// then search for a Python interpreter. Python interpreters are found by /// interpreters are found by searching for Python executables in the `PATH` environment
/// searching for Python executables in the `PATH` environment variable. /// variable.
/// ///
/// On Windows, the `py` launcher is also invoked to find Python /// On Windows, the `py` launcher is also invoked to find Python executables.
/// executables.
/// ///
/// By default, uv will download Python if a version cannot be found. This /// By default, uv will download Python if a version cannot be found. This behavior can be
/// behavior can be disabled with the `--python-downloads` option. /// disabled with the `--no-python-downloads` flag or the `python-downloads` setting.
/// ///
/// The `--python` option allows requesting a different interpreter. /// The `--python` option allows requesting a different interpreter.
/// ///
@ -278,26 +277,22 @@ pub enum Commands {
/// - `<implementation>@<version>` e.g. `cpython@3.12` /// - `<implementation>@<version>` e.g. `cpython@3.12`
/// - `<implementation><version>` e.g. `cpython3.12` or `cp312` /// - `<implementation><version>` e.g. `cpython3.12` or `cp312`
/// - `<implementation><version-specifier>` e.g. `cpython>=3.12,<3.13` /// - `<implementation><version-specifier>` e.g. `cpython>=3.12,<3.13`
/// - `<implementation>-<version>-<os>-<arch>-<libc>` e.g. /// - `<implementation>-<version>-<os>-<arch>-<libc>` e.g. `cpython-3.12.3-macos-aarch64-none`
/// `cpython-3.12.3-macos-aarch64-none`
/// ///
/// Additionally, a specific system Python interpreter can often be /// Additionally, a specific system Python interpreter can often be requested with:
/// requested with:
/// ///
/// - `<executable-path>` e.g. `/opt/homebrew/bin/python3` /// - `<executable-path>` e.g. `/opt/homebrew/bin/python3`
/// - `<executable-name>` e.g. `mypython3` /// - `<executable-name>` e.g. `mypython3`
/// - `<install-dir>` e.g. `/some/environment/` /// - `<install-dir>` e.g. `/some/environment/`
/// ///
/// When the `--python` option is used, normal discovery rules apply but /// When the `--python` option is used, normal discovery rules apply but discovered interpreters
/// discovered interpreters are checked for compatibility with the request, /// are checked for compatibility with the request, e.g., if `pypy` is requested, uv will first
/// e.g., if `pypy` is requested, uv will first check if the virtual /// check if the virtual environment contains a PyPy interpreter then check if each executable
/// environment contains a PyPy interpreter then check if each executable in /// in the path is a PyPy interpreter.
/// the path is a PyPy interpreter.
/// ///
/// uv supports discovering CPython, PyPy, and GraalPy interpreters. /// uv supports discovering CPython, PyPy, and GraalPy interpreters. Unsupported interpreters
/// Unsupported interpreters will be skipped during discovery. If an /// will be skipped during discovery. If an unsupported interpreter implementation is requested,
/// unsupported interpreter implementation is requested, uv will exit with /// uv will exit with an error.
/// an error.
#[clap(verbatim_doc_comment)] #[clap(verbatim_doc_comment)]
#[command( #[command(
after_help = "Use `uv help python` for more details.", after_help = "Use `uv help python` for more details.",

39
crates/uv/tests/help.rs
View File

@ -199,17 +199,16 @@ fn help_subcommand() {
----- stdout ----- ----- stdout -----
Manage Python versions and installations Manage Python versions and installations
Generally, uv first searches for Python in a virtual environment, either Generally, uv first searches for Python in a virtual environment, either active or in a
active or in a `.venv` directory in the current working directory or `.venv` directory in the current working directory or any parent directory. If a virtual
any parent directory. If a virtual environment is not required, uv will environment is not required, uv will then search for a Python interpreter. Python
then search for a Python interpreter. Python interpreters are found by interpreters are found by searching for Python executables in the `PATH` environment
searching for Python executables in the `PATH` environment variable. variable.
On Windows, the `py` launcher is also invoked to find Python On Windows, the `py` launcher is also invoked to find Python executables.
executables.
By default, uv will download Python if a version cannot be found. This By default, uv will download Python if a version cannot be found. This behavior can be
behavior can be disabled with the `--python-downloads` option. disabled with the `--no-python-downloads` flag or the `python-downloads` setting.
The `--python` option allows requesting a different interpreter. The `--python` option allows requesting a different interpreter.
@ -221,26 +220,22 @@ fn help_subcommand() {
- `<implementation>@<version>` e.g. `cpython@3.12` - `<implementation>@<version>` e.g. `cpython@3.12`
- `<implementation><version>` e.g. `cpython3.12` or `cp312` - `<implementation><version>` e.g. `cpython3.12` or `cp312`
- `<implementation><version-specifier>` e.g. `cpython>=3.12,<3.13` - `<implementation><version-specifier>` e.g. `cpython>=3.12,<3.13`
- `<implementation>-<version>-<os>-<arch>-<libc>` e.g. - `<implementation>-<version>-<os>-<arch>-<libc>` e.g. `cpython-3.12.3-macos-aarch64-none`
`cpython-3.12.3-macos-aarch64-none`
Additionally, a specific system Python interpreter can often be Additionally, a specific system Python interpreter can often be requested with:
requested with:
- `<executable-path>` e.g. `/opt/homebrew/bin/python3` - `<executable-path>` e.g. `/opt/homebrew/bin/python3`
- `<executable-name>` e.g. `mypython3` - `<executable-name>` e.g. `mypython3`
- `<install-dir>` e.g. `/some/environment/` - `<install-dir>` e.g. `/some/environment/`
When the `--python` option is used, normal discovery rules apply but When the `--python` option is used, normal discovery rules apply but discovered interpreters
discovered interpreters are checked for compatibility with the request, are checked for compatibility with the request, e.g., if `pypy` is requested, uv will first
e.g., if `pypy` is requested, uv will first check if the virtual check if the virtual environment contains a PyPy interpreter then check if each executable
environment contains a PyPy interpreter then check if each executable in in the path is a PyPy interpreter.
the path is a PyPy interpreter.
uv supports discovering CPython, PyPy, and GraalPy interpreters. uv supports discovering CPython, PyPy, and GraalPy interpreters. Unsupported interpreters
Unsupported interpreters will be skipped during discovery. If an will be skipped during discovery. If an unsupported interpreter implementation is requested,
unsupported interpreter implementation is requested, uv will exit with uv will exit with an error.
an error.
Usage: uv python [OPTIONS] <COMMAND> Usage: uv python [OPTIONS] <COMMAND>

5
docs/concepts/python-versions.md
View File

@ -171,8 +171,9 @@ during `uv python install`.
!!! tip !!! tip
The `--python-downloads` option can be passed to any uv command, or it can be set in a The `python-downloads` setting can be set in a
[persistent configuration file](../configuration/files.md) to change the default behavior. [persistent configuration file](../configuration/files.md) to change the default behavior, or
the `--no-python-downloads` flag can be passed to any uv command.
## Adjusting Python version preferences ## Adjusting Python version preferences

39
docs/reference/cli.md
View File

@ -2866,17 +2866,16 @@ uv tool dir [OPTIONS]
Manage Python versions and installations Manage Python versions and installations
Generally, uv first searches for Python in a virtual environment, either Generally, uv first searches for Python in a virtual environment, either active or in a
active or in a `.venv` directory in the current working directory or `.venv` directory in the current working directory or any parent directory. If a virtual
any parent directory. If a virtual environment is not required, uv will environment is not required, uv will then search for a Python interpreter. Python
then search for a Python interpreter. Python interpreters are found by interpreters are found by searching for Python executables in the `PATH` environment
searching for Python executables in the `PATH` environment variable. variable.
On Windows, the `py` launcher is also invoked to find Python On Windows, the `py` launcher is also invoked to find Python executables.
executables.
By default, uv will download Python if a version cannot be found. This By default, uv will download Python if a version cannot be found. This behavior can be
behavior can be disabled with the `--python-downloads` option. disabled with the `--no-python-downloads` flag or the `python-downloads` setting.
The `--python` option allows requesting a different interpreter. The `--python` option allows requesting a different interpreter.
@ -2888,26 +2887,22 @@ The following Python version request formats are supported:
- `<implementation>@<version>` e.g. `cpython@3.12` - `<implementation>@<version>` e.g. `cpython@3.12`
- `<implementation><version>` e.g. `cpython3.12` or `cp312` - `<implementation><version>` e.g. `cpython3.12` or `cp312`
- `<implementation><version-specifier>` e.g. `cpython>=3.12,<3.13` - `<implementation><version-specifier>` e.g. `cpython>=3.12,<3.13`
- `<implementation>-<version>-<os>-<arch>-<libc>` e.g. - `<implementation>-<version>-<os>-<arch>-<libc>` e.g. `cpython-3.12.3-macos-aarch64-none`
`cpython-3.12.3-macos-aarch64-none`
Additionally, a specific system Python interpreter can often be Additionally, a specific system Python interpreter can often be requested with:
requested with:
- `<executable-path>` e.g. `/opt/homebrew/bin/python3` - `<executable-path>` e.g. `/opt/homebrew/bin/python3`
- `<executable-name>` e.g. `mypython3` - `<executable-name>` e.g. `mypython3`
- `<install-dir>` e.g. `/some/environment/` - `<install-dir>` e.g. `/some/environment/`
When the `--python` option is used, normal discovery rules apply but When the `--python` option is used, normal discovery rules apply but discovered interpreters
discovered interpreters are checked for compatibility with the request, are checked for compatibility with the request, e.g., if `pypy` is requested, uv will first
e.g., if `pypy` is requested, uv will first check if the virtual check if the virtual environment contains a PyPy interpreter then check if each executable
environment contains a PyPy interpreter then check if each executable in in the path is a PyPy interpreter.
the path is a PyPy interpreter.
uv supports discovering CPython, PyPy, and GraalPy interpreters. uv supports discovering CPython, PyPy, and GraalPy interpreters. Unsupported interpreters
Unsupported interpreters will be skipped during discovery. If an will be skipped during discovery. If an unsupported interpreter implementation is requested,
unsupported interpreter implementation is requested, uv will exit with uv will exit with an error.
an error.
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>