Use deprecate-aware enum from frequenz-core

With this we can enable `@unique` again, as we can explicitly mark
members as deprecated and deprecated members are not checked for
duplicates.

We also replace the internal uses of the deprecated names with the new
names.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

pyproject.toml

@@ -41,6 +41,7 @@ dependencies = [
   "frequenz-channels >= 1.6.1, < 2.0.0",
   "frequenz-client-base >= 0.10.0, < 0.12.0",
   "frequenz-client-common >= 0.3.6, < 0.4.0",
+  "frequenz-core >= 1.3.0, < 2.0.0",
   "grpcio >= 1.72.1, < 2",
   "protobuf >= 6.31.1, < 7",
   "typing-extensions >= 4.13.0, < 5",

src/frequenz/client/microgrid/component/_category.py

@@ -3,14 +3,13 @@
 
 """The component categories that can be used in a microgrid."""
 
-import enum
-
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core import enum
 
 
-# @enum.unique
+@enum.unique
 class ComponentCategory(enum.Enum):
     """The known categories of components that can be present in a microgrid."""
 
@@ -22,7 +21,10 @@ class ComponentCategory(enum.Enum):
     )
     """The point where the local microgrid is connected to the grid."""
 
-    GRID = electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT
+    GRID = enum.deprecated_member(
+        electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT,
+        "GRID is deprecated, use GRID_CONNECTION_POINT instead",
+    )
     """The point where the local microgrid is connected to the grid (deprecated).
 
     Deprecated: Deprecated in v0.18.0
@@ -88,8 +90,9 @@ class ComponentCategory(enum.Enum):
     proportionally reduced, and vice versa.
     """
 
-    VOLTAGE_TRANSFORMER = (
-        electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER
+    VOLTAGE_TRANSFORMER = enum.deprecated_member(
+        electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER,
+        "VOLTAGE_TRANSFORMER is deprecated, use POWER_TRANSFORMER instead",
     )
     """A voltage transformer (deprecated).
 

src/frequenz/client/microgrid/component/_grid_connection_point.py

@@ -34,7 +34,9 @@ class GridConnectionPoint(Component):
     Note that this may also be the PCC in some cases.
     """
 
-    category: Literal[ComponentCategory.GRID] = ComponentCategory.GRID
+    category: Literal[ComponentCategory.GRID_CONNECTION_POINT] = (
+        ComponentCategory.GRID_CONNECTION_POINT
+    )
     """The category of this component."""
 
     rated_fuse_current: int

src/frequenz/client/microgrid/component/_state_sample.py

@@ -3,13 +3,13 @@
 
 """Definition of component states."""
 
-import enum
 from dataclasses import dataclass
 from datetime import datetime
 
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core import enum
 
 
 @enum.unique
@@ -106,7 +106,7 @@ class ComponentStateCode(enum.Enum):
     """The precharger circuit is closed, allowing full current to flow to the main circuit."""
 
 
-# @enum.unique
+@enum.unique
 class ComponentErrorCode(enum.Enum):
     """The various errors that a component can report."""
 
@@ -182,8 +182,9 @@ class ComponentErrorCode(enum.Enum):
     )
     """Plausibility issues within the system involving this component."""
 
-    UNDERVOLTAGE_SHUTDOWN = (
-        electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNDERVOLTAGE
+    UNDERVOLTAGE_SHUTDOWN = enum.deprecated_member(
+        electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNDERVOLTAGE,
+        "UNDERVOLTAGE_SHUTDOWN is deprecated, use UNDERVOLTAGE instead",
     )
     """System shutdown due to undervoltage involving this component.
 

src/frequenz/client/microgrid/component/_voltage_transformer.py

@@ -24,8 +24,8 @@ class VoltageTransformer(Component):
         than the input power.
     """
 
-    category: Literal[ComponentCategory.VOLTAGE_TRANSFORMER] = (
-        ComponentCategory.VOLTAGE_TRANSFORMER
+    category: Literal[ComponentCategory.POWER_TRANSFORMER] = (
+        ComponentCategory.POWER_TRANSFORMER
     )
     """The category of this component."""
 

tests/component/test_grid_connection_point.py

@@ -41,7 +41,7 @@ def test_creation_ok(
     assert grid_point.name == "test_grid_point"
     assert grid_point.manufacturer == "test_manufacturer"
     assert grid_point.model_name == "test_model"
-    assert grid_point.category == ComponentCategory.GRID
+    assert grid_point.category == ComponentCategory.GRID_CONNECTION_POINT
     assert grid_point.rated_fuse_current == rated_fuse_current
 
 

tests/component/test_voltage_transformer.py

@@ -47,6 +47,6 @@ def test_creation_ok(
     assert voltage_transformer.name == "test_voltage_transformer"
     assert voltage_transformer.manufacturer == "test_manufacturer"
     assert voltage_transformer.model_name == "test_model"
-    assert voltage_transformer.category == ComponentCategory.VOLTAGE_TRANSFORMER
+    assert voltage_transformer.category == ComponentCategory.POWER_TRANSFORMER
     assert voltage_transformer.primary_voltage == pytest.approx(primary)
     assert voltage_transformer.secondary_voltage == pytest.approx(secondary)