Merge pull request #106 from bastelfreak/pep257

bastelfreak · web-flow · commit c40ae79b122a · 2019-02-05T12:37:04.000+01:00
pep257: fix D401/D400
diff --git a/.prospector.yaml b/.prospector.yaml
@@ -8,6 +8,9 @@ pep257:
   disable:
     - D203
     - D212
+  enable:
+    - D400
+    - D401
 pep8:
   run: true
   full: true
diff --git a/marmoset/__init__.py b/marmoset/__init__.py
@@ -1,4 +1,4 @@
-"""initial file that handles marmoset"""
+"""initial file that handles marmoset."""
 from marmoset import cli
 from marmoset import config
 
diff --git a/marmoset/cli/__init__.py b/marmoset/cli/__init__.py
@@ -1,4 +1,4 @@
-"""initial file that handles all CLI operations"""
+"""initial file that handles all CLI operations."""
 from argparse import ArgumentParser
 
 
diff --git a/marmoset/cli/imagecatalog_parser.py b/marmoset/cli/imagecatalog_parser.py
@@ -1,9 +1,9 @@
-"""ClI module for imagecatalog"""
+"""ClI module for imagecatalog."""
 from .. import imagecatalog
 
 
 def add_to(parser, name, **kwargs):
-    """Updates the CLI parser to support imagecatalog"""
+    """Update the CLI parser to support imagecatalog."""
     command = parser.add_parser(name, **kwargs)
     subcommands = command.add_subparsers(title='%s subcommands' % name)
 
diff --git a/marmoset/cli/installstatus_parser.py b/marmoset/cli/installstatus_parser.py
@@ -1,10 +1,10 @@
-"""ClI module for installimage status updates"""
+"""ClI module for installimage status updates."""
 from .. import installstatus
 
 
 def add_to(parser, name, **kwargs):
     """
-    Updates the CLI parser to support installimage status updates and stats.
+    Update the CLI parser to support installimage status updates and stats.
 
     supports a lot of information based on a UUID. For example a list of
     all status updates a UUID got, the last update it got or some stats for it.
diff --git a/marmoset/config.py b/marmoset/config.py
@@ -1,4 +1,4 @@
-"""Module to parse our config"""
+"""Module to parse our config."""
 import configparser
 import socket
 import warnings
@@ -8,7 +8,7 @@
 
 
 def default():
-    """Get default values"""
+    """Get default values."""
     config = configparser.ConfigParser()
 
     config['Common'] = dict(
@@ -44,7 +44,7 @@ def default():
 
 
 def read_file(file_path=None):
-    """Read our config file"""
+    """Read our config file."""
     config = default()
     if file_path is None:
         file_path = PATH
@@ -56,7 +56,7 @@ def read_file(file_path=None):
 
 
 def load_config(file_path=None):
-    """Get all options from our config"""
+    """Get all options from our config."""
     config = read_file(file_path)
 
     if config['Modules'].getboolean('PXE'):
diff --git a/marmoset/dhcp/__init__.py b/marmoset/dhcp/__init__.py
@@ -1,4 +1,4 @@
-"""initial file for dealing with DHCP"""
+"""initial file for dealing with DHCP."""
 from .dhcp_config import DhcpConfig
 from .isc_dhcp_ldap_config import ISCDhcpLdapConfig
 
diff --git a/marmoset/dhcp/dhcp_config.py b/marmoset/dhcp/dhcp_config.py
@@ -6,10 +6,10 @@
 
 
 class DhcpConfig:
-    """Model for a DHCP object"""
+    """Model for a DHCP object."""
 
     def __init__(self, mac, ip_address, gateway=None, networkmask=None):
-        """Initialize all attributes with default values"""
+        """Initialize all attributes with default values."""
         self.additional_statements = {}
 
         self.mac = None
diff --git a/marmoset/dhcp/isc_dhcp_ldap_config.py b/marmoset/dhcp/isc_dhcp_ldap_config.py
@@ -1,4 +1,4 @@
-"""Module to provide LDAP access for our DHCP stuff"""
+"""Module to provide LDAP access for our DHCP stuff."""
 
 
 import re
@@ -13,10 +13,10 @@
 
 
 class ISCDhcpLdapConfig:
-    """Initial class to connect to our LDAP"""
+    """Initial class to connect to our LDAP."""
 
     def __init__(self, dhcp_config):
-        """Initialize the dhcp configuration credentials and URI"""
+        """Initialize the dhcp configuration credentials and URI."""
         self.dhcp_config = dhcp_config
 
     @staticmethod
@@ -33,7 +33,7 @@ def __get_server_connection():
         return conn
 
     def save(self):
-        """Saves a DHCP entry for a single node in an LDAP database"""
+        """Save a DHCP entry for a single node in an LDAP database."""
         conn = self.__get_server_connection()
 
         dhcp_statements = ["fixed-address %s;" % self.dhcp_config.ip_address,
@@ -61,7 +61,7 @@ def save(self):
 
     @staticmethod
     def get_all_db_entries():
-        """Method to get all entries from our DB"""
+        """Return all IPs? from our DB."""
         conn = ISCDhcpLdapConfig.__get_server_connection()
 
         entry_generator = conn.extend.standard.paged_search(
@@ -81,7 +81,7 @@ def get_all_db_entries():
 
     @staticmethod
     def __get_dn_by_ipv4(ip_address, multi=False):
-        """Get a DN for a certain entry based on the provided ipv4 address"""
+        """Get a DN for a certain entry based on the provided ipv4 address."""
         conn = ISCDhcpLdapConfig.__get_server_connection()
         conn.search(
             search_base=config['DHCPConfig'].get('ldap_client_base_dn'),
@@ -111,7 +111,7 @@ def __get_dn_by_ipv4(ip_address, multi=False):
 
     @staticmethod
     def __get_dn_by_mac(mac_address, multi=False):
-        """Get a DN for a certain entry based on the provided MAC address"""
+        """Get a DN for a certain entry based on the provided MAC address."""
         conn = ISCDhcpLdapConfig.__get_server_connection()
         conn.search(
             search_base=config['DHCPConfig'].get('ldap_client_base_dn'),
@@ -141,7 +141,7 @@ def __get_dn_by_mac(mac_address, multi=False):
 
     @staticmethod
     def __get_dhcp_config(distinguished_name):
-        """Gets a LDAP object based on the provided DN"""
+        """Get a LDAP object based on the provided DN."""
         # pylint: disable-msg=too-many-locals
         from marmoset.dhcp import DhcpConfig
 
@@ -198,7 +198,7 @@ def __get_dhcp_config(distinguished_name):
 
     @staticmethod
     def get_by_ip(ip_address):
-        """Gets a config based on the provided IP"""
+        """Get a config based on the provided IP."""
         distinguished_name = ISCDhcpLdapConfig.__get_dn_by_ipv4(ip_address)
 
         if distinguished_name is None:
@@ -208,7 +208,7 @@ def get_by_ip(ip_address):
 
     @staticmethod
     def get_by_mac(mac_address):
-        """Gets a config based on the provided MAC"""
+        """Get a config based on the provided MAC."""
         distinguished_name = ISCDhcpLdapConfig.__get_dn_by_mac(mac_address)
 
         if distinguished_name is None:
@@ -218,7 +218,7 @@ def get_by_mac(mac_address):
 
     @staticmethod
     def remove_by_ipv4(ipv4):
-        """Remove an entry based on the IP"""
+        """Remove an entry based on the IP."""
         dn_list = ISCDhcpLdapConfig.__get_dn_by_ipv4(ipv4, multi=True)
 
         for distinguished_name in dn_list:
@@ -230,7 +230,7 @@ def remove_by_ipv4(ipv4):
 
     @staticmethod
     def remove_by_mac(mac):
-        """Remove an entry based on the MAC"""
+        """Remove an entry based on the MAC."""
         dn_list = ISCDhcpLdapConfig.__get_dn_by_mac(mac, multi=True)
 
         for distinguished_name in dn_list:
diff --git a/marmoset/imagecatalog/__init__.py b/marmoset/imagecatalog/__init__.py
@@ -1,10 +1,10 @@
-"""Initial file for the image catalog"""
+"""Initial file for the image catalog."""
 
 from .catalog import ImageCatalog
 
 
 def list_all(args):
-    """List all images"""
+    """List all images."""
     # pylint: disable-msg=unused-argument
     catalog = ImageCatalog()
     metadata_list = catalog.list_all_metadata()
@@ -13,7 +13,7 @@ def list_all(args):
 
 
 def print_metadata(metadata_dict):
-    """Prints the image's metadata dict"""
+    """Print the image's metadata dict."""
     spacer = '-' * 40
     print('%s\nimage_file: %s\n%s' % (
         spacer, metadata_dict['image_file'], spacer))
diff --git a/marmoset/imagecatalog/catalog.py b/marmoset/imagecatalog/catalog.py
@@ -1,4 +1,4 @@
-"""Module for listing all images"""
+"""Module for listing all images."""
 from .image import Image
 import glob
 import os
@@ -9,7 +9,7 @@ class ImageCatalog:
     IMAGE_EXTENSTIONS = ['tar.gz']
 
     def __init__(self):
-        """We don't initialize anything here"""
+        """We don't initialize anything here."""
         pass
 
     def list_all_image_files(self):
diff --git a/marmoset/imagecatalog/image.py b/marmoset/imagecatalog/image.py
@@ -1,15 +1,15 @@
-"""Module for reading the image metadata"""
+"""Module for reading the image metadata."""
 import os
 import yaml
 
 
 class Image:
-    """reads/creates some image related metadata"""
+    """read/create some image related metadata."""
 
     METADATA_EXT = '.metadata'
 
     def __init__(self, image_path):
-        """Initialize all attributes with default values"""
+        """Initialize all attributes with default values."""
         self.image_path = image_path
         self.basename = os.path.basename(self.image_path)
         self.dirname = os.path.dirname(image_path)
diff --git a/marmoset/installimage/__init__.py b/marmoset/installimage/__init__.py
@@ -18,7 +18,7 @@ def create(args):
 
 
 def dolist(args):
-    """Print all configs"""
+    """Print all configs."""
     # pylint: disable-msg=unused-argument
     for install_config in InstallimageConfig.all():
         print('%s' % install_config.mac)
diff --git a/marmoset/installimage/installimage_config.py b/marmoset/installimage/installimage_config.py
@@ -5,7 +5,7 @@
 
 
 class InstallimageConfig:
-    """Handles installimage configuration for clients"""
+    """Handle installimage configuration for clients."""
 
     CFG_DIR = '/srv/tftp/installimage/'
 
@@ -79,7 +79,7 @@ def __read_config_file(self, path=None):
                 self.variables[key].append(value)
 
     def get_content(self):
-        """Reads a config and parses it."""
+        """Read a config and parses it."""
         variable_lines = []
         for key in self.variables:
             for value in self.variables[key]:
diff --git a/marmoset/installstatus/__init__.py b/marmoset/installstatus/__init__.py
@@ -1,4 +1,4 @@
-"""Initial file for installstatus"""
+"""Initial file for installstatus."""
 from uuid import UUID
 from marmoset import validation
 from .installstatus import InstallStatus
diff --git a/marmoset/installstatus/db_helper.py b/marmoset/installstatus/db_helper.py
@@ -13,7 +13,7 @@ class DBHelper:
     @classmethod
     def _connect(cls):
         """
-        Connects to SQLite DB defined in marmoset config.
+        Connect to SQLite DB defined in marmoset config.
 
         :return: sqlite3 connection to DB using a row cursor.
         """
diff --git a/marmoset/installstatus/installstatus.py b/marmoset/installstatus/installstatus.py
@@ -49,7 +49,7 @@ def insert_status(self, status_code, step_description,
 
     def get_stats(self):
         """
-        Generates some stats related to the installimage job.
+        Generate some stats related to the installimage job.
 
         :return: stats
         :rtype: dict
diff --git a/marmoset/pxe/client_config.py b/marmoset/pxe/client_config.py
@@ -270,10 +270,10 @@ def __mksalt(self):
         return crypt.mksalt(crypt.METHOD_SHA512)
 
     def cb_setpwhash(self):
-        """Callback that adds a HASH= string to the command line."""
+        """Create a callback that adds a HASH= string to the command line."""
         return 'HASH=' + self.__mkpwhash()
 
     def cb_createpwhashfile(self):
-        """Callback that creates a password hash file."""
+        """Create a callback that creates a password hash file."""
         file_path = self.file_path('PWHASH.' + self.ip_address)
         self.__write_config_file(self.__mkpwhash(), file_path)
diff --git a/marmoset/webserver/__init__.py b/marmoset/webserver/__init__.py
@@ -18,7 +18,7 @@ def jsonify_nl(*args, **kwargs):
 
 
 def app(config):
-    """Setup the initial flask app."""
+    """Prepare the initial flask app."""
     auth.Username = config['Webserver'].get('Username')
     auth.Password = config['Webserver'].get('Password')
 
@@ -92,7 +92,7 @@ def not_found(ex):
 
     @app.errorhandler(401)
     def unauthorized(ex):
-        """Generate a 401"""
+        """Generate a 401."""
         # pylint: disable-msg=unused-argument
         # pylint: disable-msg=unused-variable
         resp = jsonify_nl(message="Unauthorized", status=401)
diff --git a/marmoset/webserver/dhcp.py b/marmoset/webserver/dhcp.py
@@ -128,7 +128,7 @@ def put(self, ipv4):
         return vars(dhcp_config), 201, {'Location': location}
 
     def delete(self, ipv4):
-        """Deletes a DHCP record"""
+        """Delete a DHCP record."""
         if not validation.is_ipv4(ipv4):
             return {'message': 'please provide a valid ipv4 address'}, 406
 
diff --git a/marmoset/webserver/installimage.py b/marmoset/webserver/installimage.py
@@ -57,7 +57,7 @@ def delete(self, mac):
 
 
 class InstallimageConfigCommand(Resource):
-    """Class for handling installimage configs"""
+    """Class for handling installimage configs."""
 
     def get(self, mac):
         """Return the configuration as installimage format."""

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""initial file that handles marmoset"""`
	`1`	`+"""initial file that handles marmoset."""`
`2`	`2`	`from marmoset import cli`
`3`	`3`	`from marmoset import config`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""initial file that handles all CLI operations"""`
	`1`	`+"""initial file that handles all CLI operations."""`
`2`	`2`	`from argparse import ArgumentParser`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""initial file for dealing with DHCP"""`
	`1`	`+"""initial file for dealing with DHCP."""`
`2`	`2`	`from .dhcp_config import DhcpConfig`
`3`	`3`	`from .isc_dhcp_ldap_config import ISCDhcpLdapConfig`
`4`	`4`