Skip to content

Cache workspace discovery#12096

Merged
konstin merged 3 commits intomainfrom
konsti/cache-workspace-discovery
Mar 10, 2025
Merged

Cache workspace discovery#12096
konstin merged 3 commits intomainfrom
konsti/cache-workspace-discovery

Conversation

@konstin
Copy link
Member

@konstin konstin commented Mar 10, 2025

Reduce the overhead of uv run in large workspaces. Instead of re-discovering the entire workspace each time we resolve the metadata of a member, we can the discovered set of workspace members. Care needs to be taken to not cache the discovery for uv init, uv add and uv remove, which change the definitions of workspace members.

Below is apache airflow e3fe06382df4b19f2c0de40ce7c0bdc726754c74 uv run python with a minimal payload. With this change, we avoid a ~350ms overhead of each uv run invocation.

$ hyperfine --warmup 2 \
    "uv run --no-dev python -c \"print('hi')\"" \
    "uv-profiling run --no-dev python -c \"print('hi')\""
Benchmark 1: uv run --no-dev python -c "print('hi')"
  Time (mean ± σ):     492.6 ms ±   7.0 ms    [User: 393.2 ms, System: 97.1 ms]
  Range (min … max):   482.3 ms … 501.5 ms    10 runs
 
Benchmark 2: uv-profiling run --no-dev python -c "print('hi')"
  Time (mean ± σ):     129.7 ms ±   2.5 ms    [User: 105.4 ms, System: 23.2 ms]
  Range (min … max):   126.0 ms … 136.1 ms    22 runs
 
Summary
  uv-profiling run --no-dev python -c "print('hi')" ran
    3.80 ± 0.09 times faster than uv run --no-dev python -c "print('hi')"

The profile after those change below. We still spend a large chunk in toml parsing (both uv.lock and pyproject.toml), but it's not excessive anymore.

image

konstin added 3 commits March 10, 2025 12:59
Since this function causes the workspace discovery to depend on the current project, it prevents caching across runs
Reduce the overhead of `uv run` in large workspaces. Instead of re-discovering the entire workspace each time we resolve
the metadata of a member, we can the discovered set of workspace members. Care needs to be taken to not cache the
discovery for `uv init`, `uv add` and `uv remove`, which change the definitions of workspace members.

Below is apache airflow e3fe06382df4b19f2c0de40ce7c0bdc726754c74 `uv run python` with a minimal payload. With this
change, we avoid a ~350ms overhead of each `uv run` invocation.

```
$ hyperfine --warmup 2 \
    "uv run --no-dev python -c \"print('hi')\"" \
    "uv-profiling run --no-dev python -c \"print('hi')\""
Benchmark 1: uv run --no-dev python -c "print('hi')"
Time (mean ± σ):     493.2 ms ±   6.6 ms    [User: 396.0 ms, System: 96.1 ms]
Range (min … max):   481.8 ms … 500.9 ms    10 runs

Benchmark 2: uv-profiling run --no-dev python -c "print('hi')"
Time (mean ± σ):     143.9 ms ±   4.4 ms    [User: 120.5 ms, System: 22.3 ms]
Range (min … max):   137.5 ms … 154.9 ms    21 runs

Summary
uv-profiling run --no-dev python -c "print('hi')" ran
3.43 ± 0.11 times faster than uv run --no-dev python -c "print('hi')"
```
@konstin konstin added the performance Potential performance improvement label Mar 10, 2025
Comment on lines +684 to +687
let cache_key = WorkspaceCacheKey {
workspace_root: workspace_root.clone(),
discovery_options: options.clone(),
};
Copy link
Member Author

Choose a reason for hiding this comment

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

We could avoid the clone here with a nested hashmap but I prefer the simplicity and extensibility (with future discovery options) here.

@konstin
Copy link
Member Author

konstin commented Mar 10, 2025

CC @potiuk this is hopefully relevant to you too, I've been checking if there are performance gotchas when adopting uv for large workspaces.

@konstin konstin merged commit e843433 into main Mar 10, 2025
98 checks passed
@konstin konstin deleted the konsti/cache-workspace-discovery branch March 10, 2025 21:03
@potiuk
Copy link

potiuk commented Mar 11, 2025

CC @potiuk this is hopefully relevant to you too, I've been checking if there are performance gotchas when adopting uv for large workspaces.

Nice! I did notice a bit of overhead in our workspace and haven't got a time to follow up to do some checking... But you seem to be (as usual) solving the problems before your users manage to even realise them :)

Good job :)

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

performance Potential performance improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants