fix: Sanitize Python version to be PEP 440 compliant #1605
Merged
Conversation
This file contains 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
To avoid errors in modern versions of pip, ensure that the version name created for the Python bindings is sanitized to be compliant with PEP 440 c.f.: * https://www.python.org/dev/peps/pep-0440/ * pip GitHub Issue #8368 This essentially means that the version number needs to pass `pip._vendor.packaging.version.Version()` Example: ``` from pip._vendor.packaging.version import Version Version("v20220128-34c8a39") # pip._vendor.packaging.version.InvalidVersion: Invalid version: 'v20220128-34c8a39' Version("2022.128") # <Version('2022.128')> Version("2022.128+a28a91c") # <Version('2022.128+a28a91c')> Version("6.0.0") # <Version('6.0.0')> ```
As discovered in XRootD Issue xrootd#1604 there are instances where if a Git tag is created, then the current xrootd.egg-info that is generated in the top level of the repository by the current packaging/wheel/publish.sh workflow will pollute the PYTHONPATH (which includes the current working directory by default --- this is one of the reasons src directory structures are currently recommended by the PyPA) causing problems with trying to install the built sdist from the top level of the repo with `python3 -m pip install dist/xrootd*.tar.gz`. Ideally the publish.sh workflow should be refactored to make this not a problem, but for the time being just use the easy workaround of changing paths so that the xrootd.egg-info directory is not on PYTHONPATH and install the sdist normally.
|
@simonmichal this is ready for review. I'm happy to answer any questions on it, but I tried to do some brain dumps into the relevant commit messages to guide anyone in the future who might need to debug anything related to them. |
Closed
matthewfeickert
deleted the
fix/sanitize-python-package-name-for-PEP-440
branch
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.
To avoid errors in modern versions of
pip, ensure that the version name created for the Python bindings is sanitized to be compliant with PEP 440c.f.:
setup.py installwhen building a wheel failed for source distributions without pyproject.toml pypa/pip#8368This essentially means that the version number needs to pass
pip._vendor.packaging.version.Version()Example: