Skip to content

Clarify handling of script metadata #2089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pfmoore wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

Clarify handling of script metadata #2089

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions source/specifications/inline-script-metadata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,17 @@ and the regular expression, the text specification takes precedence.
Tools MUST NOT read from metadata blocks with types that have not been
standardized by this specification.

Note that the specification only requires that *top-level* comment blocks are
recognised as containing metadata. However, parsing Python code is non-trivial,
and therefore:

* Tools MAY choose to do a simple textual scan, rather than a full Python parse.
For example, the canonical regular expression provided above does a textual
scan.
* As a result of the previous point, the behaviour of scripts that contain data
that looks like metadata within another Python construct such as a multi-line
string is tool-dependent and should not be relied on.

script type
-----------

Expand Down
Loading