feat: allow specifying build constraints for dependencies #10388
+372
−39
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis pull request introduces support for specifying build constraints for dependencies via a new [tool.poetry.build-constraints] section in pyproject.toml, propagating these constraints through the installation and build process, updating the relevant core logic, and adding comprehensive tests and documentation. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @radoering - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟡 Testing: 2 issues found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
radoering
force-pushed
the
build-constraints
branch
from
f440bc7 to
92eeb2d
Compare
|
Deploy preview for website ready! ✅ Preview Built with commit 780c7cc. |
radoering
force-pushed
the
build-constraints
branch
from
92eeb2d to
568add6
Compare
radoering
force-pushed
the
build-constraints
branch
from
568add6 to
780c7cc
Compare
Contributor
|
I've tested this out with an internal scenario (see linked issue) and it seemed to work as expected! Testing with a constrained setuptools[project]
name = "tmp-6g7i6voyom"
version = "0.1.0"
description = ""
authors = [
{name = "Your Name",email = "[email protected]"}
]
readme = "README.md"
requires-python = ">=3.11, <4"
dependencies = [
]
[tool.poetry]
packages = [{include = "tmp"}]
[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
build-backend = "poetry.core.masonry.api"
[tool.poetry.build-constraints]
smbus-cffi = { setuptools = "<80.7.0" }
[[tool.poetry.source]]
name = "upstream-pypi"
url = "https://nexus.xes-mad.com/repository/upstream-pypi/simple"
[[tool.poetry.source]]
name = "xes-pypi"
url = "https://nexus.xes-mad.com/repository/xes-pypi/simple"Testing with a constrained cffi[project]
name = "tmp-6g7i6voyom"
version = "0.1.0"
description = ""
authors = [
{name = "Your Name",email = "[email protected]"}
]
readme = "README.md"
requires-python = ">=3.11, <4"
dependencies = [
"xes-bscan (==0.9)"
]
[tool.poetry]
packages = [{include = "tmp"}]
[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
build-backend = "poetry.core.masonry.api"
[tool.poetry.build-constraints]
smbus-cffi = { cffi = "<2.0.0" }
[[tool.poetry.source]]
name = "upstream-pypi"
url = "https://nexus.xes-mad.com/repository/upstream-pypi/simple"
[[tool.poetry.source]]
name = "xes-pypi"
url = "https://nexus.xes-mad.com/repository/xes-pypi/simple" |
Contributor
|
I tried getting hacky to add pip a la: so the build would work with an older setuptools, but pip was not inserted into the environment. So existing dependencies can be constrained but new dependencies cannot be inserted (or at least not pip). |
Member
Author
This is expected because:
If we decided to allow to add dependencies, |
Contributor
I think this is absolutely fine, i just wanted to mention it. This PR functions as I expected. I don't know if you want input from others i know its been open for a while. |
Contributor
|
lmk if there's anything else I can help with. |
Member
Author
Thanks for trying it out. I have it on my agenda for the next minor release. Since this is not imminent, I will probably keep this PR open a bit longer and merge it as soon as the next release is near (assuming there is no other feedback in the meantime). |
Contributor
|
Out of curiosity, is there a milestone or target for 2.3.x where this might be included? I'm trying to decide if I can hold out for that release or if I should stay pinned on the current version of poetry we have for an upcoming release. Thanks! |
Member
Author
|
Things may change but I would not expect it in the next few weeks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Check List
Resolves: #10299
Example:
At some point, I wondered if build constraints should be part of the pyproject.toml or part of the configuration. I stuck with the pyproject.toml because it is easier to implement.
A small shortcoming is that the constraints are only applied when installing dependencies - not when building a package to extract metadata. I think we can live with that for the time being.
Another shortcoming is that the constraints are not really constraints but implemented as dependencies of an optional group, which is not installed. In most cases, this will not make a difference but in rare cases it could result in unnecessary solver errors. Implementing real constraints will cost more effort and could be done later if it proves to be necessary.
Summary by Sourcery
Introduce support for specifying build constraints for dependencies in pyproject.toml, allowing users to control build-time dependency versions for specific packages.
New Features:
Enhancements:
Documentation:
Tests: