blender/tests/python/rst_to_doctree_mini.py
Campbell Barton e955c94ed3 License Headers: Set copyright to "Blender Authors", add AUTHORS
Listing the "Blender Foundation" as copyright holder implied the Blender
Foundation holds copyright to files which may include work from many
developers.

While keeping copyright on headers makes sense for isolated libraries,
Blender's own code may be refactored or moved between files in a way
that makes the per file copyright holders less meaningful.

Copyright references to the "Blender Foundation" have been replaced with
"Blender Authors", with the exception of `./extern/` since these this
contains libraries which are more isolated, any changed to license
headers there can be handled on a case-by-case basis.

Some directories in `./intern/` have also been excluded:

- `./intern/cycles/` it's own `AUTHORS` file is planned.
- `./intern/opensubdiv/`.

An "AUTHORS" file has been added, using the chromium projects authors
file as a template.

Design task: #110784

Ref !110783.
2023-08-16 00:20:26 +10:00

80 lines
2.2 KiB
Python

# SPDX-FileCopyrightText: 2012-2022 Blender Authors
#
# 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()