update to ids wip

Author: Marenz

src/frequenz/client/dispatch/__main__.py

@@ -18,6 +18,8 @@
 from prompt_toolkit.patch_stdout import patch_stdout
 from prompt_toolkit.shortcuts import CompleteStyle
 
+from frequenz.client.common.microgrid import MicrogridId
+
 from ._cli_types import (
     FuzzyDateTime,
     FuzzyIntRange,
@@ -27,7 +29,7 @@
 )
 from ._client import DispatchApiClient
 from .recurrence import EndCriteria, Frequency, RecurrenceRule, Weekday
-from .types import Dispatch, DispatchEvent
+from .types import Dispatch, DispatchEvent, DispatchId
 
 
 def format_datetime(dt: datetime | None) -> str:
@@ -260,7 +262,7 @@ async def list_(ctx: click.Context, /, **filters: Any) -> None:
 @cli.command("stream")
 @click.pass_context
 @click.argument("microgrid-id", required=True, type=int)
-async def stream(ctx: click.Context, microgrid_id: int) -> None:
+async def stream(ctx: click.Context, microgrid_id: MicrogridId) -> None:
     """Stream dispatches."""
     event_stream: Receiver[DispatchEvent] = ctx.obj["client"].stream(
         microgrid_id=microgrid_id
@@ -452,8 +454,8 @@ async def create(
 async def update(
     ctx: click.Context,
     /,
-    microgrid_id: int,
-    dispatch_id: int,
+    microgrid_id: MicrogridId,
+    dispatch_id: DispatchId,
     **new_fields: dict[str, Any],
 ) -> None:
     """Update a dispatch."""
@@ -499,7 +501,9 @@ def skip_field(value: Any) -> bool:
 @click.argument("microgrid-id", required=True, type=int)
 @click.argument("dispatch_ids", type=int, nargs=-1)  # Allow multiple IDs
 @click.pass_context
-async def get(ctx: click.Context, microgrid_id: int, dispatch_ids: List[int]) -> None:
+async def get(
+    ctx: click.Context, microgrid_id: MicrogridId, dispatch_ids: List[int]
+) -> None:
     """Get one or multiple dispatches."""
     num_failed = 0
 
@@ -537,7 +541,7 @@ async def repl(
 @click.argument("dispatch_ids", type=FuzzyIntRange(), nargs=-1)  # Allow multiple IDs
 @click.pass_context
 async def delete(
-    ctx: click.Context, microgrid_id: int, dispatch_ids: list[list[int]]
+    ctx: click.Context, microgrid_id: MicrogridId, dispatch_ids: list[list[int]]
 ) -> None:
     """Delete multiple dispatches.
 

src/frequenz/client/dispatch/_client.py

@@ -36,12 +36,14 @@
 from frequenz.client.base.exception import ClientNotConnected
 from frequenz.client.base.retry import LinearBackoff
 from frequenz.client.base.streaming import GrpcStreamBroadcaster
+from frequenz.client.common.microgrid import MicrogridId
 
 from ._internal_types import DispatchCreateRequest
 from .recurrence import RecurrenceRule
 from .types import (
     Dispatch,
     DispatchEvent,
+    DispatchId,
     TargetComponents,
     _target_components_to_protobuf,
 )
@@ -114,7 +116,7 @@ def stub(self) -> dispatch_pb2_grpc.MicrogridDispatchServiceAsyncStub:
     # pylint: disable=too-many-arguments, too-many-locals
     async def list(
         self,
-        microgrid_id: int,
+        microgrid_id: MicrogridId,
         *,
         target_components: Iterator[TargetComponents] = iter(()),
         start_from: datetime | None = None,
@@ -185,7 +187,7 @@ def to_interval(
         )
 
         request = ListMicrogridDispatchesRequest(
-            microgrid_id=microgrid_id,
+            microgrid_id=int(microgrid_id),
             filter=filters,
             pagination_params=(
                 PaginationParams(page_size=page_size) if page_size else None
@@ -211,7 +213,7 @@ def to_interval(
             else:
                 break
 
-    def stream(self, microgrid_id: int) -> channels.Receiver[DispatchEvent]:
+    def stream(self, microgrid_id: MicrogridId) -> channels.Receiver[DispatchEvent]:
         """Receive a stream of dispatch events.
 
         This function returns a receiver channel that can be used to receive
@@ -238,15 +240,15 @@ def stream(self, microgrid_id: int) -> channels.Receiver[DispatchEvent]:
         return self._get_stream(microgrid_id).new_receiver()
 
     def _get_stream(
-        self, microgrid_id: int
+        self, microgrid_id: MicrogridId
     ) -> GrpcStreamBroadcaster[StreamMicrogridDispatchesResponse, DispatchEvent]:
         """Get an instance to the streaming helper."""
         broadcaster = self._streams.get(microgrid_id)
         if broadcaster is not None and not broadcaster.is_running:
             del self._streams[microgrid_id]
             broadcaster = None
         if broadcaster is None:
-            request = StreamMicrogridDispatchesRequest(microgrid_id=microgrid_id)
+            request = StreamMicrogridDispatchesRequest(microgrid_id=int(microgrid_id))
             broadcaster = GrpcStreamBroadcaster(
                 stream_name="StreamMicrogridDispatches",
                 stream_method=lambda: cast(
@@ -266,7 +268,7 @@ def _get_stream(
 
     async def create(  # pylint: disable=too-many-positional-arguments
         self,
-        microgrid_id: int,
+        microgrid_id: MicrogridId,
         type: str,  # pylint: disable=redefined-builtin
         start_time: datetime | Literal["NOW"],
         duration: timedelta | None,
@@ -334,8 +336,8 @@ async def create(  # pylint: disable=too-many-positional-arguments
     async def update(
         self,
         *,
-        microgrid_id: int,
-        dispatch_id: int,
+        microgrid_id: MicrogridId,
+        dispatch_id: DispatchId,
         new_fields: dict[str, Any],
     ) -> Dispatch:
         """Update a dispatch.
@@ -423,7 +425,9 @@ async def update(
 
         return Dispatch.from_protobuf(response.dispatch)
 
-    async def get(self, *, microgrid_id: int, dispatch_id: int) -> Dispatch:
+    async def get(
+        self, *, microgrid_id: MicrogridId, dispatch_id: DispatchId
+    ) -> Dispatch:
         """Get a dispatch.
 
         Args:
@@ -434,7 +438,7 @@ async def get(self, *, microgrid_id: int, dispatch_id: int) -> Dispatch:
             Dispatch: The dispatch.
         """
         request = GetMicrogridDispatchRequest(
-            dispatch_id=dispatch_id, microgrid_id=microgrid_id
+            dispatch_id=int(dispatch_id), microgrid_id=int(microgrid_id)
         )
         response = await cast(
             Awaitable[GetMicrogridDispatchResponse],
@@ -444,15 +448,17 @@ async def get(self, *, microgrid_id: int, dispatch_id: int) -> Dispatch:
         )
         return Dispatch.from_protobuf(response.dispatch)
 
-    async def delete(self, *, microgrid_id: int, dispatch_id: int) -> None:
+    async def delete(
+        self, *, microgrid_id: MicrogridId, dispatch_id: DispatchId
+    ) -> None:
         """Delete a dispatch.
 
         Args:
             microgrid_id: The microgrid_id to delete the dispatch for.
             dispatch_id: The dispatch_id to delete.
         """
         request = DeleteMicrogridDispatchRequest(
-            dispatch_id=dispatch_id, microgrid_id=microgrid_id
+            dispatch_id=int(dispatch_id), microgrid_id=int(microgrid_id)
         )
         await cast(
             Awaitable[None],

src/frequenz/client/dispatch/_internal_types.py

@@ -12,14 +12,13 @@
 from frequenz.api.dispatch.v1.dispatch_pb2 import (
     CreateMicrogridDispatchRequest as PBDispatchCreateRequest,
 )
-from frequenz.api.dispatch.v1.dispatch_pb2 import (
-    DispatchData,
-)
+from frequenz.api.dispatch.v1.dispatch_pb2 import DispatchData
 from google.protobuf.json_format import MessageToDict
 from google.protobuf.struct_pb2 import Struct
 from google.protobuf.timestamp_pb2 import Timestamp
 
 from frequenz.client.base.conversion import to_datetime, to_timestamp
+from frequenz.client.common.microgrid import MicrogridId
 
 from .recurrence import RecurrenceRule
 from .types import (
@@ -36,7 +35,7 @@
 class DispatchCreateRequest:
     """Request to create a new dispatch."""
 
-    microgrid_id: int
+    microgrid_id: MicrogridId
     """The identifier of the microgrid to which this dispatch belongs."""
 
     type: str
@@ -93,7 +92,7 @@ def from_protobuf(
         )
 
         return DispatchCreateRequest(
-            microgrid_id=pb_object.microgrid_id,
+            microgrid_id=MicrogridId(pb_object.microgrid_id),
             type=pb_object.dispatch_data.type,
             start_time=(
                 "NOW"
@@ -118,7 +117,7 @@ def to_protobuf(self) -> PBDispatchCreateRequest:
         payload.update(self.payload)
 
         return PBDispatchCreateRequest(
-            microgrid_id=self.microgrid_id,
+            microgrid_id=int(self.microgrid_id),
             dispatch_data=DispatchData(
                 type=self.type,
                 start_time=(

src/frequenz/client/dispatch/test/_service.py

@@ -35,6 +35,7 @@
 
 # pylint: enable=no-name-in-module
 from frequenz.client.base.conversion import to_datetime as _to_dt
+from frequenz.client.common.microgrid import MicrogridId
 
 from .._internal_types import DispatchCreateRequest
 from ..types import Dispatch, DispatchEvent, Event
@@ -53,7 +54,7 @@ class FakeService:
     class StreamEvent:
         """Event for the stream."""
 
-        microgrid_id: int
+        microgrid_id: MicrogridId
         """The microgrid id."""
 
         event: DispatchEvent
@@ -66,7 +67,7 @@ def __init__(self) -> None:
         )
         self._stream_sender = self._stream_channel.new_sender()
 
-        self.dispatches: dict[int, list[Dispatch]] = {}
+        self.dispatches: dict[MicrogridId, list[Dispatch]] = {}
         """List of dispatches per microgrid."""
 
         self._last_id: int = 0
@@ -129,7 +130,7 @@ async def ListMicrogridDispatches(
         """
         self._check_access(metadata)
 
-        grid_dispatches = self.dispatches.get(request.microgrid_id, [])
+        grid_dispatches = self.dispatches.get(MicrogridId(request.microgrid_id), [])
 
         return ListMicrogridDispatchesResponse(
             dispatches=map(
@@ -312,9 +313,9 @@ async def UpdateMicrogridDispatch(
                             | "bymonthdays"
                             | "bymonths"
                         ):
-                            getattr(pb_dispatch.data.recurrence, split_path[1])[:] = (
-                                getattr(request.update.recurrence, split_path[1])[:]
-                            )
+                            getattr(pb_dispatch.data.recurrence, split_path[1])[
+                                :
+                            ] = getattr(request.update.recurrence, split_path[1])[:]
 
         dispatch = Dispatch.from_protobuf(pb_dispatch)
         dispatch = replace(

src/frequenz/client/dispatch/test/client.py

@@ -5,6 +5,8 @@
 
 from typing import Any
 
+from frequenz.client.common.microgrid import MicrogridId
+
 from .. import DispatchApiClient
 from ..types import Dispatch
 from ._service import ALL_KEY, NONE_KEY, FakeService
@@ -34,7 +36,7 @@ def stub(self) -> FakeService:  # type: ignore
         """
         return self._stuba
 
-    def dispatches(self, microgrid_id: int) -> list[Dispatch]:
+    def dispatches(self, microgrid_id: MicrogridId) -> list[Dispatch]:
         """List of dispatches.
 
         Args:
@@ -45,7 +47,7 @@ def dispatches(self, microgrid_id: int) -> list[Dispatch]:
         """
         return self._service.dispatches.get(microgrid_id, [])
 
-    def set_dispatches(self, microgrid_id: int, value: list[Dispatch]) -> None:
+    def set_dispatches(self, microgrid_id: MicrogridId, value: list[Dispatch]) -> None:
         """Set the list of dispatches.
 
         Args:
@@ -74,7 +76,7 @@ def _service(self) -> FakeService:
         return self._stuba
 
 
-def to_create_params(microgrid_id: int, dispatch: Dispatch) -> dict[str, Any]:
+def to_create_params(microgrid_id: MicrogridId, dispatch: Dispatch) -> dict[str, Any]:
     """Convert a dispatch to client.create parameters.
 
     Args:

src/frequenz/client/dispatch/test/generator.py

@@ -13,6 +13,7 @@
 from ..types import (
     BatteryType,
     Dispatch,
+    DispatchId,
     EvChargerType,
     InverterType,
     TargetCategories,
@@ -122,7 +123,7 @@ def generate_dispatch(self) -> Dispatch:
         ]
 
         return Dispatch(
-            id=self._last_id,
+            id=DispatchId(self._last_id),
             create_time=create_time,
             update_time=create_time + timedelta(seconds=self._rng.randint(0, 1000000)),
             type=str(self._rng.randint(0, 100_000)),

src/frequenz/client/dispatch/types.py

@@ -7,7 +7,7 @@
 from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
 from enum import Enum
-from typing import Any, Self, SupportsInt, TypeAlias, cast
+from typing import Any, Self, SupportsInt, TypeAlias, cast, final
 
 # pylint: enable=no-name-in-module
 from frequenz.api.common.v1.microgrid.components.battery_pb2 import (
@@ -28,6 +28,7 @@
     StreamMicrogridDispatchesResponse,
 )
 from frequenz.api.dispatch.v1.dispatch_pb2 import TargetComponents as PBTargetComponents
+from frequenz.core.id import BaseId
 from google.protobuf.json_format import MessageToDict
 from google.protobuf.struct_pb2 import Struct
 
@@ -37,6 +38,11 @@
 from .recurrence import Frequency, RecurrenceRule, Weekday
 
 
+@final
+class DispatchId(BaseId, str_prefix="DID"):
+    """A unique identifier for a microgrid."""
+
+
 class EvChargerType(Enum):
     """Enum representing the type of EV charger."""
 
@@ -359,7 +365,7 @@ class TimeIntervalFilter:
 class Dispatch:  # pylint: disable=too-many-instance-attributes
     """Represents a dispatch operation within a microgrid system."""
 
-    id: int
+    id: DispatchId
     """The unique identifier for the dispatch."""
 
     type: str
@@ -534,7 +540,7 @@ def from_protobuf(cls, pb_object: PBDispatch) -> "Dispatch":
             The converted dispatch.
         """
         return Dispatch(
-            id=pb_object.metadata.dispatch_id,
+            id=DispatchId(pb_object.metadata.dispatch_id),
             type=pb_object.data.type,
             create_time=to_datetime(pb_object.metadata.create_time),
             update_time=to_datetime(pb_object.metadata.update_time),
@@ -567,7 +573,7 @@ def to_protobuf(self) -> PBDispatch:
 
         return PBDispatch(
             metadata=DispatchMetadata(
-                dispatch_id=self.id,
+                dispatch_id=int(self.id),
                 create_time=to_timestamp(self.create_time),
                 update_time=to_timestamp(self.update_time),
                 end_time=(