Improved linting and fixed minor issues

Author: tiptr

.pylintrc

@@ -0,0 +1,12 @@
+[MESSAGES CONTROL]
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time.
+#enable=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once).
+disable=C0103, C0114, C0116

.vscode/settings.json

@@ -5,6 +5,6 @@
     "python.analysis.diagnosticMode": "workspace",
     "python.linting.pylintEnabled": true,
     "python.linting.pylintArgs": [
-        "--enable=W0611"
+        "--rcfile=.pylintrc"
     ]
 }

backend/specialized_databases/files/s3/S3PersistenceService.py

@@ -1,3 +1,5 @@
+""" S3 compatible persistence service """
+
 import boto3
 from botocore.client import Config
 
@@ -7,6 +9,12 @@
 
 
 class S3PersistenceService(FilesPersistenceService):
+    """S3 compatible persistence service
+
+    Args:
+        FilesPersistenceService (_type_): _description_
+    """
+
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
@@ -43,8 +51,8 @@ def stream_file(
         :return:
         :raise IdNotFoundException: if the iri is not found
         """
-        object = self.bucket.Object(iri)
-        response = object.get()
+        file_object = self.bucket.Object(iri)
+        response = file_object.get()
         file_stream = response["Body"]
         return file_stream
 

dt_backend.py

@@ -1,22 +1,24 @@
-import json
+"""
+Main entry point for the application layer
+Handles the sensor-connections and provides a API
+Introducing services for querying the KG
+Separated from api.py to avoid circular dependencies with endpoint
+files importing the "app" instance.
+"""
 
 import uvicorn
 
 from backend.api.api import app
 from backend.knowledge_graph.KnowledgeGraphPersistenceService import (
     KnowledgeGraphPersistenceService,
 )
-from backend.knowledge_graph.dao.DatabaseConnectionsDao import DatabaseConnectionsDao
 from backend.knowledge_graph.dao.TimeseriesNodesDao import TimeseriesNodesDao
 from backend.runtime_connections.RuntimeConnectionContainer import (
     RuntimeConnectionContainer,
 )
 from backend.specialized_databases.DatabasePersistenceServiceContainer import (
     DatabasePersistenceServiceContainer,
 )
-from backend.specialized_databases.timeseries.influx_db.InfluxDbPersistenceService import (
-    InfluxDbPersistenceService,
-)
 
 
 # Import endpoint files (indirectly used through annotation)
@@ -45,20 +47,14 @@
     get_environment_variable_int,
 )
 
-"""
-Main entry point for the application layer
-Handles the sensor-connections and provides a API
-Introducing services for querying the KG
-Separated from api.py to avoid circular dependencies with endpoint files importing the "app" instance. 
-"""
-
 
 # #############################################################################
 # Setup sensor connections and timeseries persistence
 # #############################################################################
 def init_database_connections():
     print("Initializing database connections...")
 
+    # pylint: disable=W0612
     db_con_container: DatabasePersistenceServiceContainer = (
         DatabasePersistenceServiceContainer.instance()
     )
@@ -69,6 +65,7 @@ def init_database_connections():
 def init_sensors():
     print("Initializing timeseries inputs...")
 
+    # pylint: disable=W0612
     kg_service: KnowledgeGraphPersistenceService = (
         KnowledgeGraphPersistenceService.instance()
     )

frontend/main_column/factory_graph/factory_graph_callbacks.py

@@ -1,8 +1,7 @@
 from datetime import datetime
-from dash import ctx
+from dash import ctx, Input, Output, State
 from dash.exceptions import PreventUpdate
 import pytz
-from dash.dependencies import Input, Output, State
 from util.environment_and_configuration import (
     ConfigGroups,
     get_configuration_int,
@@ -48,7 +47,8 @@ def update_factory_graph(
     :return:
     """
 
-    # Reload from backend when button manually clicked (n > 1), no graph is stored locally, or the stored one is older than the configured max age
+    # Reload from backend when button manually clicked (n > 1), no graph is stored locally,
+    # or the stored one is older than the configured max age
     if (
         n_clicks > 1
         or stored_graph is None
@@ -75,6 +75,7 @@ def update_factory_graph(
     return cygraph_elements, cygraph_elements, datetime.now().isoformat(), True
 
 
+# pylint: disable=W0613
 @app.callback(
     Output("graph-reload-button", "n_clicks"),
     Input("interval-component-factory-graph", "n_intervals"),
@@ -109,7 +110,8 @@ def factory_graph_update_trigger(
         raise PreventUpdate()
     elif graph_loaded is None and n_init_intervall == 4:
         print(
-            "Graph not loaded after first intervall. Checking if reloading from backend or local storage..."
+            "Graph not loaded after first intervall. "
+            "Checking if reloading from backend or local storage..."
         )
         if _get_graph_age_seconds(local_timestamp) > get_configuration_int(
             group=ConfigGroups.FRONTEND, key="max_graph_age"
@@ -221,7 +223,7 @@ def update_node_position(n_clicks, selected_el_json):
     )
 
     # Notify the user with an auto-dismissing alert:
-    return f"New node position saved!", True, datetime.now()
+    return "New node position saved!", True, datetime.now()
 
 
 @app.callback(
@@ -233,7 +235,8 @@ def update_node_position(n_clicks, selected_el_json):
 def toggle_layout_saver_visibility(selected_el_json, elements):
     """
     Called whenever a element is selected (or de-selected) in the graph, or when the graph changes.
-    Provides the user with a visible save-functionality for the altered node position, if a node is selected, that
+    Provides the user with a visible save-functionality for the altered node position,
+    if a node is selected, that
     the user moved via drag and drop.
     :param selected_el_json:
     :param elements: