fix pylint issues

dev-tools/dev_tools.py

@@ -206,7 +206,10 @@ def _maybe_create_diagrams(arguments):
         diagrams_format = (
             arguments.diagramsFormat if arguments.diagramsFormat else "pdf"
         )
-        cmd = f"{_SCRIPTS_DIR / 'pyreverse'} -k -o {diagrams_format} -p pytrnsys_process -d test-results pytrnsys_process"
+        cmd = (
+            f"{_SCRIPTS_DIR / 'pyreverse'} -k -o {diagrams_format}"
+            " -p pytrnsys_process -d test-results pytrnsys_process"
+        )
         _print_and_run(cmd.split())
 
 
@@ -236,7 +239,8 @@ def _run_unit_tests_with_pytest(arguments, test_results_dir_path):
     cmd = [
         _SCRIPTS_DIR / "pytest",
         "-v",
-        "--benchmark-skip" "--cov=pytrnsys_process",
+        "--benchmark-skip",
+        "--cov=pytrnsys_process",
         f"--cov-report=html:{test_results_dir_path / 'coverage-html'}",
         f"--cov-report=lcov:{test_results_dir_path / 'coverage.lcov'}",
         "--cov-report=term",

pylintrc

@@ -421,6 +421,7 @@ confidence=HIGH,
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
+#TODO discuss disabled checks # pylint: disable=fixme
 disable=raw-checker-failed,
         bad-inline-option,
         locally-disabled,
@@ -430,10 +431,12 @@ disable=raw-checker-failed,
         deprecated-pragma,
         use-symbolic-message-instead,
         use-implicit-booleaness-not-comparison-to-string,
-        use-implicit-booleaness-not-comparison-to-zero
-        missing-module-docstring
-        missing-class-docstring
-        missing-function-docstring
+        use-implicit-booleaness-not-comparison-to-zero,
+        missing-module-docstring,
+        missing-class-docstring,
+        missing-function-docstring,
+        too-few-public-methods,
+        arguments-differ,
 
 
 # Enable the message, report, category or checker with the given id(s). You can

pytrnsys_process/headers.py

@@ -22,7 +22,8 @@ def init_headers(self):
             try:
                 headers = HeaderReader.read(sim_file)
                 self._index_headers(headers, sim_file.parents[1], sim_file)
-            except Exception as e:
+            except Exception as e:  # pylint: disable=broad-exception-caught
+
                 print(f"Could not read {sim_file}: {e}")
 
     def init_headers_multi_thread(self):
@@ -32,7 +33,7 @@ def process_sim_file(sim_file):
             try:
                 headers = HeaderReader.read(sim_file)
                 self._index_headers(headers, sim_file.parents[1], sim_file)
-            except Exception as e:
+            except Exception as e:  # pylint: disable=broad-exception-caught
                 print(f"Could not read {sim_file}: {e}")
 
         with ThreadPoolExecutor(max_workers=10) as executor:

pytrnsys_process/plotters.py

@@ -25,6 +25,8 @@ class ChartBase:
     LEGEND_FONT_SIZE = 8
     TITLE_FONT_SIZE = 12
 
+    # TODO: discuss if we should we use a dic or a dataclass for config values
+    # pylint: disable=too-many-arguments
     def __init__(
         self, df, x_label=X_LABEL, y_label=Y_LABEL, title=TITLE, size=SIZE_A4
     ):
@@ -66,7 +68,7 @@ def plot(self, columns: list[str]) -> Tuple[_plt.Figure | None, _plt.Axes]:
         self.configure()
         return self.fig, self.ax
 
-    def plotWithoutPandas(
+    def plot_without_pandas(
         self, columns: list[str]
     ) -> Tuple[_plt.Figure | None, _plt.Axes]:
         """The matplot date formatter does not work when using df.plot func.

tests/pytrnsys_process/test_plotters.py

@@ -21,7 +21,7 @@ class TestPlotter:
 
     # TODO figure out why not passing # pylint: disable=fixme
     @pytest.mark.skip(reason="broken")
-    def testMplInstallation(self):
+    def test_mpl_installation(self):
         """Checks whether Inkscape is installed correctly."""
         assert "pdf" in _mpltc.comparable_formats()
         assert "svg" in _mpltc.comparable_formats()
@@ -46,7 +46,7 @@ def test_create_stacked_bar_chart_for_monthly(self):
         ]
 
         monthly_bar_chart = MonthlyBarChart(df)
-        fig, ax = monthly_bar_chart.plot(columns)
+        fig, _ = monthly_bar_chart.plot(columns)
         fig.savefig(actual_file, format="png")
 
         assert (
@@ -64,7 +64,7 @@ def test_create_curve_plot_for_hourly(self):
         columns = ["QSrc1TIn", "QSrc1TOut"]
 
         curve_plot = HourlyCurvePlot(df)
-        fig, ax = curve_plot.plot(columns)
+        fig, _ = curve_plot.plot(columns)
         fig.savefig(actual_fig)
 
         assert (
@@ -89,7 +89,7 @@ def test_create_curve_plot_for_hourly(self):
     #         _plt.show()
 
 
-# TODO fix, does not work as expected :/
+# TODO fix, does not work as expected :/ # pylint: disable=fixme
 def compare_plots(actual_buf, expected_file, tolerance=0.001):
     with _tf.NamedTemporaryFile(suffix=".png", delete=False) as actual_file:
         actual_file.write(actual_buf.read())