Merge pull request #31 from cmeissner/issue/codacy_fixes

Tidying code to meet some style guides

Author: cmeissner

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,8 +20,8 @@ A clear and concise description of what you expected to happen.
 **Versions:**
 
 - Ansible:
-- phpipam-ansible-modules
-- phpypam
+- phpipam-ansible-modules:
+- phpypam:
 
 **Additional context**
 Add any other context about the problem here.

doc_fragments/phpipam.py

@@ -1,7 +1,5 @@
 # Copyright (c) 2020 Christian Meißner
 # 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
 
@@ -10,7 +8,6 @@
 
 
 class FilterModule(object):
-
     """Define useful filter in collection."""
 
     def filters(self):
@@ -29,12 +26,12 @@ def is_subnet(children, parent):
 
     First argument is a subnet  second another. If the first subnet belongs to second
 
-    :param children: [description]
-    :type children: [type]
-    :param parent: [description]
-    :type parent: [type]
-    :return: [description]
-    :rtype: [type]
+    :param children: First subnet in cidr format which should belongs to parent
+    :type children: string
+    :param parent: Second subnet where children should belongs to
+    :type parent: string
+    :return: True if children belongs to parent and false if not or both networks are the same.
+    :rtype: bool
     """
     c = ipaddress.ip_network(children)
     p = ipaddress.ip_network(parent)

plugins/filter/phpipam.py

@@ -0,0 +1 @@
+"""Utilities module."""

plugins/module_utils/__init__.py

@@ -8,15 +8,13 @@
 __metaclass__ = type
 
 import re
-import json
 import traceback
 import inflection
 
 from contextlib import contextmanager
 
 try:
     import phpypam
-    from phpypam.core.exceptions import PHPyPAMInvalidSyntax
     from phpypam import PHPyPAMEntityNotFoundException
     HAS_PHPIPAM = True
 except ImportError:
@@ -37,6 +35,7 @@ class PhpipamAnsibleException(Exception):
 
 class PhpipamAnsibleModule(AnsibleModule):
     """ Baseclass for all phpIPAM related ansible modules.
+
         Here we handle connection parameters.
     """
 
@@ -52,6 +51,7 @@ class PhpipamAnsibleModule(AnsibleModule):
     )
 
     def __init__(self, **kwargs):
+        """Generate PhpipamAnsibleModule."""
         # State recording for changed and diff reporting
         self._changed = False
         self._before = defaultdict(list)
@@ -94,9 +94,9 @@ def __init__(self, **kwargs):
 
     @contextmanager
     def api_connection(self):
-        """
-        Context manager. Run a given code block after successful api connect.
+        """Context manager.
 
+        Run a given code block after successful api connect.
         If the execution is done call `exit_json` to report the module has finished.
         """
         self.connect()
@@ -126,7 +126,7 @@ def find_entity(self, controller, path, params=None):
         except PHPyPAMEntityNotFoundException:
             return None
 
-        if type(result) == list:
+        if isinstance(result, list):
             if len(result) == 1:
                 result = result[0]
             else:
@@ -229,7 +229,8 @@ def _resolve_entity(self, key):
         return result
 
     def _auto_resolve_entities(self):
-        """
+        """Resolve entities to the needed id.
+
         Here we resolve each parameter of type entity and create a updated_entity dict with
         all params and resolved params
         """
@@ -415,7 +416,9 @@ def __init__(self, **kwargs):
 
     @property
     def controller_name_from_class(self):
-        """ Convert class name to controller name. The class name must follow folowing name convention:
+        """ Convert class name to controller name.
+
+        The class name must follow folowing name convention:
             * Starts with Phpipam
             * Ends with Module
 
@@ -457,19 +460,6 @@ def controller_pluralize(self, controller):
 
         return controller
 
-    def entity_name_to_id(self, entity_name):
-        try:
-            result = self.find_entity(controller=self.controller_uri, controller_path='/' + entity_name)
-        except PHPyPAMEntityNotFoundException:
-            raise PhpipamAnsibleException
-
-        entity = json.load(result)
-
-        try:
-            return entity['id']
-        except KeyError:
-            raise PhpipamAnsibleException
-
     def record_before(self, controller, entity):
         self._before[controller].append(entity)
 

plugins/module_utils/phpipam_helper.py

@@ -0,0 +1 @@
+"""Modules init"""