refactor: Use importlib.metadata to define version, support Python 3.12 #68
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
Signed-off-by: Gabor Boros <[email protected]>
We previously made use of the pkg_resources module to determine the package version (as defined by setuptools-scm) in __about__.py. This module is included in setuptools, which as of Python 3.12 has been removed from the standard library and is now its own third-party package. There are multiple ways to address this, one being to include setuptools in the install_requires list for Python 3.12 and later. Another, also listed in the Python Packaging User Guide, is to instead use importlib.metadata.version. Since this approach works for all Python versions we intend to support (that is, from 3.8 forward), this is the better solution. Thus, refactor __about__.py to use importlib, and add Python 3.12 to the test matrix. Note that Tutor itself does not support Python 3.12 prior to version 17, so we cannot support the combination of Python 3.12 and Tutor version 16 or earlier. Reference: https://packaging.python.org/en/latest/guides/single-sourcing-package-version/
|
@fghaas are you planning to merge this PR? |
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.
We previously made use of the
pkg_resourcesmodule to determine the package version (as defined bysetuptools-scm) in__about__.py. This module is included insetuptools, which as of Python 3.12 has been removed from the standard library and is now its own third-party package.There are multiple ways to address this, one being to include
setuptoolsin theinstall_requireslist for Python 3.12 and later. Another, also listed in the Python Packaging User Guide, is to instead useimportlib.metadata.version. Since this approach works for all Python versions we intend to support (that is, from 3.8 forward), this is the better solution.Thus, refactor
__about__.pyto useimportlib, and add Python 3.12 to the test matrix.Reference:
https://packaging.python.org/en/latest/guides/single-sourcing-package-version/