make templated files lint within reason, add comments

Author: Bradley A. Thornton

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

@@ -23,12 +23,14 @@
 ##############################################
 ##############################################
 
+"""
+The module file for {{ network_os }}_{{ resource }}
+"""
+
 from __future__ import absolute_import, division, print_function
 from ansible.module_utils.basic import AnsibleModule
-from {{ import_path }}.{{ network_os }}.config.{{ resource }}.{{ resource }} import {{ resource|capitalize }}
-
-__metaclass__ = type
-
+from {{ import_path }}. \
+     {{ network_os }}.config.{{ resource }}.{{ resource }} import {{ resource|capitalize }}
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -70,14 +72,16 @@ commands:
 
 
 def main():
-    """ main entry point for module execution
+    """
+    Main entry point for module execution
+
+    :returns: the result form module invocation
     """
     module = AnsibleModule(argument_spec={{ resource|capitalize }}.argument_spec,
                            supports_check_mode=True)
 
     result = {{ resource|capitalize }}(module).execute_module()
     module.exit_json(**result)
 
-
 if __name__ == '__main__':
     main()

roles/resource_module/templates/module_utils/network/argspec/base.py renamed to roles/resource_module/templates/module_utils/network/argspec/base.py.j2

@@ -2,8 +2,11 @@
 # -*- coding: utf-8 -*-
 # {{ rm['metadata']['copyright_str'] }}
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+""" The argspec base class
+"""
 
-class ArgspecBase(object):
-
+class ArgspecBase(object): #pylint: disable=R0205,R0903
+    """ The argspec base class
+    """
     def __init__(self, **kwargs):
         pass

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

@@ -2,11 +2,16 @@
 # -*- coding: utf-8 -*-
 # {{ rm['metadata']['copyright_str'] }}
 # 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.
+"""
 
-from {{ import_path }}.network.argspec.base import ArgspecBase
-
-class FactsArgs(ArgspecBase):
+from {{ import_path }}. \
+     network.argspec.base import ArgspecBase
 
+class FactsArgs(ArgspecBase): #pylint: disable=R0903
+    """ The arg spec for the {{ network_os }} facts module
+    """
     argument_spec = {
         'gather_subset': dict(default=['all'], type='list')
     }

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

@@ -22,10 +22,14 @@
 ##############################################
 ##############################################
 ##############################################
+"""
+The arg spec for the {{ network_os }}_{{ resource }} module
+"""
 
+from {{ import_path }}. \
+     network.argspec.base import ArgspecBase
 
-from {{ import_path }}.network.argspec.base import ArgspecBase
-
-class {{ resource|capitalize }}Args(ArgspecBase):
-
-    argument_spec = {{ rm|to_argspec }}
+class {{ resource|capitalize }}Args(ArgspecBase): #pylint: disable=R0903
+    """The arg spec for the {{ network_os }}_{{ resource }} module
+    """
+    argument_spec = {{ rm|to_argspec }} #pylint: disable=C0301

roles/resource_module/templates/module_utils/network_os/config/base.py.j2

@@ -2,11 +2,15 @@
 # -*- coding: utf-8 -*-
 # {{ rm['metadata']['copyright_str'] }}
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+The base class for all {{ network_os }} resource modules
+"""
 
 from ansible.module_utils.connection import Connection
 
-class ConfigBase(object):
-
+class ConfigBase(object): #pylint: disable=R0205,R0903
+    """ The base class for all {{ network_os }} resource modules
+    """
     _connection = None
 
     def __init__(self, module):
@@ -16,5 +20,5 @@ class ConfigBase(object):
     def _get_connection(self):
         if self._connection:
             return self._connection
-        self._connection = Connection(self._module._socket_path)
+        self._connection = Connection(self._module._socket_path) #pylint: disable=W0212
         return self._connection

roles/resource_module/templates/module_utils/network_os/config/resource/resource.py.j2

@@ -2,29 +2,51 @@
 # -*- coding: utf-8 -*-
 # {{ rm['metadata']['copyright_str'] }}
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+The {{ network_os }}_{{ resource }} class
+It is in this file where the current configuration (as dict)
+is compared to the provided configuration (as dict) and the command set
+necessary to bring the current configuration to it's desired end-state is
+created
+"""
 
-from ansible.module_utils.six import iteritems
 from ansible.module_utils.network.common.utils import to_list
 
-from {{ import_path }}.{{ network_os }}.argspec.{{ resource }}.{{ resource }} import {{ resource|capitalize }}Args
-from {{ import_path }}.{{ network_os }}.config.base import ConfigBase
-from {{ import_path }}.{{ network_os }}.facts.facts import Facts
-
+from {{ import_path }}. \
+     {{ network_os }}.argspec.{{ resource }}.{{ resource }} import {{ resource|capitalize }}Args
+from {{ import_path }}. \
+     {{ network_os }}. \
+     config.base import ConfigBase
+from {{ import_path }}. \
+     {{ network_os }}.facts.facts import Facts
 
 class {{ resource|capitalize }}(ConfigBase, {{ resource|capitalize }}Args):
+    """
+    The {{ network_os }}_{{ resource }} class
+    """
 
     gather_subset = [
         'net_configuration_{{ resource }}',
     ]
 
     def get_{{ resource }}_facts(self):
+        """ Get the 'facts' (the current configuration)
+
+        :rtype: A dictionary
+        :returns: The current configuration as a dictionary
+        """
         facts = Facts().get_facts(self._module, self._connection, self.gather_subset)
         {{ resource }}_facts = facts['net_configuration'].get('{{ resource }}')
         if not {{ resource }}_facts:
             return []
         return {{ resource }}_facts
 
     def execute_module(self):
+        """ Execute the module
+
+        :rtype: A dictionary
+        :returns: The result from moduel execution
+        """
         result = {'changed': False}
         commands = list()
         warnings = list()
@@ -46,12 +68,27 @@ class {{ resource|capitalize }}(ConfigBase, {{ resource|capitalize }}Args):
         return result
 
     def set_config(self):
+        """ Collect the configuration from the args passed to the module,
+            collect the current configuration (as a dict from facts)
+
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
         want = self._module.params['config']
         have = self.get_{{ resource }}_facts()
         resp = self.set_state(want, have)
         return to_list(resp)
 
     def set_state(self, want, have):
+        """ Select the appropriate function based on the state provided
+
+        :param want: the desired configuration as a dictionary
+        :param have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
         state = self._module.params['state']
         if state == 'overridden':
             commands = self._state_overridden(want, have)
@@ -63,18 +100,63 @@ class {{ resource|capitalize }}(ConfigBase, {{ resource|capitalize }}Args):
             commands = self._state_replaced(want, have)
         return commands
 
-    def _state_replaced(self, want, have):
+    @staticmethod
+    def _state_replaced(want, have):
+        """ The command generator when state is replaced
+
+        :param want: the desired configuration as a dictionary
+        :param have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
+        if want != have:
+            # compare and generate command set
+            pass
         commands = []
         return commands
 
-    def _state_overridden(self, want, have):
+    @staticmethod
+    def _state_overridden(want, have):
+        """ The command generator when state is overridden
+
+        :param want: the desired configuration as a dictionary
+        :param have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
+        if want != have:
+            pass
         commands = []
         return commands
 
-    def _state_merged(self, want, have):
+    @staticmethod
+    def _state_merged(want, have):
+        """ The command generator when state is merged
+
+        :param want: the additive configuration as a dictionary
+        :param have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to merge the provided into
+                  the current configuration
+        """
+        if want != have:
+            pass
         commands = []
         return commands
 
-    def _state_deleted(self, want, have):
+    @staticmethod
+    def _state_deleted(want, have):
+        """ The command generator when state is deleted
+
+        :param want: the objects from which the configuration should be removed
+        :param have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to remove the current configuration
+                  of the provided objects
+        """
+        if want != have:
+            pass
         commands = []
         return commands

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

@@ -2,16 +2,20 @@
 # -*- coding: utf-8 -*-
 # {{ rm['metadata']['copyright_str'] }}
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+The {{ network_os }} facts base class
+this contains methods common to all facts subsets
+"""
 
 import re
-
 from copy import deepcopy
-
 from ansible.module_utils.six import iteritems
 
 
-class FactsBase(object):
-
+class FactsBase(object): #pylint: disable=R0205
+    """
+    The {{ network_os }} facts base class
+    """
     generated_spec = {}
     ansible_facts = {'net_configuration': {}}
 
@@ -27,7 +31,8 @@ class FactsBase(object):
 
         self.generated_spec = self.generate_dict(facts_argument_spec)
 
-    def generate_dict(self, spec):
+    @staticmethod
+    def generate_dict(spec):
         """
         Generate dictionary which is in sync with argspec
 
@@ -39,16 +44,17 @@ class FactsBase(object):
         if not spec:
             return obj
 
-        for k, v in iteritems(spec):
-            if 'default' in v:
-                d = {k: v['default']}
+        for key, val in iteritems(spec):
+            if 'default' in val:
+                dct = {key: val['default']}
             else:
-                d = {k: None}
-            obj.update(d)
+                dct = {key: None}
+            obj.update(dct)
 
         return obj
 
-    def parse_conf_arg(self, cfg, arg):
+    @staticmethod
+    def parse_conf_arg(cfg, arg):
         """
         Parse config based on argument
 
@@ -59,9 +65,13 @@ class FactsBase(object):
         """
         match = re.search(r'%s (.+)(\n|$)' % arg, cfg, re.M)
         if match:
-            return match.group(1).strip()
+            result = match.group(1).strip()
+        else:
+            result = None
+        return result
 
-    def parse_conf_cmd_arg(self, cfg, cmd, res1, res2=None):
+    @staticmethod
+    def parse_conf_cmd_arg(cfg, cmd, res1, res2=None):
         """
         Parse config based on command
 
@@ -75,13 +85,14 @@ class FactsBase(object):
         match = re.search(r'\n\s+%s(\n|$)' % cmd, cfg)
         if match:
             return res1
-        else:
-            if res2 is not None:
-                match = re.search(r'\n\s+no %s(\n|$)' % cmd, cfg)
-                if match:
-                    return res2
-
-    def generate_final_config(self, cfg_dict):
+        if res2 is not None:
+            match = re.search(r'\n\s+no %s(\n|$)' % cmd, cfg)
+            if match:
+                return res2
+        return None
+
+    @staticmethod
+    def generate_final_config(cfg_dict):
         """
         Generate final config dictionary
 
@@ -93,8 +104,7 @@ class FactsBase(object):
         if not cfg_dict:
             return final_cfg
 
-        for k, v in iteritems(cfg_dict):
-            if v is not None:
-                final_cfg.update({k:v})
-
+        for key, val in iteritems(cfg_dict):
+            if val is not None:
+                final_cfg.update({key:val})
         return final_cfg