Ignore dynamic version in source dist by konstin · Pull Request #9549 · astral-sh/uv

konstin · 2024-12-01T09:05:48Z

When encountering dynamic = ["version"] in the pyproject.toml of a source dist, we can ignore that and treat it as a statically known metadata distribution, since the filename tells us the version and that version must not change on build.

This fixed locking PyGObject 3.50.0 from pygobject-3.50.0.tar.gz (minimized):

[project]
name = "PyGObject"
description = "Python bindings for GObject Introspection"
requires-python = ">=3.9, <4.0"
dependencies = [
    "pycairo>=1.16"
]
dynamic = ["version"]

Afterwards, uv add --no-sync toga passes on Ubuntu 24.04 without the pygobject build deps, when previously it needed { name = "pygobject", version = "3.50.0", requires-dist = [], requires-python = ">=3.9" }.

I've added a check that source distribution versions are respected after build.

Fixes #9548

charliermarsh

This makes sense.

charliermarsh · 2024-12-01T13:47:01Z

Works on macOS (and fails with released uv).

charliermarsh · 2024-12-02T21:48:58Z

I think the only downside here is that if the built version doesn't match the declared version, we no longer catch it. Today, we'd raise an error. After this PR, we'd assume the declared version is correct.

konstin · 2024-12-04T09:39:32Z

At least in uv build, we weren't checking version matching at all: #9633 (though that PR also only checks filenames, not pyproject.toml and METADATA, too; the filename mismatch is something that the installer wouldn't catch).

konstin · 2024-12-04T11:08:05Z

We're also missing the check with static metadata atm, let me see how hard that is.

#[test]
fn test_version_sdist_wrong_version() -> Result<()> {
    let context = TestContext::new("3.12");

    let pyproject_toml = r#"
    [project]
    name = "foo"
    requires-python = ">=3.9"
    dependencies = []
    version = "10.11.12"
    "#;

    let setup_py = indoc! {r#"
    from setuptools import setup

    setup(name="foo", version="10.11.12")
    "#};

    let source_dist = context.temp_dir.child("foo-1.2.3.tar.gz");
    // Flush and close after finishing.
    {
        let file = File::create(source_dist.path())?;
        let enc = GzEncoder::new(file, flate2::Compression::default());
        let mut tar = tar::Builder::new(enc);

        for (path, contents) in [
            ("foo-1.2.3/pyproject.toml", pyproject_toml),
            ("foo-1.2.3/setup.py", setup_py),
        ] {
            let mut header = tar::Header::new_gnu();
            header.set_size(contents.len() as u64);
            header.set_mode(0o644);
            header.set_cksum();
            tar.append_data(&mut header, path, Cursor::new(contents))?;
        }
        tar.finish()?;
    }

    uv_snapshot!(context.filters(), context
        .pip_install()
        .arg(source_dist.path()), @r###"
    success: true
    exit_code: 0
    ----- stdout -----

    ----- stderr -----
    Resolved 1 package in [TIME]
    Prepared 1 package in [TIME]
    Installed 1 package in [TIME]
     + foo==10.11.12 (from file://[TEMP_DIR]/foo-1.2.3.tar.gz)
    "###
    );

    Ok(())
}

When encountering `dynamic = ["version"]` in the pyproject.toml of a source dist, we can ignore that and treat it as a statically known metadata distribution, since the filename tells us the version and that version must not change on build. This fixed locking PyGObject 3.50.0 from ` pygobject-3.50.0.tar.gz` (minimized): ```toml [project] name = "PyGObject" description = "Python bindings for GObject Introspection" requires-python = ">=3.9, <4.0" dependencies = [ "pycairo>=1.16" ] dynamic = ["version"] ``` Afterwards, `uv add --no-sync toga` passes on Ubuntu 24.04 without the pygobject build deps, when previously it needed `{ name = "pygobject", version = "3.50.0", requires-dist = [], requires-python = ">=3.9" }`.

We may not always have a version, but if we do, we should record it.

konstin · 2024-12-04T11:31:03Z

I've added a check and a test

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.6` -> `0.5.7` | 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.7`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#057) [Compare Source](astral-sh/uv@0.5.6...0.5.7) ##### Enhancements - Ignore dynamic version in source dist ([#9549](astral-sh/uv#9549)) - Improve build frontend error handling ([#9611](astral-sh/uv#9611)) - Un-hide `uv build --no-build-logs` option ([#9642](astral-sh/uv#9642)) - Flag version mismatch between sdist and wheel during `uv build` ([#9633](astral-sh/uv#9633)) - Improve message when updater receipt is for a different uv executable ([#9487](astral-sh/uv#9487)) - Add environment variable to disable writing installer metadata files ([#8877](astral-sh/uv#8877)) - Add managed downloads for the latest CPython releases: `3.9.21`, `3.10.16`, `3.11.11`, `3.12.8`, and `3.13.1` ([#9696](astral-sh/uv#9696)) ##### Preview features - Build backend: Add hint on import with preview disabled ([#9691](astral-sh/uv#9691)) - Build backend: Add direct builds to the resolver and installer ([#9621](astral-sh/uv#9621)) - Build backend: Add integration test for scripts ([#9635](astral-sh/uv#9635)) - Build backend: Add template to `uv init` ([#9661](astral-sh/uv#9661)) - Build backend: Add `--list` option ([#9610](astral-sh/uv#9610)) ##### Bug fixes - Create missing parent directories for output file of `uv export` / `uv pip compile` ([#9648](astral-sh/uv#9648)) - Fix missing display of non-freethreaded Python 3.13 in `python list` ([#9669](astral-sh/uv#9669)) - Implement `Ord` and `PartialOrd` without origin for `Requirement` ([#9624](astral-sh/uv#9624)) - Include more sources to avoid lowest bound warning ([#9644](astral-sh/uv#9644)) - Respect build tag priority in `uv.lock` ([#9677](astral-sh/uv#9677)) ##### Documentation - Add `build-essentials` note to build failures doc ([#9641](astral-sh/uv#9641)) - Add entry-point for distroless image in GitLab documentation ([#9093](astral-sh/uv#9093)) - Add documentation for `uv python pin` without a `REQUEST` argument ([#9631](astral-sh/uv#9631)) - Add a link to `uv python pin` reference docs ([#9630](astral-sh/uv#9630)) </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).

ncoghlan mentioned this pull request Dec 1, 2024

uv add toga on MacOS erroneously builds pygobject for linux beeware/toga#2995

Closed

charliermarsh approved these changes Dec 1, 2024

View reviewed changes

charliermarsh marked this pull request as ready for review December 2, 2024 19:34

konstin added enhancement New feature or improvement to existing functionality performance Potential performance improvement labels Dec 4, 2024

konstin force-pushed the konsti/allow-dynamic-version-in-source-dist branch from 85230b9 to e94a0f6 Compare December 4, 2024 11:24

Record version for path source dist

ce7675e

We may not always have a version, but if we do, we should record it.

konstin force-pushed the konsti/allow-dynamic-version-in-source-dist branch from e94a0f6 to fb87ce1 Compare December 4, 2024 11:26

konstin enabled auto-merge (squash) December 4, 2024 11:27

Add tests

c31b37d

konstin force-pushed the konsti/allow-dynamic-version-in-source-dist branch from fb87ce1 to c31b37d Compare December 4, 2024 11:31

konstin merged commit c314c68 into main Dec 4, 2024

konstin deleted the konsti/allow-dynamic-version-in-source-dist branch December 4, 2024 11:40

BrewTestBot mentioned this pull request Dec 7, 2024

uv 0.5.7 Homebrew/homebrew-core#200364

Merged

wlach mentioned this pull request Dec 20, 2024

Using git versioning with a workspace module yields unwanted changes to uv.lock #10054

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Ignore dynamic version in source dist#9549

Ignore dynamic version in source dist#9549
konstin merged 3 commits intomainfrom
konsti/allow-dynamic-version-in-source-dist

konstin commented Dec 1, 2024 •

edited

Loading

Uh oh!

charliermarsh left a comment

Uh oh!

charliermarsh commented Dec 1, 2024

Uh oh!

charliermarsh commented Dec 2, 2024

Uh oh!

konstin commented Dec 4, 2024

Uh oh!

konstin commented Dec 4, 2024

Uh oh!

konstin commented Dec 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

konstin commented Dec 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

charliermarsh left a comment

Choose a reason for hiding this comment

Uh oh!

charliermarsh commented Dec 1, 2024

Uh oh!

charliermarsh commented Dec 2, 2024

Uh oh!

konstin commented Dec 4, 2024

Uh oh!

konstin commented Dec 4, 2024

Uh oh!

konstin commented Dec 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

konstin commented Dec 1, 2024 •

edited

Loading