Read version from version files via ast #630
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
|
Being able to read |
|
FWIW, there's prior art in pypa/setuptools for this: https://github.com/pypa/setuptools/blob/be6c0218bcba78dbd4ea0b5a8bb9acd5d5306240/setuptools/config/expand.py#L160-L168 |
takluyver
reviewed
Apr 8, 2023
|
Thanks! There's one little change I want (comment above), but I like the idea and the implementation. 👍 |
In cases where packages import `__version__` from version modules (like those generated by setuptools_scm or attribution), this allows flit-core to use the existing ast-based logic to read the version directly from those files when possible. It checks a few well-known version filenames, including the package-level `__init__.py` as usual, with `__init__.py` taking precedence over external version files if an assigned `__version__` value exists in multiple places. This makes flit more resilient to reading version from these packages, even if their `__init__.py` has transitive imports that aren't available in the environment at build time (eg, conda-forge builds). It also reduces the number of times when flit has to fall back to actually importing the `__init__.py` file rather than reading with ast.
takluyver
reviewed
Apr 9, 2023
|
Thanks @amyreese, and nice work on a first contribution. 🙂 |
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.
In cases where packages import
__version__from version modules (likethose generated by setuptools_scm or attribution), this allows flit-core
to use the existing ast-based logic to read the version directly from
those files when possible. It checks a few well-known version filenames,
including the package-level
__init__.pyas usual, with__init__.pytaking precedence over external version files if an assigned
__version__value exists in multiple places.This makes flit more resilient to reading version from these packages,
even if their
__init__.pyhas transitive imports that aren't availablein the environment at build time (eg, conda-forge builds). It also
reduces the number of times when flit has to fall back to actually
importing the
__init__.pyfile rather than reading with ast.