diff options
author | Jan-Piet Mens <jpmens@gmail.com> | 2012-11-09 17:15:41 +0100 |
---|---|---|
committer | Jan-Piet Mens <jpmens@gmail.com> | 2012-11-09 17:15:41 +0100 |
commit | e32f4a056451c1c30f11ef82a4c9ed3786180776 (patch) | |
tree | 1415db8637cbc2ac5670b4eaaa398892dd0f9678 /hacking | |
parent | 2ff3fc6aa2803c92b88a78c6adc7af6a2099e800 (diff) | |
download | ansible-e32f4a056451c1c30f11ef82a4c9ed3786180776.tar.gz |
Move get_docstring from module_formatter into ansible/utils
Diffstat (limited to 'hacking')
-rwxr-xr-x | hacking/module_formatter.py | 33 |
1 files changed, 4 insertions, 29 deletions
diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index bb84548e90..792bdad5f1 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -29,12 +29,9 @@ import optparse import time import datetime import subprocess -import traceback +import ansible.utils +from ansible.utils import module_docs -# modules that are ok that they do not have documentation strings -BLACKLIST_MODULES = [ - 'async_wrapper' -] # Get parent directory of the directory this script lives in MODULEDIR=os.path.abspath(os.path.join( @@ -133,28 +130,6 @@ def rst_xline(width, char="="): def load_examples_section(text): return text.split('***BREAK***') -def get_docstring(filename, verbose=False): - """ - Search for assignment of the DOCUMENTATION variable in the given file. - Parse that from YAML and return the YAML doc or None. - """ - - doc = None - - try: - # Thank you, Habbie, for this bit of code :-) - M = ast.parse(''.join(open(filename))) - for child in M.body: - if isinstance(child, ast.Assign): - if 'DOCUMENTATION' in (t.id for t in child.targets): - doc = yaml.load(child.value.s) - - except: - traceback.print_exc() - print "unable to parse %s" % filename - return doc - - def return_data(text, options, outputname, module): if options.output_dir is not None: f = open(os.path.join(options.output_dir, outputname % module), 'w') @@ -326,9 +301,9 @@ def main(): js_data.append(j) continue - doc = get_docstring(fname, verbose=options.verbose) + doc = ansible.utils.module_docs.get_docstring(fname, verbose=options.verbose) - if doc is None and module not in BLACKLIST_MODULES: + if doc is None and module not in ansible.utils.module_docs.BLACKLIST_MODULES: sys.stderr.write("*** ERROR: CORE MODULE MISSING DOCUMENTATION: %s ***\n" % module) #sys.exit(1) |