Merge pull request #2 from daenney/pylint

Make pylint happy

Author: daenney

puppetdb_stencil.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python
+"""
+puppetdb-stencil is a tool to render puppet resources using templates.
+"""
+
 from __future__ import print_function
 from __future__ import unicode_literals
 
@@ -7,30 +11,38 @@
 import pypuppetdb
 import jinja2
 
-log = logging.getLogger('puppetdb_stencil')
+LOG = logging.getLogger('puppetdb_stencil')
 
 METAPARAMS = ('require', 'before', 'subscribe', 'notify', 'audit', 'loglevel',
-        'noop', 'schedule', 'stage', 'alias', 'tag')
+              'noop', 'schedule', 'stage', 'alias', 'tag')
 
 # Allow templates from anywhere on the filesystem
-loader = jinja2.FileSystemLoader(['.', '/'])
-environment = jinja2.Environment(trim_blocks=True, lstrip_blocks=True,
-        loader=loader,
-        extensions=['jinja2.ext.with_', 'jinja2.ext.loopcontrols'])
+LOADER = jinja2.FileSystemLoader(['.', '/'])
+EXTENSIONS = ['jinja2.ext.with_', 'jinja2.ext.loopcontrols']
+ENVIRONMENT = jinja2.Environment(trim_blocks=True, lstrip_blocks=True,
+                                 loader=LOADER, extensions=EXTENSIONS)
 
 
-def render_resources(db, resource_type, template_names):
-    resources = db.resources(resource_type)
+def render_resources(database, resource_type, template_names):
+    """
+    Render resources of the given type. They are queried from the given
+    database and rendered using the first template from template_names that can
+    be loaded.
+    """
+    resources = database.resources(resource_type)
     try:
-        template = environment.select_template(template_names)
+        template = ENVIRONMENT.select_template(template_names)
     except jinja2.TemplatesNotFound:
-        log.error('No template found for {0}'.format(resource_type))
+        LOG.error('No template found for {0}'.format(resource_type))
     else:
         return template.render(resource_type=resource_type,
-            resources=resources, metaparams=METAPARAMS)
+                               resources=resources, metaparams=METAPARAMS)
 
 
-if __name__ == '__main__':
+def main():
+    """
+    Main function
+    """
     parser = argparse.ArgumentParser(prog='puppetdb_stencil')
     parser.add_argument('resource_types', metavar='RESOURCE_TYPE', nargs='+')
     parser.add_argument('--templates', '-t', metavar='TEMPLATE', nargs='*')
@@ -41,10 +53,14 @@ def render_resources(db, resource_type, template_names):
     args = parser.parse_args()
     logging.basicConfig(level=logging.DEBUG if args.debug else logging.WARN)
 
-    db = pypuppetdb.connect(host=args.host, port=args.port)
+    database = pypuppetdb.connect(host=args.host, port=args.port)
 
     for resource_type in args.resource_types:
         templates = ['{0}.jinja2'.format(resource_type)]
         if args.templates:
             templates += args.templates
-        print(render_resources(db, resource_type, templates))
+        print(render_resources(database, resource_type, templates))
+
+
+if __name__ == '__main__':
+    main()