Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for global uv python pin #12115

Merged
merged 7 commits into from
Mar 13, 2025
Merged

Add support for global uv python pin #12115

merged 7 commits into from
Mar 13, 2025

Conversation

jtfmumm
Copy link
Contributor

@jtfmumm jtfmumm commented Mar 11, 2025

These changes add support for

uv python pin 3.12 --global 

This adds the specified version to a .python-version file in the user-level config directory. uv will now use the user-level version as a fallback if no version is found in the project directory or its ancestors.

Open question: is --global the correct parameter here? --user is more precise, but might not communicate the intent as clearly.

TODO: User documentation.

Closes #4972

Comment on lines 245 to 260
insta::with_settings!({
filters => context.filters(),
}, {
// We should have a tool receipt
assert_snapshot!(fs_err::read_to_string(tool_dir.join("black").join("uv-receipt.toml")).unwrap(), @r###"
[tool]
requirements = [{ name = "black" }]
entrypoints = [
{ name = "black", install-path = "[TEMP_DIR]/bin/black" },
{ name = "blackd", install-path = "[TEMP_DIR]/bin/blackd" },
]

[tool.options]
exclude-newer = "2024-03-25T00:00:00Z"
"###);
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't capture the Python version in the receipt. This is actually relevant. What happens if the global Python version changes then you reinstall or upgrade? Test coverage for that would good. I think it's fine to respect the changed global default, personally.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a FIXME with some commented out new test code in this test for the reinstall case. This test code fails: currently uv doesn't respect the global on reinstall (and just uses the version originally used). Do we want this functionality for this PR?

Copy link
Member

@zanieb zanieb Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah okay, thanks for clarifying.

I would expect

  • If I requested a version explicitly, e.g., uv tool install --python <version> I'd expect it to be recorded in the receipt and reused on reinstall
  • If I did not, I would expect the version to change on reinstall if the global default changed

However, I don't feel strongly about the latter point and if it's an entirely different model than what we're doing today then let's just leave it as-is and consider it separately (I'd open an issue to track it).

Either way, test coverage seems great.

return Ok(None);
// Not found in directory or its ancestors. Looking in user-level config.
return Ok(match user_uv_config_dir() {
Some(user_dir) => Self::discover_user_config(user_dir, options)
Copy link
Member

@zanieb zanieb Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should co-locate this with the uv.toml? Like, if

pub fn system_config_file() -> Option<PathBuf> {
exists and a user-level config does not should we prefer that? I'm leaning away from it right now, but wanted to put the idea out there. Maybe can can consider a --system flag separately in the future once we have more feedback.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's an interesting question. But I agree we should consider it separately from this PR.

@samypr100
Copy link
Collaborator

samypr100 commented Mar 12, 2025

These changes add support for

uv python pin 3.12 --global 

This adds the specified version to a .python-version file in the user-level config directory. uv will now use the user-level version as a fallback if no version is found in the project directory or its ancestors.

Open question: is --global the correct parameter here? --user is more precise, but might not communicate the intent as clearly.

TODO: User documentation.

Closes #4972

I do lean towards --global. For example, git uses --global, --local, and --system.

}

#[test]
fn python_pin_global_use_local_if_available() -> Result<()> {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd still just recommend combining this test with the one above and calling it python_pin_global since we tend to discuss the specific behavior we are testing in a comment above each invocation. This isn't blocking feedback though

Copy link
Member

@zanieb zanieb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should only require some brief docs in https://docs.astral.sh/uv/concepts/python-versions/#python-version-files

@jtfmumm jtfmumm merged commit 797f1fb into main Mar 13, 2025
99 checks passed
@jtfmumm jtfmumm deleted the jtfm/python-pin-global branch March 13, 2025 12:48
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Mar 24, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.6.5` -> `0.6.9` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>astral-sh/uv (astral-sh/uv)</summary>

### [`v0.6.9`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#069)

[Compare Source](astral-sh/uv@0.6.8...0.6.9)

##### Enhancements

-   Use `keyring --mode creds` when `authenticate = "always"` ([#&#8203;12316](astral-sh/uv#12316))
-   Fail with specific error message when no password is present and `authenticate = "always"` ([#&#8203;12313](astral-sh/uv#12313))

##### Bug fixes

-   Add boolish value parser for `UV_MANAGED_PYTHON` flags ([#&#8203;12345](astral-sh/uv#12345))
-   Make deserialization non-fatal when assessing source tree revisions ([#&#8203;12319](astral-sh/uv#12319))
-   Use resolver-returned wheel over alternate cached wheel ([#&#8203;12301](astral-sh/uv#12301))

##### Documentation

-   Add experimental `--torch-backend` to the PyTorch guide ([#&#8203;12317](astral-sh/uv#12317))
-   Fix `#keyring-provider` references in alternative index docs ([#&#8203;12315](astral-sh/uv#12315))
-   Fix `--directory` path in examples ([#&#8203;12165](astral-sh/uv#12165))

##### Preview changes

-   Automatically infer the PyTorch index via `--torch-backend=auto` ([#&#8203;12070](astral-sh/uv#12070))

### [`v0.6.8`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#068)

[Compare Source](astral-sh/uv@0.6.7...0.6.8)

##### Enhancements

-   Add support for enabling all groups by default with `default-groups = "all"` ([#&#8203;12289](astral-sh/uv#12289))
-   Add simpler `--managed-python` and `--no-managed-python` flags for toggling Python preferences ([#&#8203;12246](astral-sh/uv#12246))

##### Performance

-   Avoid allocations for default cache keys ([#&#8203;12063](astral-sh/uv#12063))

##### Bug fixes

-   Allow local version mismatches when validating lockfile ([#&#8203;12285](astral-sh/uv#12285))
-   Allow owned string when deserializing `requires-python` ([#&#8203;12278](astral-sh/uv#12278))
-   Make cache errors non-fatal in `Planner::build` ([#&#8203;12281](astral-sh/uv#12281))

### [`v0.6.7`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#067)

[Compare Source](astral-sh/uv@0.6.6...0.6.7)

##### Python

-   Add CPython 3.14.0a6
-   Fix regression where extension modules would use wrong `CXX` compiler on Linux
-   Enable FTS3 enhanced query syntax for SQLite

See the [`python-build-standalone` release notes](https://github.com/astral-sh/python-build-standalone/releases/tag/20250317) for more details.

##### Enhancements

-   Add support for `-c` constraints in `uv add` ([#&#8203;12209](astral-sh/uv#12209))
-   Add support for `--global` default version in `uv python pin` ([#&#8203;12115](astral-sh/uv#12115))
-   Always reinstall local source trees passed to `uv pip install` ([#&#8203;12176](astral-sh/uv#12176))
-   Render token claims on publish permission error ([#&#8203;12135](astral-sh/uv#12135))
-   Add pip-compatible `--group` flag to `uv pip install` and `uv pip compile` ([#&#8203;11686](astral-sh/uv#11686))

##### Preview features

-   Avoid creating duplicate directory entries in built wheels ([#&#8203;12206](astral-sh/uv#12206))
-   Allow overriding module names for editable builds ([#&#8203;12137](astral-sh/uv#12137))

##### Performance

-   Avoid replicating core-metadata field on `File` struct ([#&#8203;12159](astral-sh/uv#12159))

##### Bug fixes

-   Add `src` to default cache keys ([#&#8203;12062](astral-sh/uv#12062))
-   Discard insufficient fork markers ([#&#8203;10682](astral-sh/uv#10682))
-   Ensure `python pin --global` creates parent directories if missing ([#&#8203;12180](astral-sh/uv#12180))
-   Fix GraalPy abi tag parsing and discovery ([#&#8203;12154](astral-sh/uv#12154))
-   Remove extraneous script packages in `uv sync --script` ([#&#8203;12158](astral-sh/uv#12158))
-   Remove redundant `activate.bat` output ([#&#8203;12160](astral-sh/uv#12160))
-   Avoid subsequent index hint when no versions are available on the first index ([#&#8203;9332](astral-sh/uv#9332))
-   Error on lockfiles with incoherent wheel versions ([#&#8203;12235](astral-sh/uv#12235))

##### Rust API

-   Update `BaseClientBuild` to accept custom proxies ([#&#8203;12232](astral-sh/uv#12232))

##### Documentation

-   Make testpypi index explicit in example snippet ([#&#8203;12148](astral-sh/uv#12148))
-   Reverse and format the archived changelogs ([#&#8203;12099](astral-sh/uv#12099))
-   Use consistent commas around i.e. and e.g. ([#&#8203;12157](astral-sh/uv#12157))
-   Fix typos in MRE docs ([#&#8203;12198](astral-sh/uv#12198))
-   Fix double space typo ([#&#8203;12171](astral-sh/uv#12171))

### [`v0.6.6`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#066)

[Compare Source](astral-sh/uv@0.6.5...0.6.6)

##### Python

-   Add support for dynamic musl Python distributions on x86-64 Linux ([#&#8203;12121](astral-sh/uv#12121))
-   Allow the experimental JIT to be enabled at runtime on Python 3.13 and 3.14 on Linux
-   Upgrade the build toolchain to LLVM 20, improving performance

See the [`python-build-standalone` release notes](https://github.com/astral-sh/python-build-standalone/releases/tag/20250311) for more details.

##### Enhancements

-   Add `--marker` flag to `uv add` ([#&#8203;12012](astral-sh/uv#12012))
-   Allow overriding module name for uv build backend ([#&#8203;11884](astral-sh/uv#11884))
-   Sync latest Python releases ([#&#8203;12120](astral-sh/uv#12120))
-   Use 'Upload' instead of 'Download' in publish reporter ([#&#8203;12029](astral-sh/uv#12029))
-   Add `[index].authenticate` allowing authentication to be required on an index ([#&#8203;11896](astral-sh/uv#11896))
-   Add support for Windows legacy scripts in `uv tool run` ([#&#8203;12079](astral-sh/uv#12079))
-   Propagate conflicting dependency groups when using `include-group` ([#&#8203;12005](astral-sh/uv#12005))
-   Show ambiguous requirements when `uv add` failed ([#&#8203;12106](astral-sh/uv#12106))

##### Performance

-   Cache workspace discovery ([#&#8203;12096](astral-sh/uv#12096))
-   Insert dependencies into fork state prior to fetching metadata ([#&#8203;12057](astral-sh/uv#12057))
-   Remove some allocations from `uv-auth` ([#&#8203;12077](astral-sh/uv#12077))

##### Bug fixes

-   Avoid considering `PATH` updated when the `export` is commented in the shellrc ([#&#8203;12043](astral-sh/uv#12043))
-   Fix `uv publish` retry on network failures ([#&#8203;12041](astral-sh/uv#12041))
-   Use a sized stream in `uv publish` to comply with WSGI PyPI server constraints ([#&#8203;12111](astral-sh/uv#12111))
-   Fix `uv python install --reinstall` when the version was not previously installed ([#&#8203;12124](astral-sh/uv#12124))

##### Preview features

-   Fix `uv_build` invocation ([#&#8203;12058](astral-sh/uv#12058))

##### Documentation

-   Quote versions string in `python-versions.md` ([#&#8203;12112](astral-sh/uv#12112))
-   Fix tool concept page headings ([#&#8203;12053](astral-sh/uv#12053))
-   Update the `[index].authenticate` docs ([#&#8203;12102](astral-sh/uv#12102))
-   Update versioning policy ([#&#8203;11666](astral-sh/uv#11666))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xOTQuMCIsInVwZGF0ZWRJblZlciI6IjM5LjIwOS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement to existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

uv python pin should support "global" pins
3 participants