mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-09-27 12:39:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Improve Python discovery source messages (#8890)

Browse source 
e.g.

```
❯ echo "anyio" |  cargo run -q -- pip compile - -v
DEBUG uv 0.4.30 (107ab3d71 2024-11-07)
DEBUG Starting Python discovery for a default Python
DEBUG Looking for exact match for request a default Python
DEBUG Searching for default Python interpreter in virtual environments, managed installations, or search path
DEBUG Found `cpython-3.12.7-macos-aarch64-none` at `/Users/zb/workspace/uv/.venv/bin/python3` (virtual environment)
```
```
❯ cargo run -q -- pip install anyio -v
DEBUG uv 0.4.30 (107ab3d71 2024-11-07)
DEBUG Searching for default Python interpreter in virtual environments
DEBUG Found `cpython-3.12.7-macos-aarch64-none` at `/Users/zb/workspace/uv/.venv/bin/python3` (virtual environment)
```

vs

```
❯ uv  pip install anyio -v
DEBUG uv 0.4.30 (61ed2a236 2024-11-04)
DEBUG Searching for default Python interpreter in system path
DEBUG Found `cpython-3.12.7-macos-aarch64-none` at `/Users/zb/workspace/uv/.venv/bin/python3` (virtual environment)
```

```
❯ echo "anyio" | uv pip compile - -v
DEBUG uv 0.4.30 (61ed2a236 2024-11-04)
DEBUG Starting Python discovery for a default Python
DEBUG Looking for exact match for request a default Python
DEBUG Searching for default Python interpreter in managed installations or system path
DEBUG Found `cpython-3.12.7-macos-aarch64-none` at `/Users/zb/workspace/uv/.venv/bin/python3` (virtual environment)
```
This commit is contained in:
Zanie Blue 2024-11-07 14:08:49 -06:00 • committed by GitHub
parent b4fa46bf4f
commit 88331e756e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 106 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

2
crates/uv-cli/src/lib.rs
View file

@ -303,7 +303,7 @@ pub enum Commands {
/// interpreters are found by searching for Python executables in the `PATH` environment /// interpreters are found by searching for Python executables in the `PATH` environment
/// variable. /// variable.
/// ///
/// On Windows, the `py` launcher is also invoked to find Python executables. /// On Windows, the registry is also searched for Python executables.
/// ///
/// By default, uv will download Python if a version cannot be found. This behavior can be /// By default, uv will download Python if a version cannot be found. This behavior can be
/// disabled with the `--no-python-downloads` flag or the `python-downloads` setting. /// disabled with the `--no-python-downloads` flag or the `python-downloads` setting.

114
crates/uv-python/src/discovery.rs
View file

@ -133,6 +133,12 @@ pub enum EnvironmentPreference {
Any, Any,
} }
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub(crate) struct DiscoveryPreferences {
python_preference: PythonPreference,
environment_preference: EnvironmentPreference,
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum PythonVariant { pub enum PythonVariant {
#[default] #[default]
@ -276,7 +282,7 @@ fn python_executables_from_environments<'a>(
/// ///
/// - Managed Python installations (e.g. `uv python install`) /// - Managed Python installations (e.g. `uv python install`)
/// - The search path (i.e. `PATH`) /// - The search path (i.e. `PATH`)
/// - The `py` launcher (Windows only) /// - The registry (Windows only)
/// ///
/// The ordering and presence of each source is determined by the [`PythonPreference`]. /// The ordering and presence of each source is determined by the [`PythonPreference`].
/// ///
@ -753,6 +759,12 @@ pub fn find_python_installations<'a>(
preference: PythonPreference, preference: PythonPreference,
cache: &'a Cache, cache: &'a Cache,
) -> Box<dyn Iterator<Item = Result<FindPythonResult, Error>> + 'a> { ) -> Box<dyn Iterator<Item = Result<FindPythonResult, Error>> + 'a> {
let sources = DiscoveryPreferences {
python_preference: preference,
environment_preference: environments,
}
.sources(request);
match request { match request {
PythonRequest::File(path) => Box::new(std::iter::once({ PythonRequest::File(path) => Box::new(std::iter::once({
if preference.allows(PythonSource::ProvidedPath) { if preference.allows(PythonSource::ProvidedPath) {
@ -831,7 +843,7 @@ pub fn find_python_installations<'a>(
} }
} }
PythonRequest::Any => Box::new({ PythonRequest::Any => Box::new({
debug!("Searching for any Python interpreter in {preference}"); debug!("Searching for any Python interpreter in {sources}");
python_interpreters(&VersionRequest::Any, None, environments, preference, cache).map( python_interpreters(&VersionRequest::Any, None, environments, preference, cache).map(
|result| { |result| {
result result
@ -841,7 +853,7 @@ pub fn find_python_installations<'a>(
) )
}), }),
PythonRequest::Default => Box::new({ PythonRequest::Default => Box::new({
debug!("Searching for default Python interpreter in {preference}"); debug!("Searching for default Python interpreter in {sources}");
python_interpreters( python_interpreters(
&VersionRequest::Default, &VersionRequest::Default,
None, None,
@ -860,7 +872,7 @@ pub fn find_python_installations<'a>(
return Box::new(std::iter::once(Err(Error::InvalidVersionRequest(err)))); return Box::new(std::iter::once(Err(Error::InvalidVersionRequest(err))));
}; };
Box::new({ Box::new({
debug!("Searching for {request} in {preference}"); debug!("Searching for {request} in {sources}");
python_interpreters(version, None, environments, preference, cache).map(|result| { python_interpreters(version, None, environments, preference, cache).map(|result| {
result result
.map(PythonInstallation::from_tuple) .map(PythonInstallation::from_tuple)
@ -869,7 +881,7 @@ pub fn find_python_installations<'a>(
}) })
} }
PythonRequest::Implementation(implementation) => Box::new({ PythonRequest::Implementation(implementation) => Box::new({
debug!("Searching for a {request} interpreter in {preference}"); debug!("Searching for a {request} interpreter in {sources}");
python_interpreters( python_interpreters(
&VersionRequest::Default, &VersionRequest::Default,
Some(implementation), Some(implementation),
@ -894,7 +906,7 @@ pub fn find_python_installations<'a>(
return Box::new(std::iter::once(Err(Error::InvalidVersionRequest(err)))); return Box::new(std::iter::once(Err(Error::InvalidVersionRequest(err))));
}; };
Box::new({ Box::new({
debug!("Searching for {request} in {preference}"); debug!("Searching for {request} in {sources}");
python_interpreters( python_interpreters(
version, version,
Some(implementation), Some(implementation),
@ -922,7 +934,7 @@ pub fn find_python_installations<'a>(
}; };
}; };
Box::new({ Box::new({
debug!("Searching for {request} in {preference}"); debug!("Searching for {request} in {sources}");
python_interpreters( python_interpreters(
request.version().unwrap_or(&VersionRequest::Default), request.version().unwrap_or(&VersionRequest::Default),
request.implementation(), request.implementation(),
@ -2256,22 +2268,27 @@ impl fmt::Display for PythonSource {
} }
impl PythonPreference { impl PythonPreference {
/// Return the sources that are considered when searching for a Python interpreter. /// Return the sources that are considered when searching for a Python interpreter with this
fn sources(self) -> &'static [&'static str] { /// preference.
fn sources(self) -> &'static [PythonSource] {
match self { match self {
Self::OnlyManaged => &["managed installations"], Self::OnlyManaged => &[PythonSource::Managed],
Self::Managed | Self::System => { Self::Managed | Self::System => {
if cfg!(windows) { if cfg!(windows) {
&["managed installations", "system path", "`py` launcher"] &[
PythonSource::Managed,
PythonSource::SearchPath,
PythonSource::Registry,
]
} else { } else {
&["managed installations", "system path"] &[PythonSource::Managed, PythonSource::SearchPath]
} }
} }
Self::OnlySystem => { Self::OnlySystem => {
if cfg!(windows) { if cfg!(windows) {
&["system path", "`py` launcher"] &[PythonSource::Registry, PythonSource::SearchPath]
} else { } else {
&["system path"] &[PythonSource::SearchPath]
} }
} }
} }
@ -2280,29 +2297,62 @@ impl PythonPreference {
impl fmt::Display for PythonPreference { impl fmt::Display for PythonPreference {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", conjunction(self.sources())) f.write_str(match self {
Self::OnlyManaged => "only managed",
Self::Managed => "prefer managed",
Self::System => "prefer system",
Self::OnlySystem => "only system",
})
}
}
impl DiscoveryPreferences {
/// Return a string describing the sources that are considered when searching for Python with
/// the given preferences.
fn sources(&self, request: &PythonRequest) -> String {
let python_sources = self
.python_preference
.sources()
.iter()
.map(ToString::to_string)
.collect::<Vec<_>>();
match self.environment_preference {
EnvironmentPreference::Any => conjunction(
&["virtual environments"]
.into_iter()
.chain(python_sources.iter().map(String::as_str))
.collect::<Vec<_>>(),
),
EnvironmentPreference::ExplicitSystem => {
if request.is_explicit_system() {
conjunction(
&["virtual environments"]
.into_iter()
.chain(python_sources.iter().map(String::as_str))
.collect::<Vec<_>>(),
)
} else {
conjunction(&["virtual environments"])
}
}
EnvironmentPreference::OnlySystem => conjunction(
&python_sources
.iter()
.map(String::as_str)
.collect::<Vec<_>>(),
),
EnvironmentPreference::OnlyVirtual => conjunction(&["virtual environments"]),
}
} }
} }
impl fmt::Display for PythonNotFound { impl fmt::Display for PythonNotFound {
fn fmt(&self, f: &mut Formatter) -> fmt::Result { fn fmt(&self, f: &mut Formatter) -> fmt::Result {
let sources = match self.environment_preference { let sources = DiscoveryPreferences {
EnvironmentPreference::Any => conjunction( python_preference: self.python_preference,
&["virtual environments"] environment_preference: self.environment_preference,
.into_iter() }
.chain(self.python_preference.sources().iter().copied()) .sources(&self.request);
.collect::<Vec<_>>(),
),
EnvironmentPreference::ExplicitSystem => {
if self.request.is_explicit_system() {
conjunction(&["virtual", "system environment"])
} else {
conjunction(&["virtual environment"])
}
}
EnvironmentPreference::OnlySystem => conjunction(self.python_preference.sources()),
EnvironmentPreference::OnlyVirtual => conjunction(&["virtual environments"]),
};
match self.request { match self.request {
PythonRequest::Default | PythonRequest::Any => { PythonRequest::Default | PythonRequest::Any => {

4
crates/uv/tests/it/common/mod.rs
View file

@ -147,11 +147,11 @@ impl TestContext {
#[must_use] #[must_use]
pub fn with_filtered_python_sources(mut self) -> Self { pub fn with_filtered_python_sources(mut self) -> Self {
self.filters.push(( self.filters.push((
"managed installations or system path".to_string(), "managed installations or search path".to_string(),
"[PYTHON SOURCES]".to_string(), "[PYTHON SOURCES]".to_string(),
)); ));
self.filters.push(( self.filters.push((
"managed installations, system path, or `py` launcher".to_string(), "managed installations, search path, or registry".to_string(),
"[PYTHON SOURCES]".to_string(), "[PYTHON SOURCES]".to_string(),
)); ));
self self

2
crates/uv/tests/it/help.rs
View file

@ -223,7 +223,7 @@ fn help_subcommand() {
interpreters are found by searching for Python executables in the `PATH` environment interpreters are found by searching for Python executables in the `PATH` environment
variable. variable.
On Windows, the `py` launcher is also invoked to find Python executables. On Windows, the registry is also searched for Python executables.
By default, uv will download Python if a version cannot be found. This behavior can be By default, uv will download Python if a version cannot be found. This behavior can be
disabled with the `--no-python-downloads` flag or the `python-downloads` setting. disabled with the `--no-python-downloads` flag or the `python-downloads` setting.

12
crates/uv/tests/it/python_find.rs
View file

@ -20,7 +20,7 @@ fn python_find() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found in virtual environments, managed installations, system path, or `py` launcher error: No interpreter found in virtual environments, managed installations, search path, or registry
"###); "###);
} else { } else {
uv_snapshot!(context.filters(), context.python_find().env(EnvVars::UV_TEST_PYTHON_PATH, ""), @r###" uv_snapshot!(context.filters(), context.python_find().env(EnvVars::UV_TEST_PYTHON_PATH, ""), @r###"
@ -29,7 +29,7 @@ fn python_find() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found in virtual environments, managed installations, or system path error: No interpreter found in virtual environments, managed installations, or search path
"###); "###);
} }
@ -116,7 +116,7 @@ fn python_find() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for PyPy in virtual environments, managed installations, system path, or `py` launcher error: No interpreter found for PyPy in virtual environments, managed installations, search path, or registry
"###); "###);
} else { } else {
uv_snapshot!(context.filters(), context.python_find().arg("pypy"), @r###" uv_snapshot!(context.filters(), context.python_find().arg("pypy"), @r###"
@ -125,7 +125,7 @@ fn python_find() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for PyPy in virtual environments, managed installations, or system path error: No interpreter found for PyPy in virtual environments, managed installations, or search path
"###); "###);
} }
@ -441,7 +441,7 @@ fn python_find_unsupported_version() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for Python 4.2 in virtual environments, managed installations, or system path error: No interpreter found for Python 4.2 in virtual environments, managed installations, or search path
"###); "###);
// Request a low version with a range // Request a low version with a range
@ -451,7 +451,7 @@ fn python_find_unsupported_version() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for Python <3.0 in virtual environments, managed installations, or system path error: No interpreter found for Python <3.0 in virtual environments, managed installations, or search path
"###); "###);
// Request free-threaded Python on unsupported version // Request free-threaded Python on unsupported version

18
crates/uv/tests/it/python_pin.rs
View file

@ -168,7 +168,7 @@ fn python_pin() {
Updated `.python-version` from `[PYTHON-3.11]` -> `pypy` Updated `.python-version` from `[PYTHON-3.11]` -> `pypy`
----- stderr ----- ----- stderr -----
warning: No interpreter found for PyPy in managed installations or system path warning: No interpreter found for PyPy in managed installations or search path
"###); "###);
let python_version = context.read(PYTHON_VERSION_FILENAME); let python_version = context.read(PYTHON_VERSION_FILENAME);
@ -188,7 +188,7 @@ fn python_pin() {
Updated `.python-version` from `pypy` -> `3.7` Updated `.python-version` from `pypy` -> `3.7`
----- stderr ----- ----- stderr -----
warning: No interpreter found for Python 3.7 in managed installations or system path warning: No interpreter found for Python 3.7 in managed installations or search path
"###); "###);
let python_version = context.read(PYTHON_VERSION_FILENAME); let python_version = context.read(PYTHON_VERSION_FILENAME);
@ -212,7 +212,7 @@ fn python_pin_no_python() {
Pinned `.python-version` to `3.12` Pinned `.python-version` to `3.12`
----- stderr ----- ----- stderr -----
warning: No interpreter found for Python 3.12 in managed installations or system path warning: No interpreter found for Python 3.12 in managed installations or search path
"###); "###);
} }
@ -411,7 +411,7 @@ fn warning_pinned_python_version_not_installed() -> anyhow::Result<()> {
3.12 3.12
----- stderr ----- ----- stderr -----
warning: Failed to resolve pinned Python version `3.12`: No interpreter found for Python 3.12 in managed installations, system path, or `py` launcher warning: Failed to resolve pinned Python version `3.12`: No interpreter found for Python 3.12 in managed installations, search path, or registry
"###); "###);
} else { } else {
uv_snapshot!(context.filters(), context.python_pin(), @r###" uv_snapshot!(context.filters(), context.python_pin(), @r###"
@ -421,7 +421,7 @@ fn warning_pinned_python_version_not_installed() -> anyhow::Result<()> {
3.12 3.12
----- stderr ----- ----- stderr -----
warning: Failed to resolve pinned Python version `3.12`: No interpreter found for Python 3.12 in managed installations or system path warning: Failed to resolve pinned Python version `3.12`: No interpreter found for Python 3.12 in managed installations or search path
"###); "###);
} }
@ -440,7 +440,7 @@ fn python_pin_resolve_no_python() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for Python 3.12 in managed installations, system path, or `py` launcher error: No interpreter found for Python 3.12 in managed installations, search path, or registry
"###); "###);
} else { } else {
uv_snapshot!(context.filters(), context.python_pin().arg("--resolved").arg("3.12"), @r###" uv_snapshot!(context.filters(), context.python_pin().arg("--resolved").arg("3.12"), @r###"
@ -449,7 +449,7 @@ fn python_pin_resolve_no_python() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for Python 3.12 in managed installations or system path error: No interpreter found for Python 3.12 in managed installations or search path
"###); "###);
} }
} }
@ -605,7 +605,7 @@ fn python_pin_resolve() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for PyPy in managed installations or system path error: No interpreter found for PyPy in managed installations or search path
"###); "###);
let python_version = context.read(PYTHON_VERSION_FILENAME); let python_version = context.read(PYTHON_VERSION_FILENAME);
@ -626,7 +626,7 @@ fn python_pin_resolve() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
error: No interpreter found for Python 3.7 in managed installations or system path error: No interpreter found for Python 3.7 in managed installations or search path
"###); "###);
let python_version = context.read(PYTHON_VERSION_FILENAME); let python_version = context.read(PYTHON_VERSION_FILENAME);

8
crates/uv/tests/it/venv.rs
View file

@ -605,7 +605,7 @@ fn create_venv_unknown_python_minor() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
× No interpreter found for Python 3.100 in managed installations, system path, or `py` launcher × No interpreter found for Python 3.100 in managed installations, search path, or registry
"### "###
); );
} else { } else {
@ -615,7 +615,7 @@ fn create_venv_unknown_python_minor() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
× No interpreter found for Python 3.100 in managed installations or system path × No interpreter found for Python 3.100 in managed installations or search path
"### "###
); );
} }
@ -643,7 +643,7 @@ fn create_venv_unknown_python_patch() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
× No interpreter found for Python 3.12.100 in managed installations, system path, or `py` launcher × No interpreter found for Python 3.12.100 in managed installations, search path, or registry
"### "###
); );
} else { } else {
@ -653,7 +653,7 @@ fn create_venv_unknown_python_patch() {
----- stdout ----- ----- stdout -----
----- stderr ----- ----- stderr -----
× No interpreter found for Python 3.12.100 in managed installations or system path × No interpreter found for Python 3.12.100 in managed installations or search path
"### "###
); );
} }

2
docs/reference/cli.md
View file

@ -4142,7 +4142,7 @@ environment is not required, uv will then search for a Python interpreter. Pytho
interpreters are found by searching for Python executables in the `PATH` environment interpreters are found by searching for Python executables in the `PATH` environment
variable. variable.
On Windows, the `py` launcher is also invoked to find Python executables. On Windows, the registry is also searched for Python executables.
By default, uv will download Python if a version cannot be found. This behavior can be By default, uv will download Python if a version cannot be found. This behavior can be
disabled with the `--no-python-downloads` flag or the `python-downloads` setting. disabled with the `--no-python-downloads` flag or the `python-downloads` setting.