Apply changes from v0.3 to v1alpha8 (#98)

This applies the v0.3 changes done to the frequenz.client.common.* dir
to frequenz.client.common.v1alpha8 dir
* replacing and deprecating from_proto
* using enum.Enum in favor of Enum
* using enum.unique
* addition of base id types

Author: Marenz

src/frequenz/client/common/v1alpha8/metric/__init__.py

@@ -3,13 +3,15 @@
 
 """Module to define the metrics used with the common client."""
 
-from enum import Enum
+import enum
 from typing import Self
 
 from frequenz.api.common.v1alpha8.metrics.metrics_pb2 import Metric as PBMetric
+from typing_extensions import deprecated
 
 
-class Metric(Enum):
+@enum.unique
+class Metric(enum.Enum):
     """List of supported metrics.
 
     AC energy metrics information:
@@ -137,6 +139,7 @@ class Metric(Enum):
     SENSOR_IRRADIANCE = PBMetric.METRIC_SENSOR_IRRADIANCE
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(cls, metric: PBMetric.ValueType) -> Self:
         """Convert a protobuf Metric value to Metric enum.
 

src/frequenz/client/common/v1alpha8/microgrid/__init__.py

@@ -2,3 +2,17 @@
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
 """Frequenz microgrid definition."""
+
+from typing import final
+
+from frequenz.core.id import BaseId
+
+
+@final
+class EnterpriseId(BaseId, str_prefix="EID"):
+    """A unique identifier for an enterprise account."""
+
+
+@final
+class MicrogridId(BaseId, str_prefix="MID"):
+    """A unique identifier for a microgrid."""

src/frequenz/client/common/v1alpha8/microgrid/electrical_components/__init__.py

@@ -4,7 +4,8 @@
 """Defines the electrical components that can be used in a microgrid."""
 from __future__ import annotations
 
-from enum import Enum
+import enum
+from typing import final
 
 # pylint: disable=no-name-in-module
 from frequenz.api.common.v1alpha8.microgrid.electrical_components.electrical_components_pb2 import (
@@ -16,11 +17,19 @@
 from frequenz.api.common.v1alpha8.microgrid.electrical_components.electrical_components_pb2 import (
     ElectricalComponentStateCode as PBElectricalComponentStateCode,
 )
+from frequenz.core.id import BaseId
+from typing_extensions import deprecated
 
 # pylint: enable=no-name-in-module
 
 
-class ElectricalComponentCategory(Enum):
+@final
+class ElectricalComponentId(BaseId, str_prefix="CID"):
+    """A unique identifier for a microgrid electrical component."""
+
+
+@enum.unique
+class ElectricalComponentCategory(enum.Enum):
     """Possible types of microgrid electrical component."""
 
     UNSPECIFIED = (
@@ -80,6 +89,7 @@ class ElectricalComponentCategory(Enum):
     """A heating, ventilation, and air conditioning (HVAC) system."""
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(
         cls, component_category: PBElectricalComponentCategory.ValueType
     ) -> ElectricalComponentCategory:
@@ -104,7 +114,8 @@ def to_proto(self) -> PBElectricalComponentCategory.ValueType:
         return self.value
 
 
-class ElectricalComponentStateCode(Enum):
+@enum.unique
+class ElectricalComponentStateCode(enum.Enum):
     """All possible states of a microgrid electrical component."""
 
     UNSPECIFIED = (
@@ -206,6 +217,7 @@ class ElectricalComponentStateCode(Enum):
     """The precharger circuit is closed, allowing full current to flow to the main circuit."""
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(
         cls, component_state: PBElectricalComponentStateCode.ValueType
     ) -> ElectricalComponentStateCode:
@@ -230,7 +242,8 @@ def to_proto(self) -> PBElectricalComponentStateCode.ValueType:
         return self.value
 
 
-class ElectricalComponentDiagnosticCode(Enum):
+@enum.unique
+class ElectricalComponentDiagnosticCode(enum.Enum):
     """All diagnostics that can occur across electrical component categories."""
 
     UNSPECIFIED = (
@@ -419,6 +432,7 @@ class ElectricalComponentDiagnosticCode(Enum):
     times."""
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(
         cls, component_error_code: PBElectricalComponentDiagnosticCode.ValueType
     ) -> ElectricalComponentDiagnosticCode:

src/frequenz/client/common/v1alpha8/microgrid/sensors.py

@@ -0,0 +1,13 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Microgrid sensors."""
+
+from typing import final
+
+from frequenz.core.id import BaseId
+
+
+@final
+class SensorId(BaseId, str_prefix="SID"):
+    """A unique identifier for a microgrid sensor."""

tests/microgrid/test_ids_alpha8.py

@@ -0,0 +1,30 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Tests for microgrid-related IDs."""
+
+import pytest
+from frequenz.core.id import BaseId
+
+from frequenz.client.common.v1alpha8.microgrid import EnterpriseId, MicrogridId
+from frequenz.client.common.v1alpha8.microgrid.electrical_components import (
+    ElectricalComponentId,
+)
+from frequenz.client.common.v1alpha8.microgrid.sensors import SensorId
+
+
+@pytest.mark.parametrize(
+    "id_class, prefix",
+    [
+        (EnterpriseId, "EID"),
+        (MicrogridId, "MID"),
+        (ElectricalComponentId, "CID"),
+        (SensorId, "SID"),
+    ],
+)
+def test_string_representation(id_class: type[BaseId], prefix: str) -> None:
+    """Test string representation of IDs."""
+    _id = id_class(123)
+
+    assert str(_id) == f"{prefix}123"
+    assert repr(_id) == f"{id_class.__name__}(123)"