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