Clarify handling of script metadata#2089
Open
pfmoore wants to merge 1 commit into
Open
Conversation
Member
Author
|
The linkcheck failure appears to only be for files I haven't changed... |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The specification states that only top-level comments define script metadata. But recognising precisely top-level comments is difficult, and requires a full Python parse, which (for example) the canonical regex does not do.
Clarify that tools MAY use a simple textual scan, like the regex does, but that users must not rely on comments within other Python constructs being ignored.
See https://discuss.python.org/t/clarify-that-pep-723-inline-script-metadata-recognition-is-textual/108089 for a discussion of this issue.
📚 Documentation preview 📚: https://python-packaging-user-guide--2089.org.readthedocs.build/en/2089/