3ca76ae0e8
It can be assumed that all scripts comply with basic pep8 formatting regarding white-space, indentation etc. Also remove note in best practices page & update `tests/python/pep8.py`. If we want to exclude some scripts from make format, this can be done by adding them to `ignore_files` in: source/tools/utils_maintenance/autopep8_format_paths.py Or using `# nopep8` for to ignore for individual lines. Ref T98554
78 lines
2.2 KiB
Python
78 lines
2.2 KiB
Python
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
# Module with function to extract a doctree from an reStructuredText file.
|
|
# Named 'Mini' because we only parse the minimum data needed to check
|
|
# Python classes, methods and attributes match up to those in existing modules.
|
|
# (To test for documentation completeness)
|
|
|
|
# note: literalinclude's are not followed.
|
|
# could be nice to add but not really needed either right now.
|
|
|
|
import collections
|
|
|
|
Directive = collections.namedtuple(
|
|
"Directive",
|
|
("type",
|
|
"value",
|
|
"value_strip",
|
|
"line",
|
|
"indent",
|
|
"members"))
|
|
|
|
|
|
def parse_rst_py(filepath):
|
|
import re
|
|
|
|
# Get the prefix assuming the line is lstrip()'d
|
|
# ..foo:: bar
|
|
# -->
|
|
# ("foo", "bar")
|
|
re_prefix = re.compile(r"^\.\.\s([a-zA-Z09\-]+)::\s*(.*)\s*$")
|
|
|
|
tree = collections.defaultdict(list)
|
|
indent_map = {}
|
|
indent_prev = 0
|
|
f = open(filepath, encoding="utf-8")
|
|
for i, line in enumerate(f):
|
|
line_strip = line.lstrip()
|
|
# ^\.\.\s[a-zA-Z09\-]+::.*$
|
|
# if line.startswith(".. "):
|
|
march = re_prefix.match(line_strip)
|
|
|
|
if march:
|
|
directive, value = march.group(1, 2)
|
|
indent = len(line) - len(line_strip)
|
|
value_strip = value.replace("(", " ").split()
|
|
value_strip = value_strip[0] if value_strip else ""
|
|
|
|
item = Directive(type=directive,
|
|
value=value,
|
|
value_strip=value_strip,
|
|
line=i,
|
|
indent=indent,
|
|
members=[])
|
|
|
|
tree[indent].append(item)
|
|
if indent_prev < indent:
|
|
indent_map[indent] = indent_prev
|
|
if indent > 0:
|
|
tree[indent_map[indent]][-1].members.append(item)
|
|
indent_prev = indent
|
|
f.close()
|
|
|
|
return tree[0]
|
|
|
|
|
|
def main():
|
|
# not intended use, but may as well print rst files passed as a test.
|
|
import sys
|
|
for arg in sys.argv:
|
|
if arg.lower().endswith((".txt", ".rst")):
|
|
items = parse_rst_py(arg)
|
|
for i in items:
|
|
print(i)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|