Sort dependency group keys when adding new group #11591

jtfmumm · 2025-02-18T09:25:03Z

This change keeps dependency group keys sorted when adding new ones.

If earlier dependency group keys were not sorted, we just append the new group key to avoid churn in pyproject.toml. See discussion on #11447. I've added a new snapshot test to capture this case.

Closes #11447.

However, if earlier keys were not sorted, we just append to avoid churn.

charliermarsh · 2025-02-18T14:25:37Z

crates/uv/tests/it/edit.rs

@@ -4826,6 +4826,112 @@ fn add_group() -> Result<()> {

    let pyproject_toml = context.read("pyproject.toml");

+    insta::with_settings!({


Can we add a few test cases where there are comments between the groups, to understand how they move around?

👍 this is an unfortunately frequent cause of bug reports

Added two new tests

zanieb · 2025-02-18T14:33:43Z

crates/uv/tests/it/edit.rs

@@ -4826,6 +4826,112 @@ fn add_group() -> Result<()> {

    let pyproject_toml = context.read("pyproject.toml");

+    insta::with_settings!({
+        filters => context.filters(),


Random, but it doesn't actually look like you need the filters for this snapshot. You could reduce nesting by omitting them — but I don't mind either way.

Removed filters on these tests

T-256 · 2025-02-18T16:43:41Z

crates/uv/tests/it/edit.rs

+        [dependency-groups]
+        alpha = [
+            "anyio==3.7.0",
+        ]
+        # This is our dev group
+        dev = [
+            "anyio==3.7.0",
+        ]


Could sort default-groups separately and put them in top-most priority?

(it is implicitly set to tool.uv.default-groups = ["dev"])

I think I'd prefer not to do that, otherwise when you change your default groups the ordering is unsorted and we won't respect it anymore. Though it is interesting.

Correct, I would like to see it as a lint rule in future.

charliermarsh · 2025-02-18T17:48:35Z

crates/uv-workspace/src/pyproject_mut.rs

+            .iter()
+            .filter_map(|(dotted_ks, _)| dotted_ks.first())
+            .map(|k| k.get())
+            .is_sorted();


The logic we use for detecting sorted dependencies is a bit more complex. Specifically, we check whether the values are sorted case-insensitively or case-sensitively, and then respect that sort if so. We could do the same here, but I don't consider it blocking (it seems pretty rare for users to use capitalization in these identifiers, unlike in package names).

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.6.0` -> `0.6.3` | 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.3`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#063) [Compare Source](astral-sh/uv@0.6.2...0.6.3) ##### Enhancements - Allow quotes around command-line options in `requirement.txt files` ([#11644](astral-sh/uv#11644)) - Initialize PEP 723 script in `uv lock --script` ([#11717](astral-sh/uv#11717)) ##### Configuration - Accept multiple `.env` files in `UV_ENV_FILE` ([#11665](astral-sh/uv#11665)) ##### Performance - Reduce overhead in converting resolutions ([#11660](astral-sh/uv#11660)) - Use `SmallString` on `Hashes` ([#11756](astral-sh/uv#11756)) - Use a `Box` for `Yanked` on `File` ([#11755](astral-sh/uv#11755)) - Use a `SmallString` for the `Yanked` enum ([#11715](astral-sh/uv#11715)) - Use boxed slices for hash vector ([#11714](astral-sh/uv#11714)) - Use install concurrency for bytecode compilation too ([#11615](astral-sh/uv#11615)) ##### Bug fixes - Avoid installing duplicate dependencies across conflicting groups ([#11653](astral-sh/uv#11653)) - Check subdirectory existence after cache heal ([#11719](astral-sh/uv#11719)) - Include uppercase platforms for Windows wheels ([#11681](astral-sh/uv#11681)) - Respect existing PEP 723 script settings in `uv add` ([#11716](astral-sh/uv#11716)) - Reuse refined interpreter to create tool environment ([#11680](astral-sh/uv#11680)) - Skip removed directories during bytecode compilation ([#11633](astral-sh/uv#11633)) - Support conflict markers in `uv export` ([#11643](astral-sh/uv#11643)) - Treat lockfile as outdated if (empty) extras are added ([#11702](astral-sh/uv#11702)) - Display path separators as backslashes on Windows ([#11667](astral-sh/uv#11667)) - Display the built file name instead of the canonicalized name in `uv build` ([#11593](astral-sh/uv#11593)) - Fix message when there are no buildable packages ([#11722](astral-sh/uv#11722)) - Re-allow HTTP schemes for Git dependencies ([#11687](astral-sh/uv#11687)) ##### Documentation - Add anchor links to arguments and options in the CLI reference ([#11754](astral-sh/uv#11754)) - Add link to environment marker specification ([#11748](astral-sh/uv#11748)) - Fix missing a closing bracket in the `cache-keys` setting ([#11669](astral-sh/uv#11669)) - Remove the last edited date from documentation pages ([#11753](astral-sh/uv#11753)) - Fix readme typo ([#11742](astral-sh/uv#11742)) ### [`v0.6.2`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#062) [Compare Source](astral-sh/uv@0.6.1...0.6.2) ##### Enhancements - Add support for constraining build dependencies with `tool.uv.build-constraint-dependencies` ([#11585](astral-sh/uv#11585)) - Sort dependency group keys when adding new group ([#11591](astral-sh/uv#11591)) ##### Performance - Use an `Arc` for index URLs ([#11586](astral-sh/uv#11586)) ##### Bug fixes - Allow use of x86-64 Python on ARM Windows ([#11625](astral-sh/uv#11625)) - Fix an issue where conflict markers could instigate a very large lock file ([#11293](astral-sh/uv#11293)) - Fix duplicate packages with multiple conflicting extras declared ([#11513](astral-sh/uv#11513)) - Respect color settings for log messages ([#11604](astral-sh/uv#11604)) - Eagerly reject unsupported Git schemes ([#11514](astral-sh/uv#11514)) ##### Documentation - Add documentation for specifying Python versions in tool commands ([#11598](astral-sh/uv#11598)) ### [`v0.6.1`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#061) [Compare Source](astral-sh/uv@0.6.0...0.6.1) ##### Enhancements - Allow users to mark platforms as "required" for wheel coverage ([#10067](astral-sh/uv#10067)) - Warn for builds in non-build and workspace root pyproject.toml ([#11394](astral-sh/uv#11394)) ##### Bug fixes - Add `--all` to `uvx --reinstall` message ([#11535](astral-sh/uv#11535)) - Fallback to `GET` on HTTP 400 when attempting to use range requests for wheel download ([#11539](astral-sh/uv#11539)) - Prefer local variants in preference selection ([#11546](astral-sh/uv#11546)) - Respect verbatim executable name in `uvx` ([#11524](astral-sh/uv#11524)) ##### Documentation - Add documentation for required environments ([#11542](astral-sh/uv#11542)) - Note that `main.py` used to be `hello.py` ([#11519](astral-sh/uv#11519)) </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).

Sort dependency group keys when adding new group

58fa23f

However, if earlier keys were not sorted, we just append to avoid churn.

jtfmumm force-pushed the jtfm/sorted-entries branch from 2ee5ea8 to 58fa23f Compare February 18, 2025 09:28

jtfmumm requested a review from zanieb February 18, 2025 10:16

charliermarsh reviewed Feb 18, 2025

View reviewed changes

zanieb reviewed Feb 18, 2025

View reviewed changes

Add tests with commented groups and remove filters

31cc72b

T-256 reviewed Feb 18, 2025

View reviewed changes

zanieb approved these changes Feb 18, 2025

View reviewed changes

charliermarsh approved these changes Feb 18, 2025

View reviewed changes

charliermarsh reviewed Feb 18, 2025

View reviewed changes

jtfmumm merged commit b086437 into main Feb 18, 2025
73 checks passed

jtfmumm deleted the jtfm/sorted-entries branch February 18, 2025 18:12

BrewTestBot mentioned this pull request Feb 19, 2025

uv 0.6.2 Homebrew/homebrew-core#208313

Merged

jtfmumm added enhancement New feature or improvement to existing functionality and removed enhancement New feature or improvement to existing functionality labels Feb 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sort dependency group keys when adding new group #11591

Sort dependency group keys when adding new group #11591

jtfmumm commented Feb 18, 2025

charliermarsh Feb 18, 2025

zanieb Feb 18, 2025

jtfmumm Feb 18, 2025

zanieb Feb 18, 2025

jtfmumm Feb 18, 2025

T-256 Feb 18, 2025 •

edited

Loading

zanieb Feb 18, 2025

T-256 Feb 18, 2025

charliermarsh Feb 18, 2025

		@@ -4826,6 +4826,112 @@ fn add_group() -> Result<()> {

		let pyproject_toml = context.read("pyproject.toml");

		insta::with_settings!({

Sort dependency group keys when adding new group #11591

Sort dependency group keys when adding new group #11591

Conversation

jtfmumm commented Feb 18, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

T-256 Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

T-256 Feb 18, 2025 •

edited

Loading