Add Provides-Dist metadata to onnxruntime variant packages #27035
+67
−0
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
- Created custom Distribution class that adds Provides-Dist metadata - All variant packages (onnxruntime-gpu, onnxruntime-openvino, etc.) now declare they provide onnxruntime - This fixes dependency resolution issues where both onnxruntime and onnxruntime-gpu could be installed - Addresses issue #26807 Co-authored-by: fs-eire <[email protected]>
- Added comprehensive docstring for Distribution class - Added validation to check if provides_dist is iterable - Added try-except for original write_pkg_file call - Added skip for empty strings in provides_dist entries Co-authored-by: fs-eire <[email protected]>
- Removed redundant try-except block - Simplified type checking with isinstance for list/tuple - Improved code readability Co-authored-by: fs-eire <[email protected]>
Copilot
AI
changed the title
[WIP] Fix issue referenced in #26807
Add Provides-Dist metadata to onnxruntime variant packages
Jan 16, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Modern Python dependency resolvers (pip ≥20.3, uv, poetry, pdm) treat
onnxruntime-gpuandonnxruntimeas unrelated packages, causing both to install simultaneously. This happens because variant packages don't declareProvides-Dist: onnxruntimein their wheel metadata, violating PEP 566 dependency resolution semantics.Changes:
setuptools.Distributionto injectProvides-Distmetadata into wheel METADATA files via monkey-patchedwrite_pkg_filemethodProvides-Dist: onnxruntime (=={version})package_name != "onnxruntime"Result:
Motivation and Context
Resolves dependency conflicts where variant packages fail to satisfy base package requirements, causing duplicate installations and environment pollution. Implements PEP 566 Provides-Dist field for proper distribution aliasing.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.