hacking/dump_playbook_attributes.py
fbdcb22e
 #!/usr/bin/env python2
 
 import optparse
 from jinja2 import Environment, FileSystemLoader
 
 from ansible.playbook import  Play
 from ansible.playbook.block import  Block
 from ansible.playbook.role import  Role
 from ansible.playbook.task import  Task
 
 template_file = 'playbooks_directives.rst.j2'
 oblist = {}
a3489408
 clist = []
 class_list = [ Play, Role, Block, Task ]
fbdcb22e
 
 p = optparse.OptionParser(
     version='%prog 1.0',
     usage='usage: %prog [options]',
     description='Generate module documentation from metadata',
 )
 p.add_option("-T", "--template-dir", action="store", dest="template_dir", default="hacking/templates", help="directory containing Jinja2 templates")
 p.add_option("-o", "--output-dir", action="store", dest="output_dir", default='/tmp/', help="Output directory for rst files")
 
 (options, args) = p.parse_args()
 
cbc797a7
 for aclass in class_list:
a3489408
     aobj = aclass()
     name = type(aobj).__name__
 
     # build ordered list to loop over and dict with attributes
     clist.append(name)
6a85da7e
     oblist[name] = {x: aobj.__dict__['_attributes'][x] for x in aobj.__dict__['_attributes']  if 'private' not in x or not x.private}
a3489408
 
     # loop is really with_ for users
6a85da7e
     if name == 'Task':
a3489408
         oblist[name]['with_<lookup_plugin>'] = True
 
     # local_action is implicit with action
     if 'action' in oblist[name]:
         oblist[name]['local_action'] = True
 
fbdcb22e
 env = Environment(loader=FileSystemLoader(options.template_dir), trim_blocks=True,)
 template = env.get_template(template_file)
 outputname = options.output_dir + template_file.replace('.j2','')
a3489408
 tempvars = { 'oblist': oblist, 'clist': clist }
fbdcb22e
 
 with open( outputname, 'w') as f:
     f.write(template.render(tempvars))