Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hint at missing project.name #6803

Merged
merged 4 commits into from
Sep 14, 2024
Merged

Conversation

konstin
Copy link
Member

@konstin konstin commented Aug 29, 2024

We got user reports where users were confused about why they can't use [project.urls] in pyproject.toml (i think that's from poetry?). This PR adds a hint that (according to PEP 621), you need to set project.name when using any project fields. (PEP 621 also requires project.version xor dynamic = ["version"], but we check that later.)

The intermediate parsing layer to tell apart syntax errors from schema errors doesn't incur a performance penalty according to epage (toml-rs/toml#778 (comment)).

Closes #6419
Closes #6760

@@ -82,7 +82,9 @@ pub enum Error {
#[error("Invalid source distribution: {0}")]
InvalidSourceDist(String),
#[error("Invalid `pyproject.toml`")]
InvalidPyprojectToml(#[from] toml::de::Error),
InvalidPyprojectTomlSyntax(#[from] toml_edit::TomlError),
#[error("`pyproject.toml` does not match required schema. Note: When using any `[project]` field, at least `project.name` needs to be set.")]
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 only have name/version/dynamic here with the last two being optional, so we skip the check that's it's actually name here (in the other case we have to check for name to not confuse it with e.g. invalid project.dependencies; it's only a heuristic but imho good enough for the error hinting path)

@zanieb zanieb added the error messages Messaging when something goes wrong label Aug 29, 2024
@zanieb zanieb self-requested a review August 29, 2024 13:42
@jooon
Copy link

jooon commented Aug 29, 2024

This hint seems to only be shown when a project is explicitly built.

$ cat pyproject.toml
[project.urls]
repository = 'https://github.com/octocat/octocat-python'
$ cargo run -- pip install .
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.20s
     Running `/home/jon/src/github.com/astral-sh/uv/target/debug/uv pip install .`
error: Failed to extract static metadata from `pyproject.toml`
  Caused by: `pyproject.toml` is using the `[project]` table, but the required `project.name` is not set.
  Caused by: TOML parse error at line 1, column 2
  |
1 | [project.urls]
  |  ^^^^^^^
missing field `name`

Not, when it is just parsed because of uv run.

$ cargo run -- run python
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.20s
     Running `/home/jon/src/github.com/astral-sh/uv/target/debug/uv run python`
error: Failed to parse: `pyproject.toml`
  Caused by: TOML parse error at line 1, column 2
  |
1 | [project.urls]
  |  ^^^^^^^
missing field `name`

We got user reports where users were confused about why they can't use `[project.urls]` without other `pyproject.toml`. This PR adds a hint that (according to PEP 621), you need to set `project.name` when using any `project` fields`. (PEP 621 also requires `project.version` xor `dynamic = ["version"]`, but we check that later.)

The intermediate parsing layer to tell apart syntax errors from schema errors doesn't incur a performance penalty according to epage (toml-rs/toml#778 (comment)).

Closes #6419
Closes #6760
@konstin konstin force-pushed the konsti/hint-for-common-toml-error branch from b35e7ac to 8f015a7 Compare August 30, 2024 07:04
@konstin
Copy link
Member Author

konstin commented Aug 30, 2024

This is modelled after #6419 and #6760, where the failing cases were dependencies, not the project itself

@charliermarsh
Copy link
Member

@konstin -- Do you think we can also add this for the workspace discovery errors?

@charliermarsh charliermarsh enabled auto-merge (squash) September 14, 2024 19:54
@charliermarsh charliermarsh force-pushed the konsti/hint-for-common-toml-error branch from 8e8da88 to 3080f5a Compare September 14, 2024 19:56
@charliermarsh charliermarsh merged commit 4aad89c into main Sep 14, 2024
58 checks passed
@charliermarsh charliermarsh deleted the konsti/hint-for-common-toml-error branch September 14, 2024 20:03
@charliermarsh
Copy link
Member

I extended it to uv run in #7399.

charliermarsh added a commit that referenced this pull request Sep 14, 2024
## Summary

An extension of #6803 to cover `uv
run`.
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Sep 21, 2024
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.4.9` -> `0.4.13` |

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.4.13`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0413)

[Compare Source](astral-sh/uv@0.4.12...0.4.13)

##### Enhancements

-   Add `socks` support ([#&#8203;7503](astral-sh/uv#7503))
-   Avoid warning about bad Python interpreter links for empty project environment directories ([#&#8203;7527](astral-sh/uv#7527))
-   Improve invalid environment warning messages ([#&#8203;7544](astral-sh/uv#7544))
-   Use more verbose spelling of "virtualenv" during creation ([#&#8203;7523](astral-sh/uv#7523))
-   Do not use a user-facing warning for "Waiting to acquire lock..." message ([#&#8203;7502](astral-sh/uv#7502))

##### Performance

-   Use a single buffer for hints on resolver errors ([#&#8203;7497](astral-sh/uv#7497))

##### Bug fixes

-   Allow Python pre-releases to be used if they are first on the `PATH` ([#&#8203;7470](astral-sh/uv#7470))
-   Avoid deleting the project environment directory if it is not a virtual environment ([#&#8203;7522](astral-sh/uv#7522))
-   Do not error if the `CACHEDIR.TAG` file exists but cannot be written to ([#&#8203;7550](astral-sh/uv#7550))
-   Treat invalid platform as more compatible than invalid Python ([#&#8203;7556](astral-sh/uv#7556))
-   Use portable paths when serializing sources ([#&#8203;7504](astral-sh/uv#7504))
-   Compute resolver hints using the final reduced derivation tree ([#&#8203;7546](astral-sh/uv#7546))
-   Bump the wheel and sdist cache versions ([#&#8203;7560](astral-sh/uv#7560))
-   Heal cache entries with missing source distributions ([#&#8203;7559](astral-sh/uv#7559))

##### Rust libraries

-   Bump minimum supported Rust version from 1.80 -> 1.81

##### Documentation

-   Add `UV_LINK_MODE` to Docker caching example ([#&#8203;7510](astral-sh/uv#7510))
-   Clarify behavior of of overrides in CLI reference ([#&#8203;7537](astral-sh/uv#7537))

### [`v0.4.12`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0412)

[Compare Source](astral-sh/uv@0.4.11...0.4.12)

##### Enhancements

-   Allow users to provide pre-defined metadata for resolution ([#&#8203;7442](astral-sh/uv#7442))
-   Invalidate existing tool environments on Python interpreter mismatch ([#&#8203;7451](astral-sh/uv#7451))

##### Bug fixes

-   Avoid fatal error when searching for egg-info with missing directory ([#&#8203;7498](astral-sh/uv#7498))

##### Documentation

-   Add note on cache growth for self-hosted GitHub runners ([#&#8203;5757](astral-sh/uv#5757))

### [`v0.4.11`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0411)

[Compare Source](astral-sh/uv@0.4.10...0.4.11)

##### Enhancements

-   Add `--no-editable` support to `uv sync` and `uv export` ([#&#8203;7371](astral-sh/uv#7371))
-   Add support for `--only-dev` to `uv sync` and `uv export` ([#&#8203;7367](astral-sh/uv#7367))
-   Add support for remaining pip-supported file extensions ([#&#8203;7387](astral-sh/uv#7387))
-   Generate shell completion for `uvx` ([#&#8203;7388](astral-sh/uv#7388))
-   Include `uv export` command in `requirements.txt` output ([#&#8203;7374](astral-sh/uv#7374))
-   Prune unzipped source distributions in `uv cache prune --ci` ([#&#8203;7446](astral-sh/uv#7446))
-   Warn when trying to `uv sync` a package without build configuration ([#&#8203;7420](astral-sh/uv#7420))
-   Support requests for pre-releases in the `--python` option ([#&#8203;7335](astral-sh/uv#7335))

##### Bug fixes

-   Avoid erroneous version warning for `.dist-info` directories ([#&#8203;7444](astral-sh/uv#7444))
-   Avoid removing seed packages for `uv venv --seed` environments ([#&#8203;7410](astral-sh/uv#7410))
-   Avoid unnecessary progress bar initializations ([#&#8203;7412](astral-sh/uv#7412))
-   Error when `tool.uv.sources` contains duplicate package names ([#&#8203;7383](astral-sh/uv#7383))
-   Include `--branch` et al when resolving unnamed URLs in `uv add` ([#&#8203;7447](astral-sh/uv#7447))
-   Include `dev-dependencies` in `--no-sources` invocations ([#&#8203;7408](astral-sh/uv#7408))
-   Include the parent interpreter in Python discovery when `--system` is used ([#&#8203;7440](astral-sh/uv#7440))
-   Respect `--no-sources` in PEP 723 scripts ([#&#8203;7409](astral-sh/uv#7409))
-   Respect `pyproject.toml` credentials from user-provided requirements ([#&#8203;7474](astral-sh/uv#7474))
-   Use consistent PyPI cache bucket ([#&#8203;7443](astral-sh/uv#7443))
-   Use unambiguous relative paths in `uv export` ([#&#8203;7378](astral-sh/uv#7378))

##### Documentation

-   Add documentation on platform-specific dependencies ([#&#8203;7411](astral-sh/uv#7411))
-   Add documentation for passing installer options on Linux ([#&#8203;6839](astral-sh/uv#6839))
-   Separate project data from configuration settings ([#&#8203;7053](astral-sh/uv#7053))

##### Error messages

-   Hint at missing `project.name` ([#&#8203;6803](astral-sh/uv#6803))
-   Surface dedicated `project.name` error for workspaces ([#&#8203;7399](astral-sh/uv#7399))
-   Remove duplicate warning for settings discovery errors ([#&#8203;7384](astral-sh/uv#7384))

### [`v0.4.10`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0410)

[Compare Source](astral-sh/uv@0.4.9...0.4.10)

##### Enhancements

-   Allow `uv tool upgrade --all` to continue on individual upgrade failure ([#&#8203;7333](astral-sh/uv#7333))
-   Support globs as cache keys in `tool.uv.cache-keys` ([#&#8203;7268](astral-sh/uv#7268))
-   Add Python package (`__main__.py`) support to `uv run` ([#&#8203;7281](astral-sh/uv#7281))
-   Add zip application support to `uv run` ([#&#8203;7289](astral-sh/uv#7289))
-   Add `--token` option to `self update` command ([#&#8203;7279](astral-sh/uv#7279))

##### Performance

-   Use `globwalk` for `cache-keys` matching ([#&#8203;7337](astral-sh/uv#7337))

##### Bug fixes

-   Always treat archive-like requirements as local files ([#&#8203;7364](astral-sh/uv#7364))
-   Apply `--no-install` options when constructing resolution ([#&#8203;7277](astral-sh/uv#7277))
-   Avoid clobbering existing `py.typed` files contents in `uv init` ([#&#8203;7338](astral-sh/uv#7338))
-   Avoid enforcing platform compatibility when validating lockfile ([#&#8203;7305](astral-sh/uv#7305))
-   Avoid installing transitive dev dependencies ([#&#8203;7318](astral-sh/uv#7318))
-   Avoid selecting prerelease Python installations without opt-in ([#&#8203;7300](astral-sh/uv#7300))
-   Fix PPC64 page size in binary builds. ([#&#8203;7298](astral-sh/uv#7298))
-   Include pre-release Python versions in `uv python list` ([#&#8203;7290](astral-sh/uv#7290))
-   Make version ID optional for source builds ([#&#8203;7362](astral-sh/uv#7362))
-   Support relative paths in `uv add --script` ([#&#8203;7301](astral-sh/uv#7301))

##### Documentation

-   Fix documentation typos for `uv build --build-constraint` flag ([#&#8203;7330](astral-sh/uv#7330))
-   Fix grammatical error in CLI docs ([#&#8203;7353](astral-sh/uv#7353))

##### Error messages

-   Add dedicated lock errors for wheel-only distributions ([#&#8203;7307](astral-sh/uv#7307))
-   Avoid treating `.whl` sources as source distributions ([#&#8203;7303](astral-sh/uv#7303))
-   Clarify Python requirement source for script incompatibilities ([#&#8203;7339](astral-sh/uv#7339))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
error messages Messaging when something goes wrong
Projects
None yet
4 participants