Merge branch 'main' into pgm/save-visualizer-html

jaapschoutenalliander · web-flow · commit 9bccafe02997 · 2026-05-01T07:56:41.000+02:00
diff --git a/docs/demos/connecting_new_consumer.ipynb b/docs/demos/connecting_new_consumer.ipynb
@@ -20,6 +20,7 @@
    "outputs": [],
    "source": [
     "from dataclasses import dataclass\n",
+    "from typing import ClassVar\n",
     "\n",
     "import numpy as np\n",
     "from numpy.typing import NDArray\n",
@@ -31,7 +32,7 @@
     "class ExtendedNodeArray(NodeArray):\n",
     "    \"\"\"Extends the node array with the simulated voltage and coordinates\"\"\"\n",
     "\n",
-    "    _defaults = {\"u\": 0}\n",
+    "    _defaults: ClassVar = {\"u\": 0}\n",
     "\n",
     "    u: NDArray[np.float64]\n",
     "    x_coor: NDArray[np.float64]\n",
@@ -45,7 +46,7 @@
     "class ExtendedLineArray(LineArray):\n",
     "    \"\"\"Extends the line array with current output\"\"\"\n",
     "\n",
-    "    _defaults = {\"i_from\": 0}\n",
+    "    _defaults: ClassVar = {\"i_from\": 0}\n",
     "\n",
     "    i_from: NDArray[np.float64]\n",
     "\n",
diff --git a/docs/examples/model/array_examples.ipynb b/docs/examples/model/array_examples.ipynb
@@ -21,6 +21,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from typing import ClassVar\n",
+    "\n",
     "import numpy as np\n",
     "from numpy.typing import NDArray\n",
     "\n",
@@ -196,7 +198,7 @@
    "source": [
     "class CustomStrLengthArray(FancyArray):\n",
     "    test_str: NDArray[np.str_]\n",
-    "    _str_lengths = {\"test_str\": 100}\n",
+    "    _str_lengths: ClassVar = {\"test_str\": 100}\n",
     "\n",
     "\n",
     "custom_array = CustomStrLengthArray(test_str=[\"a\" * 100])"
diff --git a/docs/examples/model/grid_extensions_examples.ipynb b/docs/examples/model/grid_extensions_examples.ipynb
@@ -21,6 +21,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from typing import ClassVar\n",
+    "\n",
     "import numpy as np\n",
     "from numpy.typing import NDArray\n",
     "\n",
@@ -30,15 +32,15 @@
     "class ExtendedNodeArray(NodeArray):\n",
     "    \"\"\"Extends the node array with an output value\"\"\"\n",
     "\n",
-    "    _defaults = {\"u\": 0}\n",
+    "    _defaults: ClassVar = {\"u\": 0}\n",
     "\n",
     "    u: NDArray[np.float64]\n",
     "\n",
     "\n",
     "class ExtendedLineArray(LineArray):\n",
     "    \"\"\"Extends the line array with an output value\"\"\"\n",
     "\n",
-    "    _defaults = {\"i_from\": 0}\n",
+    "    _defaults: ClassVar = {\"i_from\": 0}\n",
     "\n",
     "    i_from: NDArray[np.float64]"
    ]
diff --git a/docs/examples/pgm/basic_pgm_examples.ipynb b/docs/examples/pgm/basic_pgm_examples.ipynb
@@ -68,6 +68,7 @@
    "outputs": [],
    "source": [
     "from dataclasses import dataclass\n",
+    "from typing import ClassVar\n",
     "\n",
     "import numpy as np\n",
     "from numpy.typing import NDArray\n",
@@ -79,15 +80,15 @@
     "class ExtendedNodeArray(NodeArray):\n",
     "    \"\"\"Extends the node array with an output value\"\"\"\n",
     "\n",
-    "    _defaults = {\"u\": 0}\n",
+    "    _defaults: ClassVar = {\"u\": 0}\n",
     "\n",
     "    u: NDArray[np.float64]\n",
     "\n",
     "\n",
     "class ExtendedLineArray(LineArray):\n",
     "    \"\"\"Extends the line array with an output value\"\"\"\n",
     "\n",
-    "    _defaults = {\"i_from\": 0}\n",
+    "    _defaults: ClassVar = {\"i_from\": 0}\n",
     "\n",
     "    i_from: NDArray[np.float64]\n",
     "\n",
diff --git a/docs/model_interface.ipynb b/docs/model_interface.ipynb
@@ -117,6 +117,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from typing import ClassVar\n",
+    "\n",
     "import numpy as np\n",
     "from numpy.typing import NDArray\n",
     "\n",
@@ -143,7 +145,7 @@
    "outputs": [],
    "source": [
     "class MyDefaultedArray(MyArray):\n",
-    "    _defaults = {\"id\": -1, \"name\": \"default\", \"value\": 1.0}"
+    "    _defaults: ClassVar = {\"id\": -1, \"name\": \"default\", \"value\": 1.0}"
    ]
   },
   {
@@ -181,7 +183,7 @@
    "source": [
     "class MyArray(FancyArray):\n",
     "    name: NDArray[np.str_]\n",
-    "    _str_lengths = {\"name\": 100}"
+    "    _str_lengths: ClassVar = {\"name\": 100}"
    ]
   },
   {
diff --git a/docs/quick_start.ipynb b/docs/quick_start.ipynb
@@ -25,6 +25,7 @@
    "outputs": [],
    "source": [
     "from dataclasses import dataclass\n",
+    "from typing import ClassVar\n",
     "\n",
     "import numpy as np\n",
     "from numpy.typing import NDArray\n",
@@ -36,15 +37,15 @@
     "class ExtendedNodeArray(NodeArray):\n",
     "    \"\"\"Extends the node array with an output value\"\"\"\n",
     "\n",
-    "    _defaults = {\"u\": 0}\n",
+    "    _defaults: ClassVar = {\"u\": 0}\n",
     "\n",
     "    u: NDArray[np.float64]\n",
     "\n",
     "\n",
     "class ExtendedLineArray(LineArray):\n",
     "    \"\"\"Extends the line array with an output value\"\"\"\n",
     "\n",
-    "    _defaults = {\"i_from\": 0}\n",
+    "    _defaults: ClassVar = {\"i_from\": 0}\n",
     "\n",
     "    i_from: NDArray[np.float64]\n",
     "\n",
diff --git a/pyproject.toml b/pyproject.toml
@@ -110,11 +110,11 @@ select = [
   "E",
   # Pyflakes
   "F",
-  # # pyupgrade
+  # pyupgrade
   "UP",
-  # # flake8-bugbear
+  # flake8-bugbear
   "B",
-  # # flake8-simplify
+  # flake8-simplify
   "SIM",
   # isort
   "I",
@@ -152,7 +152,7 @@ select = [
   # raise
   "RSE",
   # ruff sepcific rules
-  #"RUF",
+  "RUF",
   # bandit
   "S",
   # boolean positional value in call
diff --git a/src/power_grid_model_ds/__init__.py b/src/power_grid_model_ds/__init__.py
@@ -7,8 +7,8 @@
 from power_grid_model_ds._core.power_grid_model_interface import PowerGridModelInterface
 
 __all__ = [
-    "Grid",
+    "FancyArray",
     "GraphContainer",
+    "Grid",
     "PowerGridModelInterface",
-    "FancyArray",
 ]
diff --git a/src/power_grid_model_ds/_core/fancypy.py b/src/power_grid_model_ds/_core/fancypy.py
@@ -18,7 +18,7 @@ def concatenate[T: FancyArray](fancy_array: T, *other_arrays: T | np.ndarray) ->
     """Concatenate arrays."""
     np_arrays = [array if isinstance(array, np.ndarray) else array.data for array in other_arrays]
     try:
-        concatenated = np.concatenate([fancy_array.data] + np_arrays)
+        concatenated = np.concatenate([fancy_array.data, *np_arrays])
     except TypeError as error:
         raise TypeError("Cannot append arrays: mismatching dtypes.") from error
     return fancy_array.__class__(data=concatenated)
diff --git a/src/power_grid_model_ds/_core/model/arrays/base/array.py b/src/power_grid_model_ds/_core/model/arrays/base/array.py
@@ -7,7 +7,7 @@
 from collections.abc import Iterable
 from copy import copy
 from functools import lru_cache
-from typing import Any, Literal, TypeVar, overload
+from typing import Any, ClassVar, Literal, TypeVar, overload
 
 import numpy as np
 from numpy.typing import ArrayLike, NDArray
@@ -58,8 +58,8 @@ class FancyArray(ABC):  # noqa: B024
     """
 
     _data: NDArray = np.ndarray([])
-    _defaults: dict[str, Any] = {}
-    _str_lengths: dict[str, int] = {}
+    _defaults: ClassVar[dict[str, Any]] = {}
+    _str_lengths: ClassVar[dict[str, int]] = {}
 
     def __init__(self, *args, data: NDArray | None = None, **kwargs):
         if data is None:
diff --git a/src/power_grid_model_ds/_core/model/containers/helpers.py b/src/power_grid_model_ds/_core/model/containers/helpers.py
@@ -19,7 +19,7 @@ def container_equal(
     container_b: "FancyArrayContainer",
     ignore_extras: bool = False,
     early_exit: bool = True,
-    fields_to_ignore: list[str] = None,
+    fields_to_ignore: list[str] | None = None,
 ) -> bool:
     """
     Compares two containers for equality.
diff --git a/src/power_grid_model_ds/_core/model/dtypes/branches.py b/src/power_grid_model_ds/_core/model/dtypes/branches.py
@@ -4,6 +4,8 @@
 
 """Branch data types"""
 
+from typing import ClassVar
+
 import numpy as np
 from numpy.typing import NDArray
 
@@ -22,7 +24,7 @@ class Branch(Id):
     feeder_node_id: NDArray[np.int32]  # node id of the feeding node
     is_feeder: NDArray[np.bool_]  # whether or not this branch is from the substation
 
-    _defaults = {
+    _defaults: ClassVar = {
         "feeder_branch_id": empty,
         "feeder_node_id": empty,
         "is_feeder": False,
diff --git a/src/power_grid_model_ds/_core/model/dtypes/id.py b/src/power_grid_model_ds/_core/model/dtypes/id.py
@@ -4,7 +4,7 @@
 
 """Base data types"""
 
-from typing import Any
+from typing import Any, ClassVar
 
 import numpy as np
 from numpy.typing import NDArray
@@ -15,5 +15,5 @@
 class Id:
     """Base dtype for id arrays"""
 
-    _defaults: dict[str, Any] = {"id": empty}
+    _defaults: ClassVar[dict[str, Any]] = {"id": empty}
     id: NDArray[np.int32]
diff --git a/src/power_grid_model_ds/_core/model/dtypes/nodes.py b/src/power_grid_model_ds/_core/model/dtypes/nodes.py
@@ -4,6 +4,8 @@
 
 """Node data types"""
 
+from typing import ClassVar
+
 import numpy as np
 from numpy.typing import NDArray
 
@@ -20,7 +22,7 @@ class Node(Id):
     feeder_branch_id: NDArray[np.int32]  # branch id of the feeder
     feeder_node_id: NDArray[np.int32]  # node id of the first substation node
 
-    _defaults = {
+    _defaults: ClassVar = {
         "node_type": NodeType.UNSPECIFIED.value,
         "feeder_branch_id": empty,
         "feeder_node_id": empty,
diff --git a/src/power_grid_model_ds/_core/model/dtypes/regulators.py b/src/power_grid_model_ds/_core/model/dtypes/regulators.py
@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
+from typing import ClassVar
+
 import numpy as np
 from numpy.typing import NDArray
 
@@ -24,7 +26,7 @@ class TransformerTapRegulator(Regulator):
     line_drop_compensation_r: NDArray[np.float64]  # compensation for voltage drop due to resistance during transport
     line_drop_compensation_x: NDArray[np.float64]  # compensation for voltage drop due to reactance during transport
 
-    _defaults = {
+    _defaults: ClassVar = {
         "line_drop_compensation_r": 0,
         "line_drop_compensation_x": 0,
     }
diff --git a/src/power_grid_model_ds/_core/model/grids/serialization/pickle.py b/src/power_grid_model_ds/_core/model/grids/serialization/pickle.py
@@ -28,7 +28,7 @@ def load_grid_from_pickle(grid_class: type["Grid"], cache_path: Path, load_graph
 def save_grid_to_pickle(grid: "Grid", cache_dir: Path, cache_name: str, compress: bool = True):
     """See Grid.cache()"""
     tmp_graphs = copy(grid.graphs)
-    grid.graphs = None  # noqa
+    grid.graphs = None
     cache_dir.mkdir(parents=True, exist_ok=True)
 
     pickle_path = cache_dir / f"{cache_name}.pickle"
diff --git a/src/power_grid_model_ds/errors.py b/src/power_grid_model_ds/errors.py
@@ -16,12 +16,12 @@
 from power_grid_model_ds._core.power_grid_model_interface import PGMCoreException
 
 __all__ = [
-    "PGMCoreException",
-    "GraphError",
     "ArrayDefinitionError",
-    "RecordDoesNotExist",
-    "MultipleRecordsReturned",
-    "MissingNodeError",
+    "GraphError",
     "MissingBranchError",
+    "MissingNodeError",
+    "MultipleRecordsReturned",
     "NoPathBetweenNodes",
+    "PGMCoreException",
+    "RecordDoesNotExist",
 ]
diff --git a/src/power_grid_model_ds/experimental.py b/src/power_grid_model_ds/experimental.py
@@ -6,4 +6,4 @@
 from power_grid_model_ds._core.model.grids._search import find_differences_between_grids
 from power_grid_model_ds._core.utils.misc import find_diff_masks_with_equal_nan
 
-__all__ = ["find_differences_between_grids", "find_diff_masks_with_equal_nan"]
+__all__ = ["find_diff_masks_with_equal_nan", "find_differences_between_grids"]
diff --git a/src/power_grid_model_ds/fancypy.py b/src/power_grid_model_ds/fancypy.py
@@ -6,4 +6,4 @@
 from power_grid_model_ds._core.model.arrays.base.array import FancyArray
 from power_grid_model_ds._core.model.containers.base import FancyArrayContainer
 
-__all__ = ["FancyArray", "FancyArrayContainer", "concatenate", "unique", "sort", "array_equal"]
+__all__ = ["FancyArray", "FancyArrayContainer", "array_equal", "concatenate", "sort", "unique"]
diff --git a/src/power_grid_model_ds/generators.py b/src/power_grid_model_ds/generators.py
@@ -8,4 +8,4 @@
 from power_grid_model_ds._core.data_source.generator.arrays.transformer import TransformerGenerator
 from power_grid_model_ds._core.data_source.generator.grid_generators import RadialGridGenerator
 
-__all__ = ["RadialGridGenerator", "NodeGenerator", "LineGenerator", "TransformerGenerator", "SourceGenerator"]
+__all__ = ["LineGenerator", "NodeGenerator", "RadialGridGenerator", "SourceGenerator", "TransformerGenerator"]
diff --git a/tests/fixtures/arrays.py b/tests/fixtures/arrays.py
@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
+from typing import ClassVar
+
 import numpy as np
 from numpy._typing import NDArray
 
@@ -23,7 +25,7 @@ class FancyTestArray(FancyArray):
 class DefaultedFancyTestArray(FancyTestArray):
     """Test array with some defaulted attributes"""
 
-    _defaults = {"id": -1, "test_int": 4, "test_float": 4.5, "test_str": "DEFAULT", "test_bool": True}
+    _defaults: ClassVar = {"id": -1, "test_int": 4, "test_float": 4.5, "test_str": "DEFAULT", "test_bool": True}
 
 
 class DifferentFancyTestArray(FancyArray):
@@ -73,14 +75,14 @@ class CustomLineArray(LineArray):
 class DefaultedCustomNodeArray(NodeArray):
     """Extends the node array with an output value"""
 
-    _defaults = {"u": 0}
+    _defaults: ClassVar = {"u": 0}
 
     u: NDArray[np.float64]
 
 
 class DefaultedCustomLineArray(LineArray):
     """Extends the line array with a defaulted output value"""
 
-    _defaults = {"i_from": 0}
+    _defaults: ClassVar = {"i_from": 0}
 
     i_from: NDArray[np.float64]
diff --git a/tests/integration/loadflow/test_power_grid_model.py b/tests/integration/loadflow/test_power_grid_model.py
@@ -353,7 +353,7 @@ def test_create_extended_grid_without_default_from_input_data(self, input_data_p
 
         core_interface = PowerGridModelInterface(grid=grid, input_data=input_data_pgm)
 
-        with pytest.raises(ValueError, match="Missing required columns: {'u'}"):
+        with pytest.raises(ValueError, match=r"Missing required columns: {'u'}"):
             core_interface.create_grid_from_input_data()
 
     def test_with_additional_component_type_in_input_data(self, input_data_pgm):
diff --git a/tests/unit/model/arrays/test_array.py b/tests/unit/model/arrays/test_array.py
diff --git a/tests/unit/model/arrays/test_build.py b/tests/unit/model/arrays/test_build.py
diff --git a/tests/unit/model/grids/serialization/test_json.py b/tests/unit/model/grids/serialization/test_json.py
diff --git a/uv.lock b/uv.lock
