Allow user to constrain supported lock environments #6210

charliermarsh · 2024-08-19T16:31:44Z

Summary

The strategy here is: if the user provides supported environments, we use those as the initial forks when resolving. As a result, we never add or explore branches that are disjoint with the supported environments. (If the supported environments change, we ignore the lockfile entirely, so we don't have to worry about any interactions between supported environments and the preference forks.)

Closes #6184.

charliermarsh · 2024-08-19T16:32:04Z

crates/uv-resolver/src/lock.rs

@@ -951,6 +979,8 @@ struct LockWire {
    /// forks in the lockfile so we can recreate them in subsequent resolutions.
    #[serde(rename = "environment-markers", default)]
    fork_markers: Vec<MarkerTree>,
+    #[serde(rename = "supported-markers", default)]
+    supported_environments: Vec<MarkerTree>,


I am tempted to rename these to: resolution-markers and supported-markers (i.e., rename environment-markers).

crates/uv/tests/lock.rs

konstin · 2024-08-19T16:55:01Z

crates/uv-workspace/src/environments.rs

+}
+
+/// Serialize a [`SupportedEnvironments`] struct into a list of marker strings.
+impl serde::Serialize for SupportedEnvironments {


Is the difference from the auto-derive here that we drop empty markers that the user may have written?

We support providing a string or a list of strings -- either is fine.

crates/uv-workspace/src/environments.rs

konstin · 2024-08-19T16:58:44Z

crates/uv/src/commands/project/lock.rs

-        if !upgrade.is_none() {
-            debug!("Ignoring existing lockfile due to `--upgrade`");
-            return Ok(Self::Preferable(lock));
+        // If the set of supported environments has changed, we have to perform a clean resolution.


Can we not reuse the preferences still?

Would we ignore the fork preferences though?

I think we should ignore fork preferences but reuse the package preferences

crates/uv/src/commands/project/lock.rs

zanieb · 2024-08-19T17:52:26Z

Ideally would be documented in the project or resolver concept document too.

charliermarsh · 2024-08-20T04:15:03Z

Ok, modified the behavior to require disjoint forks.

charliermarsh · 2024-08-20T04:19:57Z

Also added docs.

zanieb · 2024-08-20T13:04:10Z

docs/concepts/projects.md

+If your project supports a more limited set of platforms or Python versions, you can constrain the
+set of solved platforms via the `environments` setting, which accepts a list of PEP 508 environment
+markers. For example, to constrain the lockfile to macOS and Linux, and exclude Windows:


Any note that these need to be disjoint?

(and what that means)

## Summary I probably won't land #6210 for the release, but I do want to make one breaking change to prep for it: renaming `environment-markers` to `resolution-markers` (or `solution-markers`?) so that it's delineated from the user-defined markers in that PR.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | minor | `0.2.37` -> `0.3.0` | 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.3.0`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#030) [Compare Source](astral-sh/uv@0.2.37...0.3.0) This release introduces the uv [project](https://docs.astral.sh/uv/guides/projects/), [tool](https://docs.astral.sh/uv/guides/tools/), [script](https://docs.astral.sh/uv/guides/scripts/), and [python](https://docs.astral.sh/uv/guides/install-python/) interfaces. If you've been following uv's development, you've probably seen these new commands behind a preview flag. Now, the interfaces are stable and ready for production-use. These features are all documented in [new, comprehensive documentation](https://docs.astral.sh/uv/). This release also stabilizes preview functionality in `uv venv`: - `uv venv --python <version>` will [automatically download](https://docs.astral.sh/uv/concepts/python-versions/#requesting-a-version) the Python version if required - `uv venv` will read the required Python version from the `.python-version` file or `pyproject.toml` The `uv pip` interface should not be affected by any breaking changes. Note the following changelog entries does not include all the new features since they were added incrementally as preview features. See the [feature page](https://docs.astral.sh/uv/getting-started/features/) in the documentation for a comprehensive listing, or read the [blog post](https://astral.sh/blog/uv-unified-python-packaging) for more context on the new features. ##### Breaking changes - Migrate to XDG and Linux strategy for macOS directories ([#5806](astral-sh/uv#5806)) - Move concurrency settings to top-level ([#4257](astral-sh/uv#4257)) - Apply system Python filtering to executable name requests ([#4309](astral-sh/uv#4309)) - Remove `--legacy-setup-py` command-line argument ([#4255](astral-sh/uv#4255)) - Stabilize preview features ([#6166](astral-sh/uv#6166)) ##### Enhancements - Add 32-bit Windows target ([#6252](astral-sh/uv#6252)) - Add support for `python_version in ...` markers ([#6172](astral-sh/uv#6172)) - Allow user to constrain supported lock environments ([#6210](astral-sh/uv#6210)) - Lift requirement that .egg-info filenames must include version ([#6179](astral-sh/uv#6179)) - Change "any of" to "all of" in error messages ([#6222](astral-sh/uv#6222)) - Collapse redundant dependency clauses enumerating available versions ([#6160](astral-sh/uv#6160)) - Collapse unavailable packages in resolver errors ([#6154](astral-sh/uv#6154)) - Fix messages for unavailable packages when range is plural ([#6221](astral-sh/uv#6221)) - Improve resolver error messages when `--offline` is used ([#6156](astral-sh/uv#6156)) - Avoid overwriting dependencies with different markers in `uv add` ([#6010](astral-sh/uv#6010)) - Simplify available package version ranges when the name includes markers or extras ([#6162](astral-sh/uv#6162)) - Simplify version ranges reported for unavailable packages ([#6155](astral-sh/uv#6155)) - Rename `environment-markers` to `resolution-markers` ([#6240](astral-sh/uv#6240)) - Support `uv add -r requirements.txt` ([#6005](astral-sh/uv#6005)) ##### CLI - Hide global options in `uv generate-shell-completion` ([#6170](astral-sh/uv#6170)) - Show generate-shell-completion command in `uv help` ([#6180](astral-sh/uv#6180)) - Special-case reinstalls in environment update summaries ([#6243](astral-sh/uv#6243)) - Add output when `uv add` and `uv remove` update scripts ([#6231](astral-sh/uv#6231)) - Add support for `package@latest` in `tool run` ([#6138](astral-sh/uv#6138)) - Show `python find` output with `-q` ([#6256](astral-sh/uv#6256)) - Warn when `--upgrade` is passed to `tool run` ([#6140](astral-sh/uv#6140)) ##### Configuration - Allow customizing the tool install directory with `UV_TOOL_BIN_DIR` ([#6207](astral-sh/uv#6207)) ##### Performance - Use `FxHash` in `uv-auth` ([#6149](astral-sh/uv#6149)) ##### Bug fixes - Avoid panicking when the resolver thread encounters a closed channel ([#6182](astral-sh/uv#6182)) - Respect release-only semantics of `python_full_version` when constructing markers ([#6171](astral-sh/uv#6171)) - Tolerate missing `[project]` table in `uv venv` ([#6178](astral-sh/uv#6178)) - Avoid using workspace `lock_path` as relative root ([#6157](astral-sh/uv#6157)) ##### Documentation - Preview changes are now included in the standard changelog ([#6259](astral-sh/uv#6259)) - Document dynamic metadata behavior for cache ([#5993](astral-sh/uv#5993)) - Document the effect of ordering on package priority ([#6211](astral-sh/uv#6211)) - Make some edits to the workspace concept documentation ([#6223](astral-sh/uv#6223)) - Update environment variables doc ([#5994](astral-sh/uv#5994)) - Disable collapsible navigation in the documentation ([#5674](astral-sh/uv#5674)) - Document `uv add` and `uv remove` behavior with markers ([#6163](astral-sh/uv#6163)) - Document the Python installation directory ([#6227](astral-sh/uv#6227)) - Document the `uv.pip` section semantics ([#6225](astral-sh/uv#6225)) - Document the cache directory ([#6229](astral-sh/uv#6229)) - Document the tools directory ([#6228](astral-sh/uv#6228)) - Document yanked packages caveat during sync ([#6219](astral-sh/uv#6219)) - Link to persistent configuration options in Python versions document ([#6226](astral-sh/uv#6226)) - Link to the projects concept from the dependencies concept ([#6224](astral-sh/uv#6224)) - Improvements to the Docker installation guide ([#6216](astral-sh/uv#6216)) - Increase the size of navigation entries ([#6233](astral-sh/uv#6233)) - Install `ca-certificates` in docker and use pipefail ([#6208](astral-sh/uv#6208)) - Add script support to feature highlights in index ([#6251](astral-sh/uv#6251)) - Show `uv generate-shell-completion` in CLI documentation reference ([#6146](astral-sh/uv#6146)) - Update Docker guide for projects ([#6217](astral-sh/uv#6217)) - Use `uv add --script` in guide ([#6215](astral-sh/uv#6215)) - Show pinned version example on in GitHub Actions integration guide ([#6234](astral-sh/uv#6234)) </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. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

charliermarsh commented Aug 19, 2024

View reviewed changes

charliermarsh requested review from BurntSushi, zanieb and konstin August 19, 2024 16:32

charliermarsh force-pushed the charlie/supported-environments branch from c4267c9 to cb5f932 Compare August 19, 2024 16:32

charliermarsh added enhancement New feature or improvement to existing functionality preview Experimental behavior lock Related to universal resolution and locking labels Aug 19, 2024

charliermarsh commented Aug 19, 2024

View reviewed changes

crates/uv/tests/lock.rs Show resolved Hide resolved

charliermarsh force-pushed the charlie/supported-environments branch from cb5f932 to 5f3ab0d Compare August 19, 2024 16:40

konstin approved these changes Aug 19, 2024

View reviewed changes

konstin reviewed Aug 19, 2024

View reviewed changes

crates/uv/src/commands/project/lock.rs Show resolved Hide resolved

charliermarsh mentioned this pull request Aug 20, 2024

Rename environment-markers to resolution-markers #6240

Merged

charliermarsh force-pushed the charlie/supported-environments branch from 5f3ab0d to 82a6d24 Compare August 20, 2024 04:12

charliermarsh force-pushed the charlie/supported-environments branch from 82a6d24 to 43784e0 Compare August 20, 2024 04:19

charliermarsh force-pushed the charlie/supported-environments branch from 43784e0 to 31179bf Compare August 20, 2024 04:21

zanieb reviewed Aug 20, 2024

View reviewed changes

BurntSushi approved these changes Aug 20, 2024

View reviewed changes

charliermarsh added 2 commits August 20, 2024 09:17

Allow user to constrain supported lock environments

dab396c

Require disjoint

ded478a

charliermarsh force-pushed the charlie/supported-environments branch from 31179bf to ded478a Compare August 20, 2024 13:20

charliermarsh enabled auto-merge (squash) August 20, 2024 13:20

charliermarsh merged commit 3395d24 into main Aug 20, 2024
56 checks passed

charliermarsh deleted the charlie/supported-environments branch August 20, 2024 13:28

BrewTestBot mentioned this pull request Aug 20, 2024

uv 0.3.0 Homebrew/homebrew-core#181837

Merged

zanieb mentioned this pull request Aug 23, 2024

uv lock and platform-specific resolution #6503

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow user to constrain supported lock environments #6210

Allow user to constrain supported lock environments #6210

charliermarsh commented Aug 19, 2024 •

edited

Loading

charliermarsh Aug 19, 2024 •

edited

Loading

konstin Aug 19, 2024

charliermarsh Aug 20, 2024

konstin Aug 19, 2024

charliermarsh Aug 19, 2024

konstin Aug 19, 2024

zanieb commented Aug 19, 2024 •

edited

Loading

charliermarsh commented Aug 20, 2024 •

edited

Loading

charliermarsh commented Aug 20, 2024

zanieb Aug 20, 2024

zanieb Aug 20, 2024

Allow user to constrain supported lock environments #6210

Allow user to constrain supported lock environments #6210

Conversation

charliermarsh commented Aug 19, 2024 • edited Loading

Summary

charliermarsh Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

konstin Aug 19, 2024

Choose a reason for hiding this comment

charliermarsh Aug 20, 2024

Choose a reason for hiding this comment

konstin Aug 19, 2024

Choose a reason for hiding this comment

charliermarsh Aug 19, 2024

Choose a reason for hiding this comment

konstin Aug 19, 2024

Choose a reason for hiding this comment

zanieb commented Aug 19, 2024 • edited Loading

charliermarsh commented Aug 20, 2024 • edited Loading

charliermarsh commented Aug 20, 2024

zanieb Aug 20, 2024

Choose a reason for hiding this comment

zanieb Aug 20, 2024

Choose a reason for hiding this comment

charliermarsh commented Aug 19, 2024 •

edited

Loading

charliermarsh Aug 19, 2024 •

edited

Loading

zanieb commented Aug 19, 2024 •

edited

Loading

charliermarsh commented Aug 20, 2024 •

edited

Loading