1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
"""
Implementing `python -m numpydoc` functionality.
"""
import sys
import argparse
import ast
from .docscrape_sphinx import get_doc_object
from .validate import validate, Validator
def render_object(import_path, config=None):
"""Test numpydoc docstring generation for a given object"""
# TODO: Move Validator._load_obj to a better place than validate
print(get_doc_object(Validator._load_obj(import_path), config=dict(config or [])))
return 0
def validate_object(import_path):
exit_status = 0
results = validate(import_path)
for err_code, err_desc in results["errors"]:
exit_status += 1
print(":".join([import_path, err_code, err_desc]))
return exit_status
if __name__ == "__main__":
ap = argparse.ArgumentParser(description=__doc__)
ap.add_argument("import_path", help="e.g. numpy.ndarray")
def _parse_config(s):
key, _, value = s.partition("=")
value = ast.literal_eval(value)
return key, value
ap.add_argument(
"-c",
"--config",
type=_parse_config,
action="append",
help="key=val where val will be parsed by literal_eval, "
"e.g. -c use_plots=True. Multiple -c can be used.",
)
ap.add_argument(
"--validate", action="store_true", help="validate the object and report errors"
)
args = ap.parse_args()
if args.validate:
exit_code = validate_object(args.import_path)
else:
exit_code = render_object(args.import_path, args.config)
sys.exit(exit_code)
|
