Merge pull request #1061 from PowerGridModel/feature/more-ruff-checks

Laurynas-Jagutis · web-flow · commit d4b8e9296676 · 2025-08-04T14:25:41.000Z
Linting and Formatting: more ruff checks
diff --git a/code_generation/code_gen.py b/code_generation/code_gen.py
@@ -18,12 +18,11 @@
 def _data_type_nan(data_type: str):
     if data_type == "ID":
         return "na_IntID"
-    elif data_type == "double" or "RealValue" in data_type:
+    if data_type == "double" or "RealValue" in data_type:
         return "nan"
-    elif data_type == "IntS":
+    if data_type == "IntS":
         return "na_IntS"
-    else:
-        return f"static_cast<{data_type}>(na_IntS)"
+    return f"static_cast<{data_type}>(na_IntS)"
 
 
 class CodeGenerator:
@@ -45,7 +44,7 @@ def render_template(self, template_path: Path, output_path: Path, **data):
             output_file.write(output)
 
     def render_attribute_classes(self, template_path: Path, data_path: Path, output_path: Path):
-        with open(data_path) as data_file:
+        with data_path.open() as data_file:
             json_data = data_file.read()
         dataset_meta_data: DatasetMetaData = DatasetMetaData.schema().loads(json_data)
         # flatten attribute list
@@ -95,7 +94,7 @@ def render_attribute_classes(self, template_path: Path, data_path: Path, output_
         )
 
     def render_dataset_class_maps(self, template_path: Path, data_path: Path, output_path: Path):
-        with open(data_path) as data_file:
+        with data_path.open() as data_file:
             json_data = data_file.read()
         dataset_meta_data: list[DatasetMapData] = AllDatasetMapData.schema().loads(json_data).all_datasets
 
diff --git a/docs/examples/Generic Branch Example.ipynb b/docs/examples/Generic Branch Example.ipynb
@@ -39,7 +39,7 @@
       "                      |                  |\n",
       "                      0  Br9,T2          0   Br10, T3\n",
       "                      0                  0\n",
-      "                      |                  |  \n",
+      "                      |                  |\n",
       "                    ----               -----> 7, Load\n",
       "                      |\n",
       "                      |\n",
@@ -48,7 +48,7 @@
       "                      |\n",
       "                    ----- 11, Station1\n",
       "                      |\n",
-      "                      ----> 6, Load                     \n",
+      "                      ----> 6, Load\n",
       "\n",
       "\n",
       "========================================\n",
@@ -162,7 +162,7 @@
     "                      |                  |\n",
     "                      0  Br9,T2          0   Br10, T3\n",
     "                      0                  0\n",
-    "                      |                  |  \n",
+    "                      |                  |\n",
     "                    ----               -----> 7, Load\n",
     "                      |\n",
     "                      |\n",
@@ -171,7 +171,7 @@
     "                      |\n",
     "                    ----- 11, Station1\n",
     "                      |\n",
-    "                      ----> 6, Load                     \n",
+    "                      ----> 6, Load\n",
     "\n",
     "\"\"\"\n",
     "# Voltage levels of the transformer\n",
diff --git a/docs/examples/Make Test Dataset.ipynb b/docs/examples/Make Test Dataset.ipynb
@@ -278,8 +278,7 @@
    ],
    "source": [
     "# we can display the json file\n",
-    "\n",
-    "with open(temp_path / \"input.json\", \"r\") as f:\n",
+    "with (temp_path / \"input.json\").open(\"r\") as f:\n",
     "    print(f.read())"
    ]
   },
@@ -395,7 +394,7 @@
     "\n",
     "json_serialize_to_file(temp_path / \"update_batch.json\", time_series_mutation)\n",
     "\n",
-    "with open(temp_path / \"update_batch.json\", \"r\") as f:\n",
+    "with (temp_path / \"update_batch.json\").open(\"r\") as f:\n",
     "    print(f.read())"
    ]
   },
@@ -531,7 +530,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.5"
+   "version": "3.13.3"
   }
  },
  "nbformat": 4,
diff --git a/docs/examples/Serialization Example.ipynb b/docs/examples/Serialization Example.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -91,6 +91,8 @@ show-fixes = true
 # Assume Python 3.11
 target-version = "py311"
 
+extend-exclude = ["setup.py"]
+
 [tool.ruff.lint]
 select = [
     # pycodestyle
@@ -115,6 +117,13 @@ select = [
     "SLOT",
     "PL",
     "NPY",
+    "W",
+    "PTH",
+    "TID",
+    "ARG",
+    "RET",
+    "PIE",
+    "SLF"
 ]
 
 [tool.ruff.lint.isort]
@@ -126,6 +135,9 @@ combine-as-imports = true
 "docs/examples/*.ipynb" = ["F811", "E402"]
 # Pylint was only run in src directory before moving to Ruff
 "tests/*" = ["PLR0915", "PLR0912", "PLR0913"]
+# Ignore private member access: _model_ptr, _all_component_count...
+"src/power_grid_model/_core/*.py" = ["SLF001"]
+"tests/unit/test_error_handling.py" = ["SLF001"]
 "setup.py" = ["PL"]
 
 [tool.mypy]
diff --git a/src/power_grid_model/_core/power_grid_model.py b/src/power_grid_model/_core/power_grid_model.py
@@ -244,7 +244,7 @@ def _calculate_impl(  # noqa: PLR0913
         options: Options,
         continue_on_batch_error: bool,
         decode_error: bool,
-        experimental_features: _ExperimentalFeatures | str,  # NOSONAR
+        experimental_features: _ExperimentalFeatures | str,  # NOSONAR # noqa: ARG002
     ):
         """
         Core calculation routine
diff --git a/src/power_grid_model/data_types.py b/src/power_grid_model/data_types.py
@@ -179,7 +179,7 @@
 
 DenseBatchArray = _DenseBatchArray
 """
-A dense batch array is a two-dimensional structured numpy array containing a list of components of 
+A dense batch array is a two-dimensional structured numpy array containing a list of components of
 the same type for each scenario. Otherwise similar to :class:`SingleArray`.
 """
 
diff --git a/src/power_grid_model/utils.py b/src/power_grid_model/utils.py
@@ -141,7 +141,7 @@ def json_deserialize_from_file(
     Returns:
         The deserialized dataset in Power grid model input format.
     """
-    with open(file_path, encoding="utf-8") as file_pointer:
+    with file_path.open(encoding="utf-8") as file_pointer:
         return json_deserialize(file_pointer.read(), data_filter=data_filter)
 
 
@@ -169,7 +169,7 @@ def json_serialize_to_file(
         data=data, dataset_type=dataset_type, use_compact_list=use_compact_list, indent=-1 if indent is None else indent
     )
 
-    with open(file_path, mode="w", encoding="utf-8") as file_pointer:
+    with file_path.open(mode="w", encoding="utf-8") as file_pointer:
         file_pointer.write(result)
 
 
@@ -190,7 +190,7 @@ def msgpack_deserialize_from_file(
     Returns:
         The deserialized dataset in Power grid model input format.
     """
-    with open(file_path, mode="rb") as file_pointer:
+    with file_path.open(mode="rb") as file_pointer:
         return msgpack_deserialize(file_pointer.read(), data_filter=data_filter)
 
 
@@ -212,7 +212,7 @@ def msgpack_serialize_to_file(
     data = _map_to_component_types(data)
     result = msgpack_serialize(data=data, dataset_type=dataset_type, use_compact_list=use_compact_list)
 
-    with open(file_path, mode="wb") as file_pointer:
+    with file_path.open(mode="wb") as file_pointer:
         file_pointer.write(result)
 
 
@@ -278,7 +278,7 @@ def _compatibility_deprecated_export_json_data(
 ):
     serialized_data = json_serialize(data=data, use_compact_list=compact, indent=-1 if indent is None else indent)
     old_format_serialized_data = json.dumps(json.loads(serialized_data)["data"])
-    with open(json_file, mode="w", encoding="utf-8") as file_pointer:
+    with json_file.open(mode="w", encoding="utf-8") as file_pointer:
         file_pointer.write(old_format_serialized_data)
 
 
@@ -327,7 +327,7 @@ def import_update_data(json_file: Path) -> BatchDataset:
 
 
 def _compatibility_deprecated_import_json_data(json_file: Path, data_type: DatasetType):
-    with open(json_file, mode="r", encoding="utf-8") as file_pointer:
+    with Path(json_file).open(mode="r", encoding="utf-8") as file_pointer:
         data = json.load(file_pointer)
 
     if "version" not in data:  # convert old format to version 1.0
@@ -395,7 +395,7 @@ def self_test():
             json_serialize_to_file(output_file_path, output_data)
 
             # Verify that the written output is correct
-            with open(output_file_path, "r", encoding="utf-8") as output_file:
+            with Path(output_file_path).open("r", encoding="utf-8") as output_file:
                 output_data = json.load(output_file)
 
             assert output_data is not None
diff --git a/src/power_grid_model/validation/_validation.py b/src/power_grid_model/validation/_validation.py
@@ -882,8 +882,7 @@ def validate_generic_load_gen(data: SingleDataset, component: ComponentType) ->
 
 
 def validate_shunt(data: SingleDataset) -> list[ValidationError]:
-    errors = validate_appliance(data, ComponentType.shunt)
-    return errors
+    return validate_appliance(data, ComponentType.shunt)
 
 
 def validate_generic_voltage_sensor(data: SingleDataset, component: ComponentType) -> list[ValidationError]:
diff --git a/tests/unit/deprecated/test_end_to_end.py b/tests/unit/deprecated/test_end_to_end.py
@@ -9,8 +9,7 @@
 from power_grid_model._core.power_grid_model import PowerGridModel
 from power_grid_model._core.utils import convert_batch_dataset_to_batch_list
 from power_grid_model.utils import import_json_data
-
-from ..utils import compare_result
+from tests.unit.utils import compare_result
 
 
 @pytest.fixture()
diff --git a/tests/unit/deprecated/test_utils.py b/tests/unit/deprecated/test_utils.py
@@ -11,7 +11,7 @@
 from power_grid_model.utils import export_json_data
 
 
-@patch("builtins.open", new_callable=mock_open)
+@patch("pathlib.Path.open", new_callable=mock_open)
 @patch("power_grid_model.utils.json_serialize")
 def test_export_json_data_format_version_1_0(convert_mock: MagicMock, open_mock: MagicMock):
     convert_mock.return_value = '{"version": "1.0", "data": {"foo": [{"val": 123}]}, "bar": {"baz": 456}}'
@@ -25,7 +25,7 @@ def test_export_json_data_format_version_1_0(convert_mock: MagicMock, open_mock:
     handle.write.assert_called_once_with(convert_mock.return_value)
 
 
-@patch("builtins.open", new_callable=mock_open)
+@patch("pathlib.Path.open", new_callable=mock_open)
 @patch("power_grid_model.utils.json_serialize")
 def test_export_json_data__deprecated_format(convert_mock: MagicMock, open_mock: MagicMock):
     convert_mock.return_value = '{"version": "1.0", "data": {"foo": [{"val": 123}]}, "bar": {"baz": 456}}'
diff --git a/tests/unit/test_0Z_model_validation.py b/tests/unit/test_0Z_model_validation.py
@@ -154,10 +154,10 @@ def test_single_validation(
             assert np.all(input_array["id"][indexer_array] == ids_array)
 
         # test calculate with only node and source result
-        kwargs = dict(base_kwargs, **{"output_component_types": [ComponentType.node, ComponentType.source]})
+        kwargs = dict(base_kwargs, output_component_types=[ComponentType.node, ComponentType.source])
         result = calculation_function(model, **supported_kwargs(kwargs=kwargs, supported=calculation_args))
         assert set(result.keys()) == {ComponentType.node, ComponentType.source}
-        kwargs = dict(base_kwargs, **{"output_component_types": {ComponentType.node, ComponentType.source}})
+        kwargs = dict(base_kwargs, output_component_types={ComponentType.node, ComponentType.source})
         result = calculation_function(model, **supported_kwargs(kwargs=kwargs, supported=calculation_args))
         assert set(result.keys()) == {ComponentType.node, ComponentType.source}
 
diff --git a/tests/unit/test_power_grid_model.py b/tests/unit/test_power_grid_model.py
@@ -204,7 +204,7 @@ def test_single_calculation_error(model: PowerGridModel):
             model.calculate_short_circuit(calculation_method=calculation_method)
 
 
-def test_batch_calculation_error(model: PowerGridModel, update_batch, input):
+def test_batch_calculation_error(model: PowerGridModel, update_batch):
     # wrong id
     update_batch[ComponentType.sym_load]["data"]["id"][1] = 5
     # with error
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
@@ -129,7 +129,7 @@ def test_get_component_batch_size():
     assert get_component_batch_size(sym_load) == sym_load_batch_size
 
 
-@patch("builtins.open", new_callable=mock_open)
+@patch("pathlib.Path.open", new_callable=mock_open)
 @patch("power_grid_model.utils.json_deserialize")
 def test_json_deserialize_from_file(deserialize_mock: MagicMock, open_mock: MagicMock):
     handle = open_mock()
@@ -140,7 +140,7 @@ def test_json_deserialize_from_file(deserialize_mock: MagicMock, open_mock: Magi
     deserialize_mock.assert_called_once_with(handle.read.return_value, data_filter=None)
 
 
-@patch("builtins.open", new_callable=mock_open)
+@patch("pathlib.Path.open", new_callable=mock_open)
 @patch("power_grid_model.utils.json_serialize")
 def test_json_serialize(serialize_mock: MagicMock, open_mock: MagicMock):
     serialize_mock.return_value = '{"version": "1.0", "data": {"foo": [{"val": 123}]}, "bar": {"baz": 456}}'
@@ -151,7 +151,7 @@ def test_json_serialize(serialize_mock: MagicMock, open_mock: MagicMock):
     handle.write.assert_called_once_with(serialize_mock.return_value)
 
 
-@patch("builtins.open", new_callable=mock_open)
+@patch("pathlib.Path.open", new_callable=mock_open)
 @patch("power_grid_model.utils.msgpack_deserialize")
 def test_msgpack_deserialize_from_file(deserialize_mock: MagicMock, open_mock: MagicMock):
     handle = open_mock()
@@ -162,7 +162,7 @@ def test_msgpack_deserialize_from_file(deserialize_mock: MagicMock, open_mock: M
     deserialize_mock.assert_called_once_with(handle.read.return_value, data_filter=None)
 
 
-@patch("builtins.open", new_callable=mock_open)
+@patch("pathlib.Path.open", new_callable=mock_open)
 @patch("power_grid_model.utils.msgpack_serialize")
 def test_msgpack_serialize(serialize_mock: MagicMock, open_mock: MagicMock):
     serialize_mock.return_value = b'{"version": "1.0", "data": {"foo": [{"val": 123}]}, "bar": {"baz": 456}}'
diff --git a/tests/unit/utils.py b/tests/unit/utils.py
@@ -172,7 +172,7 @@ def add_case(
 
 
 def _add_cases(case_dir: Path, calculation_type: str, **kwargs):
-    with open(case_dir / "params.json") as f:
+    with (case_dir / "params.json").open() as f:
         params = json.load(f)
 
     # retrieve calculation method, can be a string or list of strings
diff --git a/tests/unit/validation/test_input_validation.py b/tests/unit/validation/test_input_validation.py
@@ -397,7 +397,7 @@ def original_data() -> dict[ComponentType, np.ndarray]:
         ComponentType.asym_current_sensor: asym_current_sensor,
         ComponentType.fault: fault,
     }
-    return data
+    return data  # noqa: RET504
 
 
 @pytest.fixture
