Resolve `find-links` paths relative to the configuration file by NightRa · Pull Request #10827 · astral-sh/uv

NightRa · 2025-01-21T21:34:36Z

One-liner

Relative find-links configuration to local path from a pyproject.toml or uv.toml is now relative to the config file

Summary

Background

One can configure find-links in a pyproject.toml or uv.toml file, which are located from the cli arg, system directory, user directory, or by traversing parent directories until one is encountered.

This PR addresses the following scenario:

A project directory which includes a pyproject.toml or uv.toml file
The config file includes a find-links option. (eg under [tool.uv] for pyproject.toml)
The find-links option is configured to point to a local subdirectory in the project: packages/
There is a subdirectory called subdir, which is the current working directory
I run uv run my_script.py. This will locate the pyproject.toml in the parent directory

Current Behavior

uv tries to use the path subdir/packages/ to find packages, and fails.

New Behavior

uv tries to use the path packages/ to find the packages, and succeeds
Specifically, any relative local find-links path will resolve to be relative to the configuration file.

Why is this behavior change OK?

I believe no one depends on the behavior that a relative find-links when running in a subdir will refer to different directories each time
Thus this change only allows a more common use case which didn't work previously.

Test Plan

I re-created the setup mentioned above:

UvTest/
├── packages/
│   ├── colorama-0.4.6-py2.py3-none-any.whl
│   └── tqdm-4.67.1-py3-none-any.whl
├── subdir/
│   └── my_script.py
└── pyproject.toml

# pyproject.toml
[project]
name = "uvtest"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
    "tqdm>=4.67.1",
]

[tool.uv]
offline = true
no-index = true
find-links = ["packages/"]

With working directory under subdir, previously, running uv sync --offline would fail resolving the tdqm package, and after the change it succeeds.
Additionally, one can use uv sync --show-settings to show the actually-resolved settings - now having the desired path in flat_index.url.path

Alternative designs considered

I considered modifying the impl Deserialize for IndexUrl to parse ahead of time directly with a base directory by having a custom Deserializer with a base dir field, but it seems to contradict the design of the serde Deserialize trait - which should work with all Deserializers

Future work

Support for adjusting all other local-relative paths in Options would be desired, but is out of scope for the current PR.

… pyproject.toml or uv.toml is now relative to the config file

…onfig-file uv.toml)

charliermarsh · 2025-01-21T21:53:26Z

Thanks. It would be useful to include a test here (that fails on main but passes on this branch) to guard against regressions (and make sure we understand the problematic scenario).

NightRa · 2025-01-21T21:57:40Z

@charliermarsh

A test corresponding to the scenario I described would need to have a whl file for some package.
Which minimal test package would you consider appropriate for this?
This would also imply it needs to be checked in the uv repository
Where would be an appropriate location in the repository to hold this whl file for the test?

charliermarsh · 2025-01-21T21:59:13Z

We already have a few checked-in that you can use in ./scripts/links. Grep around for tests that use scripts/links for examples?

NightRa · 2025-01-21T22:32:34Z

@charliermarsh
Done.
Also checked the test fails on master and succeeds here.
Previously it would fail with:

error: Failed to read `--find-links` directory: C:\Users\...\AppData\Roaming\uv\tests\.tmpS7JaZu\temp\subdir\packages
  Caused by: The system cannot find the path specified. (os error 3)

NightRa · 2025-01-22T08:07:13Z

@charliermarsh Anything else required to merge here?

charliermarsh · 2025-01-22T18:06:27Z

No, I just need time to review the changes.

NightRa · 2025-01-22T18:08:36Z

Great, thanks for your time!

NightRa · 2025-01-22T21:09:42Z

Indeed wasn't sure about the &mut. Thanks for the fixes
Love the quick support. Would recommend. 10/10

charliermarsh · 2025-01-22T21:16:42Z

Yeah the &mut worked, I just generally prefer to use these kinds of immutability patterns. Thanks for the PR!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.22` -> `0.5.24` | 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.5.24`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0524) [Compare Source](astral-sh/uv@0.5.23...0.5.24) ##### Enhancements - Improve determinism of resolution by always setting package priorities ([#10853](astral-sh/uv#10853)) - Upgrade to `cargo-dist` 0.28.0; improves several installer behaviors ([#10884](astral-sh/uv#10884)) ##### Performance - Remove dependencies clone in resolver ([#10880](astral-sh/uv#10880)) - Use Hashbrown's raw entry API to reduce hashes and clone in resolver priority determination ([#10881](astral-sh/uv#10881)) ##### Bug fixes - Allow fallback to Python download on non-critical discovery errors ([#10908](astral-sh/uv#10908)) ##### Preview features - Register managed Python version with the Windows Registry (PEP 514) ([#10634](astral-sh/uv#10634)) ##### Documentation - Improve documentation for some environment variables ([#10887](astral-sh/uv#10887)) - Add git subdirectory example ([#10894](astral-sh/uv#10894)) ### [`v0.5.23`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0523) [Compare Source](astral-sh/uv@0.5.22...0.5.23) ##### Enhancements - Add `--refresh` to `uv venv` ([#10834](astral-sh/uv#10834)) - Add `--no-default-groups` command-line flag ([#10618](astral-sh/uv#10618)) ##### Bug fixes - Sort extras and groups when comparing lockfile requirements ([#10856](astral-sh/uv#10856)) - Include `commit_id` and `requested_revision` in `direct_url.json` ([#10862](astral-sh/uv#10862)) - Invalidate lockfile when static versions change ([#10858](astral-sh/uv#10858)) - Make GitHub fast path errors non-fatal ([#10859](astral-sh/uv#10859)) - Remove warnings for `--frozen` and `--locked` in `uv run --script` ([#10840](astral-sh/uv#10840)) - Resolve `find-links` paths relative to the configuration file ([#10827](astral-sh/uv#10827)) - Respect visitation order for proxy packages ([#10833](astral-sh/uv#10833)) - Treat version mismatch errors as non-fatal in fast paths ([#10860](astral-sh/uv#10860)) - Mark `--locked` and `--upgrade` are conflicting ([#10836](astral-sh/uv#10836)) - Relax error checking around unconditional enabling of conflicting extras ([#10875](astral-sh/uv#10875)) ##### Documentation - Reduce ambiguity in conflicting extras example ([#10877](astral-sh/uv#10877)) - Update pre-commit documentation ([#10756](astral-sh/uv#10756)) ##### Error messages - Error when workspace contains conflicting Python requirements ([#10841](astral-sh/uv#10841)) - Improve uvx error message when uv is missing ([#9745](astral-sh/uv#9745)) </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).

NightRa added 2 commits January 21, 2025 22:23

[uv-settings]: Relative find-links configuration to local path from a…

edd1319

… pyproject.toml or uv.toml is now relative to the config file

[uv-settings]: Ensure the base directory path is absolute (eg for --c…

80d8cf9

…onfig-file uv.toml)

zanieb requested a review from charliermarsh January 21, 2025 21:35

zanieb assigned charliermarsh Jan 21, 2025

[uv-settings]: reformat

ca819b7

[uv-settings]: UT for find-links in subdir

f467ba3

charliermarsh added 4 commits January 22, 2025 13:12

Merge branch 'main' into fix-relative-find-links

5393a9d

Remove mut

99bf4a3

Also apply this to [tool.uv.pip]; index settings

d8a0410

Merge

047035a

charliermarsh added the bug Something isn't working label Jan 22, 2025

charliermarsh approved these changes Jan 22, 2025

View reviewed changes

charliermarsh enabled auto-merge (squash) January 22, 2025 19:36

charliermarsh merged commit b1e4bc7 into astral-sh:main Jan 22, 2025
68 checks passed

zanieb changed the title ~~[uv-settings]: Correct behavior for relative find-links paths when run from a subdir~~ Resolve find-links paths relative to the configuration file Jan 22, 2025

BrewTestBot mentioned this pull request Jan 23, 2025

uv 0.5.23 Homebrew/homebrew-core#205255

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Resolve `find-links` paths relative to the configuration file#10827

Resolve `find-links` paths relative to the configuration file#10827
charliermarsh merged 8 commits intoastral-sh:mainfrom
NightRa:fix-relative-find-links

NightRa commented Jan 21, 2025 •

edited

Loading

Uh oh!

charliermarsh commented Jan 21, 2025

Uh oh!

NightRa commented Jan 21, 2025

Uh oh!

charliermarsh commented Jan 21, 2025

Uh oh!

NightRa commented Jan 21, 2025

Uh oh!

NightRa commented Jan 22, 2025

Uh oh!

charliermarsh commented Jan 22, 2025

Uh oh!

NightRa commented Jan 22, 2025

Uh oh!

Uh oh!

NightRa commented Jan 22, 2025

Uh oh!

charliermarsh commented Jan 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

NightRa commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

One-liner

Summary

Background

Current Behavior

New Behavior

Why is this behavior change OK?

Test Plan

Alternative designs considered

Future work

Uh oh!

charliermarsh commented Jan 21, 2025

Uh oh!

NightRa commented Jan 21, 2025

Uh oh!

charliermarsh commented Jan 21, 2025

Uh oh!

NightRa commented Jan 21, 2025

Uh oh!

NightRa commented Jan 22, 2025

Uh oh!

charliermarsh commented Jan 22, 2025

Uh oh!

NightRa commented Jan 22, 2025

Uh oh!

Uh oh!

NightRa commented Jan 22, 2025

Uh oh!

charliermarsh commented Jan 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NightRa commented Jan 21, 2025 •

edited

Loading