Add EnterpriseId

This ID will be used for getting the microgrid information.

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

Author: llucax

src/frequenz/client/microgrid/__init__.py

@@ -30,14 +30,15 @@
     UnknownError,
     UnrecognizedGrpcStatus,
 )
-from ._id import ComponentId, MicrogridId, SensorId
+from ._id import ComponentId, EnterpriseId, MicrogridId, SensorId
 from ._lifetime import Lifetime
 
 __all__ = [
     "ApiClientError",
     "ClientNotConnected",
     "ComponentId",
     "DataLoss",
+    "EnterpriseId",
     "EntityAlreadyExists",
     "EntityNotFound",
     "GrpcError",

src/frequenz/client/microgrid/_id.py

@@ -1,12 +1,62 @@
 # License: MIT
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Strongly typed IDs for microgrids, components and sensors."""
+"""Strongly typed IDs for enterprises, microgrids, components and sensors."""
 
 
 from typing import final
 
 
+@final
+class EnterpriseId:
+    """A unique identifier for an enterprise account."""
+
+    def __init__(self, id_: int, /) -> None:
+        """Initialize this instance.
+
+        Args:
+            id_: The numeric unique identifier of the enterprise account.
+
+        Raises:
+            ValueError: If the ID is negative.
+        """
+        if id_ < 0:
+            raise ValueError("Enterprise ID can't be negative.")
+        self._id = id_
+
+    def __int__(self) -> int:
+        """Return the numeric ID of this instance."""
+        return self._id
+
+    def __eq__(self, other: object) -> bool:
+        """Check if this instance is equal to another object."""
+        # This is not an unidiomatic typecheck, that's an odd name for the check.
+        # isinstance() returns True for subclasses, which is not what we want here.
+        # pylint: disable-next=unidiomatic-typecheck
+        return type(other) is EnterpriseId and self._id == other._id
+
+    def __lt__(self, other: object) -> bool:
+        """Check if this instance is less than another object."""
+        # pylint: disable-next=unidiomatic-typecheck
+        if type(other) is EnterpriseId:
+            return self._id < other._id
+        return NotImplemented
+
+    def __hash__(self) -> int:
+        """Return the hash of this instance."""
+        # We include the class because we explicitly want to avoid the same ID to give
+        # the same hash for different classes of IDs
+        return hash((EnterpriseId, self._id))
+
+    def __repr__(self) -> str:
+        """Return the string representation of this instance."""
+        return f"{type(self).__name__}({self._id!r})"
+
+    def __str__(self) -> str:
+        """Return the short string representation of this instance."""
+        return f"EID{self._id}"
+
+
 @final
 class MicrogridId:
     """A unique identifier for a microgrid."""

tests/test_id.py

@@ -1,13 +1,13 @@
 # License: MIT
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Tests for the microgrid and component IDs."""
+"""Tests for the enterprise, microgrid and component IDs."""
 
 from dataclasses import dataclass
 
 import pytest
 
-from frequenz.client.microgrid import ComponentId, MicrogridId, SensorId
+from frequenz.client.microgrid import ComponentId, EnterpriseId, MicrogridId, SensorId
 
 
 @dataclass(frozen=True)
@@ -21,6 +21,7 @@ class IdTypeInfo:
 
 # Define all ID types to test here
 ID_TYPES: list[IdTypeInfo] = [
+    IdTypeInfo(EnterpriseId, "EID", "Enterprise"),
     IdTypeInfo(MicrogridId, "MID", "Microgrid"),
     IdTypeInfo(ComponentId, "CID", "Component"),
     IdTypeInfo(SensorId, "SID", "Sensor"),