Use named parameters for client c'tor

Due to the new key parameter, we want to be more explicit

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

RELEASE_NOTES.md

@@ -7,6 +7,7 @@
 ## Upgrading
 
 * An API key for authorization must now be passed to the `DispatchClient`.
+* The client constructor now requires named parameters. If you are using the client directly, you will need to update your code to use named parameters.
 
 ## New Features
 

src/frequenz/client/dispatch/__main__.py

@@ -36,7 +36,7 @@
 DEFAULT_DISPATCH_API_PORT = 50051
 
 
-def get_client(host: str, port: int, key: str) -> Client:
+def get_client(*, host: str, port: int, key: str) -> Client:
     """Get a new client instance.
 
     Args:
@@ -48,7 +48,7 @@ def get_client(host: str, port: int, key: str) -> Client:
         Client: A new client instance.
     """
     channel = grpc.aio.insecure_channel(f"{host}:{port}")
-    return Client(channel, f"{host}:{port}", key)
+    return Client(grpc_channel=channel, svc_addr=f"{host}:{port}", key=key)
 
 
 # Click command groups
@@ -82,7 +82,7 @@ async def cli(ctx: click.Context, host: str, port: int, key: str) -> None:
     if ctx.obj is None:
         ctx.obj = {}
 
-    ctx.obj["client"] = get_client(host, port, key)
+    ctx.obj["client"] = get_client(host=host, port=port, key=key)
     ctx.obj["params"] = {
         "host": host,
         "port": port,

src/frequenz/client/dispatch/_client.py

@@ -36,7 +36,9 @@
 class Client:
     """Dispatch API client."""
 
-    def __init__(self, grpc_channel: grpc.aio.Channel, svc_addr: str, key: str) -> None:
+    def __init__(
+        self, *, grpc_channel: grpc.aio.Channel, svc_addr: str, key: str
+    ) -> None:
         """Initialize the client.
 
         Args:
@@ -66,7 +68,7 @@ async def list(
 
         ```python
         grpc_channel = grpc.aio.insecure_channel("example")
-        client = Client(grpc_channel, "localhost:50051", "key")
+        client = Client(grpc_channel=grpc_channel, svc_addr="localhost:50051", key="key")
         async for dispatch in client.list(microgrid_id=1):
             print(dispatch)
         ```

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

@@ -26,7 +26,7 @@ def __init__(
         Args:
             shuffle_after_create: Whether to shuffle the dispatches after creating them.
         """
-        super().__init__(MagicMock(), "mock", "all")
+        super().__init__(grpc_channel=MagicMock(), svc_addr="mock", key="all")
         self._stub = FakeService()  # type: ignore
         self._service._shuffle_after_create = shuffle_after_create