Resolve some pylint reported improvement cases

Refactored reported inconsistent return statements to returning 'None'
although this is implicitly done.
Adds disable unexpected-keyword-arg to avoid false report for
unitt_invalid_res_config test.
Adds no-op pass statement to avoid pylint reported try-except-raise in
exception handling.
Replace Sphinx copyright variable with alias project_copyright.
Renames variables using keywords func, sum, iter, hash, dir, filter,
input.
Adds default value for _func argument in plugin-response decorator.
Adds guard if _func is not provided, plugin-response function shall
return 'None'.

Author: andreas-el

docs/conf.py

@@ -22,7 +22,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "ERT"
-copyright = "Equinor ASA"
+project_copyright = "Equinor ASA"
 author = "SCOUT - ScientifiC cOmpUTing team"
 
 dist_version = get_distribution("ert").version

src/ert/_c_wrappers/config/config_parser.py

@@ -99,10 +99,10 @@ def parse(
 
         assert isinstance(unrecognized, UnrecognizedEnum)
 
-        hash = StringHash()
+        hash_value = StringHash()
         if pre_defined_kw_map is not None:
             for key in pre_defined_kw_map:
-                hash[key] = pre_defined_kw_map[key]
+                hash_value[key] = pre_defined_kw_map[key]
 
         if not os.path.exists(config_file):
             raise IOError(f"File: {config_file} does not exists")
@@ -111,7 +111,7 @@ def parse(
             comment_string,
             include_kw,
             define_kw,
-            hash,
+            hash_value,
             unrecognized,
             validate,
         )

src/ert/_c_wrappers/enkf/config/enkf_config_node.py

@@ -440,6 +440,7 @@ def getModelConfig(self):
                     f"Unhandled implementation model type: {implementation_type:i}"
                 )
             )
+            return None
 
     def getKey(self):
         return self._get_key()

src/ert/_c_wrappers/fm/shell/shell.py

@@ -133,8 +133,8 @@ def deleteDirectory(path):
                         for file in files:
                             Shell.__deleteFile(os.path.join(root, file))
 
-                        for dir in dirs:
-                            Shell.__deleteDirectory(os.path.join(root, dir))
+                        for _dir in dirs:
+                            Shell.__deleteDirectory(os.path.join(root, _dir))
 
             else:
                 raise IOError(f"Entry:'{path}' is not a directory")

src/ert/_c_wrappers/job_queue/environment_varlist.py

@@ -33,13 +33,13 @@ class EnvironmentVarlist(BaseCClass):
         "void env_varlist_update_path(env_varlist, char*, char*)"
     )
 
-    def __init__(self, vars: Optional[Dict[str, str]] = None):
-        if vars is None:
-            vars = {}
+    def __init__(self, _vars: Optional[Dict[str, str]] = None):
+        if _vars is None:
+            _vars = {}
         c_ptr = self._alloc()
         super().__init__(c_ptr)
 
-        for key, value in vars.items():
+        for key, value in _vars.items():
             self.setenv(key, value)
 
     def setenv(self, key, value):

src/ert/_c_wrappers/job_queue/ext_joblist.py

@@ -57,6 +57,8 @@ def __getitem__(self, job):
         if job in self:
             return self._get_job(job).setParent(self)
 
+        return None
+
     def getAvailableJobNames(self) -> StringList:
         """@rtype: StringList"""
         return [str(x) for x in self._alloc_list().setParent(self)]

src/ert/_c_wrappers/job_queue/workflow_runner.py

@@ -32,7 +32,7 @@ def __enter__(self):
         self.run()
         return self
 
-    def __exit__(self, type, value, traceback):
+    def __exit__(self, _type, value, traceback):
         self.wait()
 
     def run(self):

src/ert/gui/ertwidgets/analysismodulevariablespanel.py

@@ -158,6 +158,8 @@ def widget_from_layout(self, layout: QFormLayout, widget_name: str) -> QWidget:
             if widget.objectName() == widget_name:
                 return widget
 
+        return None
+
     def createSpinBox(
         self,
         variable_name,

src/ert/gui/ertwidgets/checklist.py

@@ -120,16 +120,16 @@ def setSelectionEnabled(self, enabled):
         self._checkAllButton.setEnabled(enabled)
         self._uncheckAllButton.setEnabled(enabled)
 
-    def filterList(self, filter):
-        filter = filter.lower()
+    def filterList(self, _filter):
+        _filter = _filter.lower()
 
         for index in range(0, self._list.count()):
             item = self._list.item(index)
             text = str(item.text()).lower()
 
-            if filter == "":
+            if _filter == "":
                 item.setHidden(False)
-            elif filter in text:
+            elif _filter in text:
                 item.setHidden(False)
             else:
                 item.setHidden(True)

src/ert/gui/ertwidgets/models/all_cases_model.py

@@ -32,6 +32,8 @@ def data(self, index, role=None):
             if role == Qt.DisplayRole:
                 return item
 
+        return None
+
     def itemAt(self, index):
         assert isinstance(index, QModelIndex)
 

src/ert/gui/ertwidgets/searchbox.py

@@ -17,7 +17,7 @@ def __init__(self):
         self.presentSearch()
         self.textChanged.connect(self.__emitFilterChanged)
 
-    def __emitFilterChanged(self, filter):
+    def __emitFilterChanged(self, _filter):
         self.filterChanged.emit(self.filter())
         # self.emit(SIGNAL('filterChanged(PyQt_PyObject)'), self.filter())
 

src/ert/gui/simulation/view/realization.py

@@ -17,10 +17,10 @@
 
 
 class RealizationWidget(QWidget):
-    def __init__(self, iter: int, parent=None) -> None:
+    def __init__(self, _it: int, parent=None) -> None:
         super().__init__(parent)
 
-        self._iter = iter
+        self._iter = _it
         self._delegateWidth = 70
         self._delegateHeight = 70
 

src/ert/gui/tools/plot/customize/limits_customization_view.py

@@ -91,31 +91,31 @@ def createIntegerLineEdit(self, minimum=None, maximum=None, placeholder=""):
         return line_edit
 
     def setValue(self, axis_name, value):
-        input = self._inputs[axis_name]
+        _input = self._inputs[axis_name]
 
         if axis_name in LimitsStack.NUMBER_AXIS:
             if value is None:
-                input.setText("")
+                _input.setText("")
             else:
-                input.setText(str(value))
+                _input.setText(str(value))
         elif axis_name == PlotContext.DATE_AXIS:
-            input.setDate(value)
+            _input.setDate(value)
 
     def getValue(self, axis_name):
-        input = self._inputs[axis_name]
+        _input = self._inputs[axis_name]
         result = None
         if axis_name in LimitsStack.FLOAT_AXIS:
             try:
-                result = float(input.text())
+                result = float(_input.text())
             except ValueError:
                 result = None
         elif axis_name in LimitsStack.INT_AXIS:
             try:
-                result = int(input.text())
+                result = int(_input.text())
             except ValueError:
                 result = None
         elif axis_name == PlotContext.DATE_AXIS:
-            result = input.date()
+            result = _input.date()
 
         return result
 

src/ert/gui/tools/plot/data_type_keys_list_model.py

@@ -40,6 +40,8 @@ def data(self, index, role=None):
                 if item["observations"]:
                     return self.HAS_OBSERVATIONS
 
+        return None
+
     def itemAt(self, index):
         assert isinstance(index, QModelIndex)
 

src/ert/gui/tools/plot/data_type_keys_widget.py

@@ -70,8 +70,8 @@ def getSelectedItem(self):
     def selectDefault(self):
         self.data_type_keys_widget.setCurrentIndex(self.filter_model.index(0, 0))
 
-    def setSearchString(self, filter):
-        self.filter_model.setFilterFixedString(filter)
+    def setSearchString(self, _filter):
+        self.filter_model.setFilterFixedString(_filter)
 
     def showFilterPopup(self):
         self.__filter_popup.show()

src/ert/gui/tools/plot/filter_popup.py

@@ -45,14 +45,14 @@ def __init__(self, parent, key_defs):
         self.setLayout(layout)
         self.adjustSize()
 
-    def addFilterItem(self, name, id, value=True):
-        self.filter_items[id] = value
+    def addFilterItem(self, name, _id, value=True):
+        self.filter_items[_id] = value
 
         check_box = QCheckBox(name)
         check_box.setChecked(value)
 
         def toggleItem(checked):
-            self.filter_items[id] = checked
+            self.filter_items[_id] = checked
             self.filterSettingsChanged.emit(self.filter_items)
 
         check_box.toggled.connect(toggleItem)

src/ert/gui/tools/plot/plot_case_model.py

@@ -30,6 +30,8 @@ def data(self, index, role=None):
             if role == Qt.DisplayRole:
                 return item
 
+        return None
+
     def itemAt(self, index):
         assert isinstance(index, QModelIndex)
 

src/ert/shared/ensemble_evaluator/client.py

@@ -72,7 +72,7 @@ async def _send(self, msg: AnyStr) -> None:
                 await self.websocket.send(msg)
                 return
             except ConnectionClosedOK:
-                # Connection was closed no point in trying to send more messages
+                pass  # Connection was closed no point in trying to send more messages
                 raise
             except (
                 ConnectionClosedError,

src/ert/shared/plugins/plugin_response.py

@@ -2,10 +2,14 @@
 
 
 @decorator
-def plugin_response(func, plugin_name="", *args, **kwargs):
-    response = func(*args, **kwargs)
+def plugin_response(_func=None, plugin_name="", *args, **kwargs):
+
+    if _func is None:
+        return None
+
+    response = _func(*args, **kwargs)
     return (
-        PluginResponse(response, PluginMetadata(plugin_name, func.__name__))
+        PluginResponse(response, PluginMetadata(plugin_name, _func.__name__))
         if response is not None
         else None
     )

test-data/mini_ert/jobs/aggregator.py

@@ -10,9 +10,9 @@
     with open("aggregated.txt", "w", encoding="utf-8") as output_file:
         sum_of_sum = 0.0
         for key, filename in files.items():
-            sum = 0.0
+            total = 0.0
             with open(filename, "r", encoding="utf-8") as input_file:
-                sum += float(input_file.readline())
+                total += float(input_file.readline())
             sum_of_sum += sum
             output_file.write(f"{key} {sum:f}\n")
 

tests/ert_tests/ensemble_evaluator/ensemble_evaluator_utils.py

@@ -46,8 +46,8 @@ def send_dispatch_event(client, event_type, source, event_id, data, **extra_attr
 class TestEnsemble(_Ensemble):
     __test__ = False
 
-    def __init__(self, iter, reals, steps, jobs, id_):
-        self.iter = iter
+    def __init__(self, _iter, reals, steps, jobs, id_):
+        self.iter = _iter
         self.test_reals = reals
         self.steps = steps
         self.jobs = jobs

tests/ert_tests/ensemble_evaluator/prefect/scripts/evaluate_coeffs.py

@@ -16,6 +16,8 @@ def _evaluate(coeffs, x, degree):
     if degree >= 2:
         return coeffs["a"] * x**degree
 
+    return None
+
 
 def config_dump_entry(args=None):
     arg_parser = argparse.ArgumentParser(

tests/ert_tests/ensemble_evaluator/test_ensemble_evaluator.py

@@ -237,7 +237,7 @@ def exploding_handler(events):
 @pytest.mark.consumer_driven_contract_verification
 def test_verify_monitor_failing_ensemble(make_ee_config, event_loop):
     ee_config = make_ee_config(use_token=False, generate_cert=False)
-    ensemble = TestEnsemble(iter=1, reals=2, steps=1, jobs=2, id_="ee-0")
+    ensemble = TestEnsemble(_iter=1, reals=2, steps=1, jobs=2, id_="ee-0")
     ensemble.addFailJob(real=1, step=0, job=1)
     ee = EnsembleEvaluator(
         ensemble,
@@ -253,7 +253,7 @@ def test_verify_monitor_failing_ensemble(make_ee_config, event_loop):
 @pytest.mark.consumer_driven_contract_verification
 def test_verify_monitor_failing_evaluation(make_ee_config, event_loop):
     ee_config = make_ee_config(use_token=False, generate_cert=False)
-    ensemble = TestEnsemble(iter=1, reals=2, steps=1, jobs=2, id_="ee-0")
+    ensemble = TestEnsemble(_iter=1, reals=2, steps=1, jobs=2, id_="ee-0")
     ensemble.with_failure()
     ee = EnsembleEvaluator(
         ensemble,
@@ -268,7 +268,7 @@ def test_verify_monitor_failing_evaluation(make_ee_config, event_loop):
 
 @pytest.mark.consumer_driven_contract_verification
 def test_verify_monitor_successful_ensemble(make_ee_config, event_loop):
-    ensemble = TestEnsemble(iter=1, reals=2, steps=2, jobs=2, id_="ee-0").with_result(
+    ensemble = TestEnsemble(_iter=1, reals=2, steps=2, jobs=2, id_="ee-0").with_result(
         b"\x80\x04\x95\x0f\x00\x00\x00\x00\x00\x00\x00\x8c\x0bhello world\x94.",
         "application/octet-stream",
     )
@@ -309,7 +309,7 @@ def test_ens_eval_run_and_get_successful_realizations_connection_refused_no_reco
 
     ee_config = make_ee_config(use_token=False, generate_cert=False)
     ensemble = AutorunTestEnsemble(
-        iter=1, reals=num_realizations, steps=1, jobs=2, id_="0"
+        _iter=1, reals=num_realizations, steps=1, jobs=2, id_="0"
     )
     for i in range(num_failing):
         ensemble.addFailJob(real=i, step=0, job=1)
@@ -325,7 +325,7 @@ def test_ens_eval_run_and_get_successful_realizations_connection_refused_no_reco
 
 def test_ens_eval_run_and_get_successful_realizations_timeout(make_ee_config):
     ee_config = make_ee_config(use_token=False, generate_cert=False)
-    ensemble = AutorunTestEnsemble(iter=1, reals=1, steps=1, jobs=2, id_="0")
+    ensemble = AutorunTestEnsemble(_iter=1, reals=1, steps=1, jobs=2, id_="0")
     ee = EnsembleEvaluator(ensemble, ee_config, 0)
 
     with patch.object(
@@ -361,7 +361,7 @@ def test_recover_from_failure_in_run_and_get_successful_realizations(
         use_token=False, generate_cert=False, custom_host="localhost"
     )
     ensemble = AutorunTestEnsemble(
-        iter=1, reals=num_realizations, steps=1, jobs=2, id_="0"
+        _iter=1, reals=num_realizations, steps=1, jobs=2, id_="0"
     )
 
     for i in range(num_failing):
@@ -390,7 +390,7 @@ def test_exhaust_retries_in_run_and_get_successful_realizations(
         use_token=False, generate_cert=False, custom_host="localhost"
     )
     ensemble = AutorunTestEnsemble(
-        iter=1, reals=num_realizations, steps=1, jobs=2, id_="0"
+        _iter=1, reals=num_realizations, steps=1, jobs=2, id_="0"
     )
 
     for i in range(num_failing):

tests/ert_tests/ensemble_evaluator/test_monitor.py

@@ -15,7 +15,7 @@
 
 @pytest.mark.consumer_driven_contract_test
 def test_monitor_successful_ensemble(make_ee_config):
-    ensemble = TestEnsemble(iter=1, reals=2, steps=2, jobs=2, id_="0")
+    ensemble = TestEnsemble(_iter=1, reals=2, steps=2, jobs=2, id_="0")
     ensemble.addFailJob(real=1, step=0, job=1)
     ee_config = make_ee_config(use_token=False, generate_cert=False)
     ee = EnsembleEvaluator(
@@ -42,7 +42,7 @@ def test_monitor_successful_ensemble(make_ee_config):
 @pytest.mark.consumer_driven_contract_test
 def test_monitor_failing_evaluation(make_ee_config):
     ee_config = make_ee_config(use_token=False, generate_cert=False)
-    ensemble = TestEnsemble(iter=1, reals=1, steps=1, jobs=1, id_="0")
+    ensemble = TestEnsemble(_iter=1, reals=1, steps=1, jobs=1, id_="0")
     ensemble.with_failure()
     ee = EnsembleEvaluator(
         ensemble,
@@ -68,7 +68,7 @@ def test_monitor_failing_evaluation(make_ee_config):
 
 @pytest.mark.consumer_driven_contract_test
 def test_monitor_failing_ensemble(make_ee_config):
-    ensemble = TestEnsemble(iter=1, reals=2, steps=2, jobs=2, id_="0")
+    ensemble = TestEnsemble(_iter=1, reals=2, steps=2, jobs=2, id_="0")
     ensemble.addFailJob(real=1, step=0, job=1)
     ee_config = make_ee_config(use_token=False, generate_cert=False)
     ee = EnsembleEvaluator(