Document the Python installation directory

astral-sh · Aug 19, 2024 · 61487e1 · 61487e1
1 parent ea3db27
commit 61487e1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs
@@ -2948,6 +2948,12 @@ pub enum PythonCommand {
     Pin(PythonPinArgs),
 
     /// Show the uv Python installation directory.
+    ///
+    /// By default, Python installations are stored in the uv data directory at
+    /// `$XDG_DATA_HOME/uv/python` or `$HOME/.local/share/uv/python` on Unix and
+    /// `{FOLDERID_RoamingAppData}\uv\data\python` on Windows.
+    ///
+    /// The Python installation directory may be overridden with `$UV_PYTHON_INSTALL_DIR`.
     Dir,
 
     /// Uninstall Python versions.

diff --git a/crates/uv-state/src/lib.rs b/crates/uv-state/src/lib.rs
@@ -75,6 +75,7 @@ impl StateStore {
     }
 
     /// Prefer, in order:
+    ///
     /// 1. The specific state directory specified by the user.
     /// 2. The system-appropriate user-level data directory.
     /// 3. A `.uv` directory in the current working directory.

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -3328,7 +3328,11 @@ uv python pin [OPTIONS] [REQUEST]
 
 ### uv python dir
 
-Show the uv Python installation directory
+Show the uv Python installation directory.
+
+By default, Python installations are stored in the uv data directory at `$XDG_DATA_HOME/uv/python` or `$HOME/.local/share/uv/python` on Unix and `{FOLDERID_RoamingAppData}\uv\data\python` on Windows.
+
+The Python installation directory may be overridden with `$UV_PYTHON_INSTALL_DIR`.
 
 <h3 class="cli-reference">Usage</h3>