Linting code (#32)

Linting code according to reported issues from `make lint`.

Author: cmeissner

p3exporter/cache/__init__.py

@@ -1,6 +1,8 @@
+"""Module that defines all needed classes and functions for caching facility."""
 from functools import lru_cache, wraps
 from datetime import datetime, timedelta
 
+
 # found on https://bit.ly/39vlEXs
 # thanks https://realpython.com/team/svaldarrama/ for your awsome article about caching in python
 # has been adapted by us to meet our requirements

p3exporter/collector/__init__.py

@@ -29,7 +29,7 @@ class CollectorBase(object):
     """
 
     def __init__(self, config: CollectorConfig):
-        """Instantiates an CollectorBase object"""
+        """Instantiate a CollectorBase object."""
         self.collector_name = self.collector_name_from_class
         self.opts = config.collector_opts.pop(self.collector_name, {})
 
@@ -58,7 +58,7 @@ class Collector(object):
     """
 
     def __init__(self, config: CollectorConfig):
-        """Instantiates an CollectorBase object"""
+        """Instantiate an CollectorBase object."""
         for c in config.collectors:
             try:
                 collector_module = import_module("p3exporter.collector.{}".format(c), package=None)

p3exporter/collector/example.py

@@ -1,3 +1,4 @@
+"""Module that defines all needed classes and functions for example collector."""
 import random
 import time
 
@@ -30,5 +31,5 @@ def collect(self):
 @timed_lru_cache(10)
 def _run_process():
     """Sample function to ran a command for metrics."""
-    time.sleep(random.random()) # nosec
+    time.sleep(random.random())  # nosec
     return "sucess"

p3exporter/collector/loadavg.py

@@ -1,13 +1,15 @@
+"""Module that defines all needed classes and functions for loadavg collector."""
 import os
 
 from p3exporter.collector import CollectorBase, CollectorConfig
 from prometheus_client.core import GaugeMetricFamily
 
+
 class LoadavgCollector(CollectorBase):
+    """Load avg collector class."""
 
     def __init__(self, config: CollectorConfig):
         """Instanciate a CpuCollector object."""
-
         super(LoadavgCollector, self).__init__(config)
 
     def collect(self):

p3exporter/collector/netdev.py

@@ -1,14 +1,15 @@
+"""Module that defines all needed classes and functions for netdev collector."""
 import netifaces
 
 from p3exporter.collector import CollectorBase, CollectorConfig
 from prometheus_client.core import CounterMetricFamily, InfoMetricFamily
 
 
 class NetdevCollector(CollectorBase):
+    """Netdev collector class."""
 
     def __init__(self, config: CollectorConfig):
         """Instanciate a NetdevCollector object."""
-
         super(NetdevCollector, self).__init__(config)
 
         self.whitelist = self.opts.pop("whitelist", [])
@@ -21,7 +22,6 @@ def collect(self):
 
         Returns several info, couter and gauge metrics for interfaces.
         """
-
         self.ifaces = netifaces.interfaces()
         self.iface_stats = _get_iface_stats()
 
@@ -69,7 +69,6 @@ def _get_iface_stats():
     :return: Returns a dict of dicts. One dict for each interface and one key value pair for each interface statistic in the inner dict.
     :rtype: dict
     """
-
     ifaces = {}
     f = open("/proc/net/dev")
     data = f.read()
@@ -79,26 +78,26 @@ def _get_iface_stats():
         if len(i.strip()) > 0:
             x = i.split()
             k = {
-                x[0][:len( x[0])-1]: {
-                    "tx"        :   {
-                        "bytes"         :   int(x[1]),
-                        "packets"       :   int(x[2]),
-                        "errs"          :   int(x[3]),
-                        "drop"          :   int(x[4]),
-                        "fifo"          :   int(x[5]),
-                        "frame"         :   int(x[6]),
-                        "compressed"    :   int(x[7]),
-                        "multicast"     :   int(x[8])
+                x[0][:len(x[0]) - 1]: {
+                    "tx": {
+                        "bytes": int(x[1]),
+                        "packets": int(x[2]),
+                        "errs": int(x[3]),
+                        "drop": int(x[4]),
+                        "fifo": int(x[5]),
+                        "frame": int(x[6]),
+                        "compressed": int(x[7]),
+                        "multicast": int(x[8])
                     },
-                    "rx"        :   {
-                        "bytes"         :   int(x[9]),
-                        "packets"       :   int(x[10]),
-                        "errs"          :   int(x[11]),
-                        "drop"          :   int(x[12]),
-                        "fifo"          :   int(x[13]),
-                        "frame"         :   int(x[14]),
-                        "compressed"    :   int(x[15]),
-                        "multicast"     :   int(x[16])
+                    "rx": {
+                        "bytes": int(x[9]),
+                        "packets": int(x[10]),
+                        "errs": int(x[11]),
+                        "drop": int(x[12]),
+                        "fifo": int(x[13]),
+                        "frame": int(x[14]),
+                        "compressed": int(x[15]),
+                        "multicast": int(x[16])
                     }
                 }
             }

p3exporter/web.py

@@ -20,7 +20,7 @@ def create_app(config: CollectorConfig):
     app = Flask(__name__, instance_relative_config=True)
 
     @app.route("/")
-    def index(): # pylint: disable=W0612
+    def index():  # pylint: disable=W0612
         return render_template("index.html", title=config.exporter_name)
 
     dispatched_app = DispatcherMiddleware(app, {