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

uv incorrectly excludes pre-release Python versions when requires-python is greater or equal to that version #4714

Closed
notatallshaw opened this issue Jul 1, 2024 · 11 comments · Fixed by #4794
Assignees
Labels
bug Something isn't working

Comments

@notatallshaw
Copy link

notatallshaw commented Jul 1, 2024

Tested on:

  • uv 0.2.18
  • Python 3.13.0b3

Create a pyproject.toml like so:

[project]
name = "foo"
version = "0.1.0"
requires-python = ">=3.13"

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

Dry install with uv fails:

$  uv pip install --dry-run .
  × No solution found when resolving dependencies:
  ╰─▶ Because the current Python version (3.13.0b3) does not satisfy Python>=3.13 and foo==0.1.0 depends on Python>=3.13, we can conclude that
  	foo==0.1.0 cannot be used.
  	And because only foo==0.1.0 is available and you require foo, we can conclude that the requirements are unsatisfiable.

Dry install with pip succeeds:

$ pip install --dry-run .
Processing /home/damian/opensource/support/uv/4536
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Would install foo-0.1.0

IMO pip is following the spec here and uv is not. Specifically if we take requires-python to be a Version as defined by PEP 440, then according to: https://packaging.python.org/en/latest/specifications/version-specifiers/#handling-of-pre-releases then the installed version of Python should already be accepted based on:

accept already installed pre-releases for all version specifiers

Moreover, intuitively, if a developer splits up their package releases between python < 3.11 and python >= 3.11 they should not expect there to be a hole of Python versions.

But let me know if you know some more specific part of the spec that says my interpretation is wrong, I will file a bug against pip.

@charliermarsh
Copy link
Member

I don't feel strongly about this, I'm fine with effectively omitting pre-releases for Python version handling.

What does "accept already installed pre-releases for all version specifiers" mean? Is that like, if some does pip install foo>=3.0 and you already have foo==3.0.0a0 installed, it should be satisfy the requirement?

I maintain that per the spec a pre-release version should not satisfy python_version < 3.11 or python_version >= 3.11 -- for example, uv pip compile --python-version 3.11.0a0 would be correct to exclude that dependency in formal terms (I don't think we even allow pre-releases there, just an example) -- but I agree that it's not really sensible.

@notatallshaw
Copy link
Author

notatallshaw commented Jul 1, 2024

What does "accept already installed pre-releases for all version specifiers" mean? Is that like, if some does pip install foo>=3.0 and you already have foo==3.0.0a0 installed, it should be satisfy the requirement?

Yes, that has been my interpretation anyway.

I maintain that per the spec a pre-release version should not satisfy python_version < 3.11 or python_version >= 3.11

I don't follow your logic. If we were talking about remote packages versions instead of python_versions it would match though.

Let's say package "foo" there was only one remote package version, and it was "foo 3.11.0a0", then it would match foo < 3.11 or foo >= 3.11. And in the context of Python versions, during installation, there is only ever one version, so to me at least it seems intuitive it matches.

@charliermarsh
Copy link
Member

You might be right on that last point. It's sort of hard for me to reason about in a world in which (1) we can install Python versions on-demand to meet requires-python and (2) we're trying to resolve for a range of Python versions at once. But I guess the thinking is: when you go to install, that's the only version available, so pre-releases should always be allowed?

Separately, if requires-python = ">=3.13" is interpreted as allowing pre-releases, is there no way for package authors to indicate that their package does not support those pre-release versions?

@notatallshaw
Copy link
Author

notatallshaw commented Jul 1, 2024

Dug through the pip codebase, I think the line that ends up allowing Python prereleases is this one (at least in the "new" resolver): https://github.com/pypa/pip/blob/24.1.1/src/pip/_internal/resolution/resolvelib/requirements.py#L207

It looks like it was implemented by pypa/pip#8079, and a side effect of the issue that releases with only prereleases should be installed pypa/pip#8075.

But maybe there is a deeper history to this that I'm unware of.

You might be right on that last point. It's sort of hard for me to reason about in a world in which (1) we can install Python versions on-demand to meet requires-python and (2) we're trying to resolve for a range of Python versions at once. But I guess the thinking is: when you go to install, that's the only version available, so pre-releases should always be allowed?

That's my thinking anyway, I'm not sure anyone who wrote the spec had your scenario in mind. Is anyone else doing universal resolution other than Poetry? It might be worth sanity checking against what Poetry does.

Separately, if requires-python = ">=3.13" is interpreted as allowing pre-releases, is there no way for package authors to indicate that their package does not support those pre-release versions?

Well, technically they could do something like:

requires-python = ">=3.13, !=3.13.0a1, !=3.13.0a2, !=3.13.0a3, !=3.13.0a4, !=3.13.0a5, !=3.13.0a6, !=3.13.0b1, !=3.13.0b2, !=3.13.0b3"

Which I've seen similiar syntax for package versions due to the limited way you can express ranges with holes in them.

@charliermarsh charliermarsh self-assigned this Jul 2, 2024
@notatallshaw
Copy link
Author

I'd be happy to make a Python packaging discussion on this to seek clarification from the broader community if you'd prefer to see if there's consensus on this.

It's certainly not explicity spelled out in the spec, and I know sometimes the way I read the spec is not in line with the way the spec authors intended it.

@charliermarsh
Copy link
Member

Na it's alright. We already have this semantics with --universal (but not when normalizing the markers -- only when determining package compatibility). I just need to find time to reason through the conversions and make it consistent everywhere.

@charliermarsh
Copy link
Member

Still trying to figure out how pip actually allows this given:

>>> from packaging import specifiers
>>> specifiers.SpecifierSet(">=3.13").contains("3.13.0b0", prereleases=True)
False

@notatallshaw
Copy link
Author

notatallshaw commented Jul 3, 2024

Ah you're right, the prereleases=True there is a red herring.

The reason pip includes prerelease versions of Python is when it extracts the version from Python it only takes the first 3 elements of the version object: https://github.com/pypa/pip/blob/24.1.1/src/pip/_internal/resolution/resolvelib/candidates.py#L540

>>> sys.version_info
sys.version_info(major=3, minor=13, micro=0, releaselevel='beta', serial=3)
>>> sys.version_info[:3]
(3, 13, 0)
>>> ".".join(str(c) for c in sys.version_info[:3])
'3.13.0'

@notatallshaw
Copy link
Author

I appreciate that seems to invalidate most of my reasoning, I will need to run some more checks and think on this.

@charliermarsh
Copy link
Member

That actually makes life a lot easier for us though, if we just want to mimic that...

@notatallshaw
Copy link
Author

True, it does make me think though that you can't do any sort of prerelease exclusion, I will do some more careful testing and report an issue on pip side to see if maintainers have an opinion on that.

Going back to the spec I find the following: https://packaging.python.org/en/latest/specifications/pyproject-toml/#requires-python

Which links to: https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata-requires-python

It's all rather underspecified, and unfortunately uses the word may. Oh well.

charliermarsh added a commit that referenced this issue Jul 4, 2024
## Summary

There are a few ideas at play here:

1. pip always strips versions to the release when evaluating against a
`Requires-Python`, so we now do the same. That means, e.g., using
`3.13.0b0` will be accepted by a project with `Requires-Python: >=
3.13`, which does _not_ adhere to PEP 440 semantics but is somewhat
intuitive.
2. Because we know we'll only be evaluating against release-only
versions, we can use different semantics in PubGrub that let us collapse
ranges. For example, `python_version >= '3.10' or python_version <
'3.10'` can be collapsed to the truthy marker.

Closes #4714.
Closes #4272.
Closes #4719.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants