linting fixes

Author: Bradley A. Thornton

models/myos/interfaces/myos_interfaces.yml

@@ -2,9 +2,9 @@
 GENERATOR_VERSION: '1.0'
 ANSIBLE_METADATA: |
     {
-      'metadata_version': '1.1',
-      'status': ['preview'],
-      'supported_by': '<support_group>'
+        'metadata_version': '1.1',
+        'status': ['preview'],
+        'supported_by': '<support_group>'
     }
 
 NETWORK_OS: myos

roles/resource_module/filter_plugins/to_argspec.py

@@ -1,19 +1,21 @@
 # Copyright (c) 2019 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+__metaclass__ = type  # pylint: disable=C0103
 
-import yaml
 import pprint
+import yaml
 
 from ansible.module_utils.six import iteritems
 from ansible.module_utils.six import string_types
 from ansible.utils.display import Display
 from ansible.errors import AnsibleFilterError
 
 OPTIONS_METADATA = ('type', 'elements', 'default', 'choices', 'required')
-SUBOPTIONS_METADATA = ('mutually_exclusive', 'required_together', 'required_one_of', 'supports_check_mode', 'required_if')
+SUBOPTIONS_METADATA = ('mutually_exclusive', 'required_together',
+                       'required_one_of', 'supports_check_mode', 'required_if')
 
 display = Display()
 
@@ -27,24 +29,48 @@ def retrieve_metadata(values, out):
 
 
 def dive(obj, result):
-    for k, v in iteritems(obj):
+    for k, val in iteritems(obj):
         result[k] = dict()
-        retrieve_metadata(v, result[k])
-        suboptions = v.get('suboptions')
+        retrieve_metadata(val, result[k])
+        suboptions = val.get('suboptions')
         if suboptions:
             for item in SUBOPTIONS_METADATA:
-                if item in v:
-                    result[k][item] = v[item]
+                if item in val:
+                    result[k][item] = val[item]
             result[k]['options'] = dict()
             dive(suboptions, result[k]['options'])
 
+def pretty(value, htchar='\t', lfchar='\n', indent=0):
+    nlch = lfchar + htchar * (indent + 1)
+    if type(value) is dict:
+        items = [
+            nlch + repr(key) + ': ' + pretty(value[key], htchar, lfchar, indent + 1)
+            for key in value
+        ]
+        return '{%s}' % (','.join(items) + lfchar + htchar * indent)
+    elif type(value) is list:
+        items = [
+            nlch + pretty(item, htchar, lfchar, indent + 1)
+            for item in value
+        ]
+        return '[%s]' % (','.join(items) + lfchar + htchar * indent)
+    elif type(value) is tuple:
+        items = [
+            nlch + pretty(item, htchar, lfchar, indent + 1)
+            for item in value
+        ]
+        return '(%s)' % (','.join(items) + lfchar + htchar * indent)
+    else:
+        return repr(value)
 
 def to_argspec(spec):
     if 'DOCUMENTATION' not in spec:
-        raise AnsibleFilterError("missing required element 'DOCUMENTATION' in model")
+        raise AnsibleFilterError("missing required element 'DOCUMENTATION'"
+                                 " in model")
 
     if not isinstance(spec['DOCUMENTATION'], string_types):
-        raise AnsibleFilterError("value of element 'DOCUMENTATION' should be of type string")
+        raise AnsibleFilterError("value of element 'DOCUMENTATION'"
+                                 " should be of type string")
     result = {}
     doc = yaml.safe_load(spec['DOCUMENTATION'])
 

roles/resource_module/filter_plugins/to_doc.py

@@ -6,7 +6,6 @@
 
 import os
 import shutil
-import json
 from subprocess import Popen, PIPE
 
 from copy import deepcopy
@@ -20,17 +19,23 @@
 
 SECTIONS = ('ANSIBLE_METADATA', 'DOCUMENTATION', 'EXAMPLES', 'RETURN')
 
-DOC_SECTION_SANITIZE = ('mutually_exclusive', 'required_together', 'required_one_of', 'supports_check_mode', 'required_if')
+DOC_SECTION_SANITIZE = ('mutually_exclusive', 'required_together',
+                        'required_one_of', 'supports_check_mode',
+                        'required_if')
 
 DEFAULT_RETURN = """
 before:
   description: The configuration prior to the model invocation.
   returned: always
-  sample: The configuration returned will always be in the same format of the parameters above.
+  sample: >
+    The configuration returned will always be in the same format
+     of the parameters above.
 after:
   description: The resulting configuration model invocation.
   returned: when changed
-  sample: The configuration returned will always be in the same format of the parameters above.
+  sample: >
+    The configuration returned will always be in the same format
+     of the parameters above.
 commands:
   description: The set of commands pushed to the remote device.
   returned: always
@@ -47,8 +52,7 @@ def to_list(val):
         return list(val)
     elif val is not None:
         return [val]
-    else:
-        return list()
+    return list()
 
 
 def add(line, spaces=0, newline=True):
@@ -59,27 +63,31 @@ def add(line, spaces=0, newline=True):
         output.write(line)
 
 
-def get_ansible_metadata(spec, path):
+def get_ansible_metadata(spec, _path):
     # write ansible metadata
     if 'ANSIBLE_METADATA' not in spec:
-        raise AnsibleFilterError("missing required element 'ANSIBLE_METADATA' in model")
+        raise AnsibleFilterError("missing required element 'ANSIBLE_METADATA'"
+                                 " in model")
 
     metadata = spec['ANSIBLE_METADATA']
     if not isinstance(metadata, string_types):
-        raise AnsibleFilterError("value of element 'ANSIBLE_METADATA' should be of type string")
+        raise AnsibleFilterError("value of element 'ANSIBLE_METADATA'"
+                                 " should be of type string")
 
     add('ANSIBLE_METADATA = %s' % metadata, newline=True)
-    #add(metadata)
+    # add(metadata)
 
 
-def get_documentation(spec, path):
+def get_documentation(spec, _path):
     # write documentation
     if 'DOCUMENTATION' not in spec:
-        raise AnsibleFilterError("missing required element 'DOCUMENTATION' in model")
+        raise AnsibleFilterError("missing required element 'DOCUMENTATION'"
+                                 " in model")
 
     doc = spec['DOCUMENTATION']
     if not isinstance(doc, string_types):
-        raise AnsibleFilterError("value of element 'DOCUMENTATION' should be of type string")
+        raise AnsibleFilterError("value of element 'DOCUMENTATION' should be"
+                                 " of type string")
 
     add('DOCUMENTATION = """')
     add('---')
@@ -90,22 +98,26 @@ def get_documentation(spec, path):
 def get_examples(spec, path):
     # write examples
     if 'EXAMPLES' not in spec:
-        raise AnsibleFilterError("missing required element 'EXAMPLES' in model")
+        raise AnsibleFilterError("missing required element 'EXAMPLES'"
+                                 " in model")
 
     add('EXAMPLES = """')
     dir_name = os.path.dirname(path)
     for item in to_list(spec['EXAMPLES']):
-        with open(os.path.join(dir_name, item)) as fp:
-            add(fp.read().strip("\n"))
+        with open(os.path.join(dir_name, item)) as fileh:
+            add(fileh.read().strip("\n"))
         add("\n")
     add('"""')
 
 
-def get_return(spec, path):
+def get_return(spec, _path):
     # write return
     ret = spec.get('RETURN')
     add('RETURN = """')
-    add(ret) if ret else add(DEFAULT_RETURN.strip())
+    if ret:
+        add(ret)
+    else:
+        add(DEFAULT_RETURN.strip())
     add('"""')
 
 
@@ -114,28 +126,33 @@ def validate_model(model, contents):
         resource_module_dir = unfrackpath(RM_DIR_PATH)
         makedirs_safe(resource_module_dir)
         module_name = "%s_%s" % (model['NETWORK_OS'], model['RESOURCE'])
-        module_file_path = os.path.join(RM_DIR_PATH, '%s.%s' % (module_name, 'py'))
-        module_file_path = os.path.realpath(os.path.expanduser(module_file_path))
-        with open(module_file_path, 'w+') as fp:
-            fp.write(contents)
+        module_file_path = os.path.join(RM_DIR_PATH, '%s.%s' % (module_name,
+                                                                'py'))
+        exxpath = os.path.expanduser(module_file_path)
+        module_file_path = os.path.realpath(exxpath)
+        with open(module_file_path, 'w+') as fileh:
+            fileh.write(contents)
 
         display.debug("Module file: %s" % module_file_path)
 
         # validate the model
-        cmd = ["ansible-doc", "-M", os.path.dirname(module_file_path), module_name]
-        p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
-        out, err = p.communicate()
+        cmd = ["ansible-doc", "-M", os.path.dirname(module_file_path),
+               module_name]
+        proco = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
+        out, err = proco.communicate()
         if err:
             raise AnsibleError("Error while parsing module: %s" % err)
         display.debug("Module output:\n%s" % out)
-    except Exception as e:
-        raise AnsibleError('Failed to validate the model with error: %s\n%s' % (e, contents))
+    except Exception as err:
+        raise AnsibleError('Failed to validate the model with error: %s\n%s'
+                           % (err, contents))
     finally:
-        shutil.rmtree(os.path.realpath(os.path.expanduser(resource_module_dir)), ignore_errors=True)
+        expuser = os.path.expanduser(resource_module_dir)
+        shutil.rmtree(os.path.realpath(expuser), ignore_errors=True)
 
 
 def _sanitize_documentation(doc):
-    sanitize_doc =[]
+    sanitize_doc = []
     for line in doc.splitlines():
         for item in DOC_SECTION_SANITIZE:
             if line.strip().startswith(item):

roles/resource_module/templates/module_directory/network_os/network_os_facts.py.j2

@@ -1,7 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 # {{ rm['COPYRIGHT'] }}
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
 The module file for {{ network_os }}_facts
 """
@@ -14,7 +15,7 @@ from {{ import_path }}. \
 
 ANSIBLE_METADATA = {'metadata_version': '{{rm_ansible_metadata['metadata_version']}}',
                     'status': {{rm_ansible_metadata['status']}},
-                    'supported_by': '{{rm_ansible_metadata['supported_by']}}',}
+                    'supported_by': '{{rm_ansible_metadata['supported_by']}}'}
 
 
 DOCUMENTATION = """
@@ -82,6 +83,7 @@ RETURN = """
 See the respective resource module parameters for the tree.
 """
 
+
 def main():
     """
     Main entry point for module execution
@@ -93,15 +95,17 @@ def main():
     warnings = ['default value for `gather_subset` \
                 will be changed to `min` from `!config` v2.11 onwards']
 
-    connection = Connection(module._socket_path) #pylint: disable=W0212
+    connection = Connection(module._socket_path)  # pylint: disable=W0212
     gather_subset = module.params['gather_subset']
     gather_network_resources = module.params['gather_network_resources']
-    result = Facts().get_facts(module, connection, gather_subset, gather_network_resources)
+    result = Facts().get_facts(module, connection, gather_subset,
+                               gather_network_resources)
 
     ansible_facts, additional_warnings = result
     warnings.extend(additional_warnings)
 
     module.exit_json(ansible_facts=ansible_facts, warnings=warnings)
 
+
 if __name__ == '__main__':
     main()

roles/resource_module/templates/module_directory/network_os/network_os_resource.py.j2

@@ -1,39 +1,41 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 # {{ rm['COPYRIGHT'] }}
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-##############################################
-################# WARNING ####################
-##############################################
-###
-### This file is auto generated by the resource
-###   module builder playbook.
-###
-### Do not edit this file manually.
-###
-### Changes to this file will be over written
-###   by the resource module builder.
-###
-### Changes should be made in the model used to
-###   generate this file or in the resource module
-###   builder template.
-###
-##############################################
-##############################################
-##############################################
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+#############################################
+#                WARNING                    #
+#############################################
+#
+# This file is auto generated by the resource
+#   module builder playbook.
+#
+# Do not edit this file manually.
+#
+# Changes to this file will be over written
+#   by the resource module builder.
+#
+# Changes should be made in the model used to
+#   generate this file or in the resource module
+#   builder template.
+#
+#############################################
 
 """
 The module file for {{ network_os }}_{{ resource }}
 """
 
 from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+__metaclass__ = type  # pylint: disable=C0103
 
 {{ rm|to_doc(model) }}
+
+# pylint: disable=C0413
 from ansible.module_utils.basic import AnsibleModule
 from {{ import_path }}. \
      {{ network_os }}.config.{{ resource }}.{{ resource }} import {{ resource|capitalize }}
+# pylint: enable=C0413
 
 
 def main():

roles/resource_module/templates/module_utils/network_os/argspec/facts/facts.py.j2

@@ -1,12 +1,14 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 # {{ rm['COPYRIGHT'] }}
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
 The arg spec for the {{ network_os }} facts module.
 """
 
-class FactsArgs(object): #pylint: disable=R0903
+
+class FactsArgs(object):  # pylint: disable=R0903
     """ The arg spec for the {{ network_os }} facts module
     """
 
@@ -20,5 +22,7 @@ class FactsArgs(object): #pylint: disable=R0903
 
     argument_spec = {
         'gather_subset': dict(default=['!config'], type='list'),
-        'gather_network_resources': dict(default=['all'], choices=choices, type='list'),
+        'gather_network_resources': dict(default=['all'],
+                                         choices=choices,
+                                         type='list'),
     }