mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-08-30 23:37:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix some outdated documentation discussing Python environments (#6058)

Browse source 
Starting on https://github.com/astral-sh/uv/issues/5966 noticed various
problems
This commit is contained in:
Zanie Blue 2024-08-13 11:47:39 -05:00 • committed by GitHub
parent ef948619ee
commit e8876ada6d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 12 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/concepts/python-versions.md
View file

@ -134,20 +134,6 @@ To exclude downloads and only show installed Python versions:
$ uv python list --only-installed
```
## Discovery of virtual environments
Some uv commands may use a Python interpreter from a virtual environment. When searching for virtual
environments, uv prioritizes (in order):
- The `VIRTUAL_ENV` environment variable.
- The `CONDA_PREFIX` environment variable.
- A `.venv` directory in the working directory.
- A `.venv` directory in any parent directory.
After exhausting these possibilities, uv will either
[search for a Python installation](#discovery-of-python-versions) or exit with an error if the
command requires a virtual environment.
## Discovery of Python versions
When searching for a Python version, the following locations are checked:
@ -158,6 +144,12 @@ When searching for a Python version, the following locations are checked:
- On Windows, the Python interpreter returned by `py --list-paths` that matches the requested
version.
In some cases, uv allows using a Python version from a virtual environment. In this case, the
virtual environment's interpreter will be checked for compatibility with the request before
searching for an installation as described above. See the
[pip-compatible virtual environment discovery](../pip/environments.md#discovery-of-python-environments)
documentation for details.
When performing discovery, non-executable files will be ignored. Each discovered executable is
queried for metadata to ensure it meets the [requested Python version](#requesting-a-version). If
the query fails, the executable will be skipped. If the executable satisfies the request, it is used