Warn for builds in non-build and workspace root pyproject.toml by konstin · Pull Request #11394 · astral-sh/uv

konstin · 2025-02-10T18:55:03Z

When running uv pip install . in a directory with a pyproject.toml that does not configure a build, we will invoke setuptools and get a wheel we can't parse (#11344). This PR adds warnings around these setups.

crates/uv-build-frontend/src/lib.rs

charliermarsh · 2025-02-10T21:33:12Z

What happens if a future version of setuptools respects a new dependency source, other than those enumerated here?

charliermarsh · 2025-02-10T21:35:10Z

It seems a little sketchy to show these preemptively. Could we show them as a hint after the operation fails?

konstin · 2025-02-10T22:00:28Z

What happens if a future version of setuptools respects a new dependency source, other than those enumerated here?

If a user was to not declare [build-system] but add that new hypothetical non-PEP 621 metadata source, we would show a false positive error. I've opted for an error here matching the existing Error::InvalidSourceDist that errors if there are neither pyproject.toml nor setup.py, given that i consider it unlikely there will be a pre-PEP 517, post PEP 621 combination in the future, and given that a missing [build-system] is legacy behavior.

zanieb · 2025-02-10T22:12:45Z

Just checking my understanding here... why does this work without error?

❯ mkdir example
❯ cd example
❯ touch pyproject.toml
❯ uvx pip install -e .
Installed 1 package in 6ms
Obtaining file:///Users/zb/workspace/uv/example
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
Building wheels for collected packages: UNKNOWN
  Building editable for UNKNOWN (pyproject.toml) ... done
  Created wheel for UNKNOWN: filename=UNKNOWN-0.0.0-0.editable-py3-none-any.whl size=2564 sha256=9a02c4c29e39a2d66dd0ba0746adcdc16cfd2cf3c72cba21ae045d1b9d19d565
  Stored in directory: /private/var/folders/6p/k5sd5z7j31b31pq4lhn0l8d80000gn/T/pip-ephem-wheel-cache-q0_zs90o/wheels/53/b1/66/9fb19b1939bbe46f93d4fe49b431cb32e3425de7bda20e8c88
Successfully built UNKNOWN
Installing collected packages: UNKNOWN
Successfully installed UNKNOWN-0.0.0

Similarly, uvx --from build pyproject-build succeeds (as well as a subsequent pip install from the wheel).

Does that mean we'd be breaking compatibility with pip here? I can't tell from the summary if this changes uv pip install behavior or just uv build.

konstin · 2025-02-11T10:13:47Z

Our current released behavior is that we don't support these cases, because we consider UNKNOWN to be unset, which results in the Metadata field Name not found. Apparently we do this already since f514323, which we copied from python-pkginfo-rs, which doesn't document why it has this behavior.

$ mkdir a
$ cd a
$ touch pyproject.toml
$ uv pip install .
Using Python 3.13.0 environment at: /home/konsti/projects/uv/debug/foo/.venv
error: Failed to parse metadata from built wheel
  Caused by: Metadata field Name not found
$ uv pip install -e .
Using Python 3.13.0 environment at: /home/konsti/projects/uv/debug/foo/.venv
error: Failed to parse metadata from built wheel
  Caused by: Metadata field Name not found

I've tried to only touch the paths that were already failing and give them more actionable error message and catch the "uv pip install . in a workspace root case".

I know example of how to configure setuptools using setup.py, setup.cfg and pyproject.toml. It is not clear to me what uses cases setuptools intends to support outside of that, or what the correct way of handling UNKNOWN is.

crates/uv-build-frontend/src/lib.rs

When running `uv pip install .` in a directory with a pyproject.toml that does not configure a build, we will invoke setuptools and get a wheel we can't parse (#11344). This PR adds warnings around these setups.

konstin · 2025-02-17T14:27:23Z

Changed it to only warnings except for the no-pyproject.toml case that pip and build also reject.

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).

…l-sh#11394) When running `uv pip install .` in a directory with a pyproject.toml that does not configure a build, we will invoke setuptools and get a wheel we can't parse (astral-sh#11344). This PR adds warnings around these setups. --------- Co-authored-by: Charlie Marsh <[email protected]>

konstin added the error messages Messaging when something goes wrong label Feb 10, 2025

charliermarsh reviewed Feb 10, 2025

View reviewed changes

crates/uv-build-frontend/src/lib.rs Outdated Show resolved Hide resolved

charliermarsh reviewed Feb 13, 2025

View reviewed changes

crates/uv-build-frontend/src/lib.rs Show resolved Hide resolved

konstin changed the title ~~Errors for builds in non-build and workspace root pyproject.toml~~ Warn for builds in non-build and workspace root pyproject.toml Feb 17, 2025

Warn for builds in non-build and workspace root pyproject.toml

c7281ea

When running `uv pip install .` in a directory with a pyproject.toml that does not configure a build, we will invoke setuptools and get a wheel we can't parse (#11344). This PR adds warnings around these setups.

konstin force-pushed the konsti/error-invalid-setuptools-build branch from 1c2a833 to c7281ea Compare February 17, 2025 14:23

charliermarsh self-assigned this Feb 17, 2025

charliermarsh added 2 commits February 17, 2025 10:33

Merge branch 'main' into konsti/error-invalid-setuptools-build

35bf129

Minor tweaks

4d53a6e

charliermarsh approved these changes Feb 17, 2025

View reviewed changes

charliermarsh enabled auto-merge (squash) February 17, 2025 15:48

charliermarsh merged commit 90e9287 into main Feb 17, 2025
90 checks passed

charliermarsh deleted the konsti/error-invalid-setuptools-build branch February 17, 2025 15:57

BrewTestBot mentioned this pull request Feb 17, 2025

uv 0.6.1 Homebrew/homebrew-core#208046

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Warn for builds in non-build and workspace root pyproject.toml#11394

Warn for builds in non-build and workspace root pyproject.toml#11394
charliermarsh merged 3 commits intomainfrom
konsti/error-invalid-setuptools-build

konstin commented Feb 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

charliermarsh commented Feb 10, 2025

Uh oh!

charliermarsh commented Feb 10, 2025

Uh oh!

konstin commented Feb 10, 2025

Uh oh!

zanieb commented Feb 10, 2025 •

edited

Loading

Uh oh!

konstin commented Feb 11, 2025

Uh oh!

Uh oh!

konstin commented Feb 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

konstin commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

charliermarsh commented Feb 10, 2025

Uh oh!

charliermarsh commented Feb 10, 2025

Uh oh!

konstin commented Feb 10, 2025

Uh oh!

zanieb commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

konstin commented Feb 11, 2025

Uh oh!

Uh oh!

konstin commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

konstin commented Feb 10, 2025 •

edited

Loading

zanieb commented Feb 10, 2025 •

edited

Loading

konstin commented Feb 17, 2025 •

edited

Loading