frequenz-dispatch 0.1.0__tar.gz → 0.3.0__tar.gz

{frequenz-dispatch-0.1.0/src/frequenz_dispatch.egg-info → frequenz-dispatch-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-dispatch
-Version: 0.1.0
+Version: 0.3.0
 Summary: A highlevel interface for the dispatch API
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -52,17 +52,20 @@ The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-pyth
 
 ```python
 import os
-import grpc.aio
+from frequenz.dispatch import Dispatcher, RunningState
 from unittest.mock import MagicMock
 
 async def run():
-    host = os.getenv("DISPATCH_API_HOST", "localhost")
-    port = os.getenv("DISPATCH_API_PORT", "50051")
+    url = os.getenv("DISPATCH_API_URL", "grpc://fz-0004.frequenz.io:50051")
+    key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-    service_address = f"{host}:{port}"
-    grpc_channel = grpc.aio.insecure_channel(service_address)
     microgrid_id = 1
-    dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+
+    dispatcher = Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        key=key
+    )
     await dispatcher.start()
 
     actor = MagicMock() # replace with your actor

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.3.0}/README.md

@@ -21,17 +21,20 @@ The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-pyth
 
 ```python
 import os
-import grpc.aio
+from frequenz.dispatch import Dispatcher, RunningState
 from unittest.mock import MagicMock
 
 async def run():
-    host = os.getenv("DISPATCH_API_HOST", "localhost")
-    port = os.getenv("DISPATCH_API_PORT", "50051")
+    url = os.getenv("DISPATCH_API_URL", "grpc://fz-0004.frequenz.io:50051")
+    key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-    service_address = f"{host}:{port}"
-    grpc_channel = grpc.aio.insecure_channel(service_address)
     microgrid_id = 1
-    dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+
+    dispatcher = Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        key=key
+    )
     await dispatcher.start()
 
     actor = MagicMock() # replace with your actor

frequenz-dispatch-0.3.0/RELEASE_NOTES.md

@@ -0,0 +1,20 @@
+# Dispatch Highlevel Interface Release Notes
+
+## Summary
+
+<!-- Here goes a general summary of what this release is about -->
+
+## Upgrading
+
+- The dispatch high level interface now depends on `frequenz-sdk` version `v1.0.0-rc900`.
+- We are now using the version `0.6.0` of the underlying `frequenz-client-dispatch` client library.
+- The init parameter of the `Dispatcher` class has been changed to accept a `server_url` instead.
+
+## New Features
+
+* Using the new dispatch client, we now have support for pagination in the dispatch list request.
+* The new client version also supports streaming, however it is not yet used internally in the high level interface.
+
+## Bug Fixes
+
+- Fix documentation cross-linking to the `frequenz-client-dispatch` package.

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.3.0}/pyproject.toml

@@ -5,7 +5,7 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[lib] == 0.9.2",
+  "frequenz-repo-config[lib] == 0.10.0",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -35,16 +35,13 @@ classifiers = [
 requires-python = ">= 3.11, < 4"
 dependencies = [
   "python-dateutil >= 2.8.2, < 3.0",
-  "typing-extensions == 4.11.0",
+  "typing-extensions >= 4.11.0, < 5.0.0",
   # Make sure to update the version for cross-referencing also in the
   # mkdocs.yml file when changing the version here (look for the config key
   # plugins.mkdocstrings.handlers.python.import)
-  "frequenz-sdk == v1.0.0-rc6",
-  "frequenz-channels == 1.0.0",
-  "frequenz-api-dispatch >= 0.13.0, < 0.14",
-  "frequenz-client-dispatch == 0.2.0",
-  "frequenz-client-base >= 0.3.0, < 0.4.0",
-  "frequenz-client-common >= 0.1.0, < 0.2.0",
+  "frequenz-sdk == 1.0.0-rc900",
+  "frequenz-channels >= 1.1.0, < 2.0.0",
+  "frequenz-client-dispatch >= 0.6.0, < 0.7.0",
 ]
 dynamic = ["version"]
 
@@ -54,48 +51,50 @@ email = "floss@frequenz.com"
 
 [project.optional-dependencies]
 dev-flake8 = [
-  "flake8 == 7.0.0",
+  "flake8 == 7.1.1",
   "flake8-docstrings == 1.7.0",
   "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.4.1",
+  "pydoclint == 0.5.6",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 24.4.2", "isort == 5.13.2"]
+dev-formatting = ["black == 24.8.0", "isort == 5.13.2"]
 dev-mkdocs = [
-  "black == 24.4.2",
-  "Markdown==3.6",
-  "mike == 2.1.0",
+  "black == 24.8.0",
+  "Markdown==3.7",
+  "mike == 2.1.3",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.1",
   "mkdocs-macros-plugin == 1.0.5",
-  "mkdocs-material == 9.5.20",
-  "mkdocstrings[python] == 0.25.0",
-  "frequenz-repo-config[lib] == 0.9.2",
+  "mkdocs-material == 9.5.34",
+  "mkdocstrings[python] == 0.25.2",
+  "mkdocstrings-python == 1.10.9",
+  "frequenz-repo-config[lib] == 0.10.0",
 ]
 dev-mypy = [
-  "mypy == 1.10.0",
-  "types-Markdown == 3.6.0.20240316",
-  "types-python-dateutil==2.9.0.20240316",
+  "mypy == 1.11.2",
+  "grpc-stubs == 1.53.0.5",               # This dependency introduces breaking changes in patch releases
+  "types-Markdown == 3.7.0.20240822",
+  "types-python-dateutil==2.9.0.20240821",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
-  "uv == 0.1.39",
+  "uv == 0.4.1",
   "nox == 2024.4.15",
-  "frequenz-repo-config[lib] == 0.9.2",
+  "frequenz-repo-config[lib] == 0.10.0",
 ]
 dev-pylint = [
-  "pylint == 3.1.0",
+  "pylint == 3.2.7",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.2.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.9.2",
+  "pytest == 8.3.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.10.0",
   "pytest-mock == 3.14.0",
-  "pytest-asyncio == 0.23.6",
-  "async-solipsism == 0.6",
-  "time-machine == 2.14.1",
+  "pytest-asyncio == 0.24.0",
+  "async-solipsism == 0.7",
+  "time-machine == 2.15.0",
 ]
 dev = [
   "frequenz-dispatch[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
@@ -151,8 +150,12 @@ disable = [
   # pylint's unsubscriptable check is buggy and is not needed because
   # it is a type-check, for which we already have mypy.
   "unsubscriptable-object",
+  # Checked by mypy
+  "no-member",
   # Checked by flake8
+  "f-string-without-interpolation",
   "line-too-long",
+  "missing-function-docstring",
   "redefined-outer-name",
   "unnecessary-lambda-assignment",
   "unused-import",
@@ -177,7 +180,13 @@ packages = ["frequenz.dispatch"]
 strict = true
 
 [[tool.mypy.overrides]]
-module = ["mkdocs_macros.*", "async_solipsism", "async_solipsism.*"]
+module = [
+  "mkdocs_macros.*",
+  "async_solipsism",
+  "async_solipsism.*",
+  "grpc.aio",
+  "grpc.aio.*",
+]
 ignore_missing_imports = true
 
 [tool.setuptools_scm]

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.3.0}/src/frequenz/dispatch/_dispatcher.py

@@ -6,7 +6,6 @@
 import abc
 from typing import Protocol, TypeVar
 
-import grpc.aio
 from frequenz.channels import Broadcast, Receiver
 from frequenz.client.dispatch import Client
 
@@ -55,18 +54,20 @@ class Dispatcher:
     Example: Processing running state change dispatches
         ```python
         import os
-        import grpc.aio
         from frequenz.dispatch import Dispatcher, RunningState
         from unittest.mock import MagicMock
 
         async def run():
-            host = os.getenv("DISPATCH_API_HOST", "localhost")
-            port = os.getenv("DISPATCH_API_PORT", "50051")
+            url = os.getenv("DISPATCH_API_URL", "grpc://fz-0004.frequenz.io:50051")
+            key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-            service_address = f"{host}:{port}"
-            grpc_channel = grpc.aio.insecure_channel(service_address)
             microgrid_id = 1
-            dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+
+            dispatcher = Dispatcher(
+                microgrid_id=microgrid_id,
+                server_url=url,
+                key=key
+            )
             await dispatcher.start()
 
             actor = MagicMock() # replace with your actor
@@ -104,18 +105,20 @@ class Dispatcher:
         import os
         from typing import assert_never
 
-        import grpc.aio
         from frequenz.dispatch import Created, Deleted, Dispatcher, Updated
 
         async def run():
-            host = os.getenv("DISPATCH_API_HOST", "localhost")
-            port = os.getenv("DISPATCH_API_PORT", "50051")
+            url = os.getenv("DISPATCH_API_URL", "grpc://fz-0004.frequenz.io:50051")
+            key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-            service_address = f"{host}:{port}"
-            grpc_channel = grpc.aio.insecure_channel(service_address)
             microgrid_id = 1
-            dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
-            dispatcher.start()  # this will start the actor
+
+            dispatcher = Dispatcher(
+                microgrid_id=microgrid_id,
+                server_url=url,
+                key=key
+            )
+            await dispatcher.start()  # this will start the actor
 
             events_receiver = dispatcher.lifecycle_events.new_receiver()
 
@@ -138,25 +141,27 @@ class Dispatcher:
         import os
         from datetime import datetime, timedelta, timezone
 
-        import grpc.aio
         from frequenz.client.common.microgrid.components import ComponentCategory
 
         from frequenz.dispatch import Dispatcher
 
         async def run():
-            host = os.getenv("DISPATCH_API_HOST", "localhost")
-            port = os.getenv("DISPATCH_API_PORT", "50051")
+            url = os.getenv("DISPATCH_API_URL", "grpc://fz-0004.frequenz.io:50051")
+            key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-            service_address = f"{host}:{port}"
-            grpc_channel = grpc.aio.insecure_channel(service_address)
             microgrid_id = 1
-            dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+
+            dispatcher = Dispatcher(
+                microgrid_id=microgrid_id,
+                server_url=url,
+                key=key
+            )
             await dispatcher.start()  # this will start the actor
 
             # Create a new dispatch
             new_dispatch = await dispatcher.client.create(
                 microgrid_id=microgrid_id,
-                _type="ECHO_FREQUENCY",  # replace with your own type
+                type="ECHO_FREQUENCY",  # replace with your own type
                 start_time=datetime.now(tz=timezone.utc) + timedelta(minutes=10),
                 duration=timedelta(minutes=5),
                 selector=ComponentCategory.INVERTER,
@@ -165,30 +170,38 @@ class Dispatcher:
 
             # Modify the dispatch
             await dispatcher.client.update(
-                dispatch_id=new_dispatch.id, new_fields={"duration": timedelta(minutes=10)}
+                microgrid_id=microgrid_id,
+                dispatch_id=new_dispatch.id,
+                new_fields={"duration": timedelta(minutes=10)}
             )
 
             # Validate the modification
-            modified_dispatch = await dispatcher.client.get(new_dispatch.id)
+            modified_dispatch = await dispatcher.client.get(
+                microgrid_id=microgrid_id, dispatch_id=new_dispatch.id
+            )
             assert modified_dispatch.duration == timedelta(minutes=10)
         ```
     """
 
     def __init__(
-        self, microgrid_id: int, grpc_channel: grpc.aio.Channel, svc_addr: str
+        self,
+        *,
+        microgrid_id: int,
+        server_url: str,
+        key: str,
     ):
         """Initialize the dispatcher.
 
         Args:
             microgrid_id: The microgrid id.
-            grpc_channel: The gRPC channel.
-            svc_addr: The service address.
+            server_url: The URL of the dispatch service.
+            key: The key to access the service.
         """
         self._running_state_channel = Broadcast[Dispatch](name="running_state_change")
         self._lifecycle_events_channel = Broadcast[DispatchEvent](
             name="lifecycle_events"
         )
-        self._client = Client(grpc_channel, svc_addr)
+        self._client = Client(server_url=server_url, key=key)
         self._actor = DispatchingActor(
             microgrid_id,
             self._client,

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.3.0}/src/frequenz/dispatch/actor.py

@@ -89,28 +89,27 @@ class DispatchingActor(Actor):
 
         try:
             _logger.info("Fetching dispatches for microgrid %s", self._microgrid_id)
-            async for client_dispatch in self._client.list(
-                microgrid_id=self._microgrid_id
-            ):
-                dispatch = Dispatch(client_dispatch)
-
-                self._dispatches[dispatch.id] = Dispatch(client_dispatch)
-                old_dispatch = old_dispatches.pop(dispatch.id, None)
-                if not old_dispatch:
-                    self._update_dispatch_schedule(dispatch, None)
-                    _logger.info("New dispatch: %s", dispatch)
-                    await self._lifecycle_updates_sender.send(
-                        Created(dispatch=dispatch)
-                    )
-                elif dispatch.update_time != old_dispatch.update_time:
-                    self._update_dispatch_schedule(dispatch, old_dispatch)
-                    _logger.info("Updated dispatch: %s", dispatch)
-                    await self._lifecycle_updates_sender.send(
-                        Updated(dispatch=dispatch)
-                    )
-
-                    if self._running_state_change(dispatch, old_dispatch):
-                        await self._send_running_state_change(dispatch)
+            async for page in self._client.list(microgrid_id=self._microgrid_id):
+                for client_dispatch in page:
+                    dispatch = Dispatch(client_dispatch)
+
+                    self._dispatches[dispatch.id] = Dispatch(client_dispatch)
+                    old_dispatch = old_dispatches.pop(dispatch.id, None)
+                    if not old_dispatch:
+                        self._update_dispatch_schedule(dispatch, None)
+                        _logger.info("New dispatch: %s", dispatch)
+                        await self._lifecycle_updates_sender.send(
+                            Created(dispatch=dispatch)
+                        )
+                    elif dispatch.update_time != old_dispatch.update_time:
+                        self._update_dispatch_schedule(dispatch, old_dispatch)
+                        _logger.info("Updated dispatch: %s", dispatch)
+                        await self._lifecycle_updates_sender.send(
+                            Updated(dispatch=dispatch)
+                        )
+
+                        if self._running_state_change(dispatch, old_dispatch):
+                            await self._send_running_state_change(dispatch)
 
         except grpc.aio.AioRpcError as error:
             _logger.error("Error fetching dispatches: %s", error)

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.3.0/src/frequenz_dispatch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-dispatch
-Version: 0.1.0
+Version: 0.3.0
 Summary: A highlevel interface for the dispatch API
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -52,17 +52,20 @@ The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-pyth
 
 ```python
 import os
-import grpc.aio
+from frequenz.dispatch import Dispatcher, RunningState
 from unittest.mock import MagicMock
 
 async def run():
-    host = os.getenv("DISPATCH_API_HOST", "localhost")
-    port = os.getenv("DISPATCH_API_PORT", "50051")
+    url = os.getenv("DISPATCH_API_URL", "grpc://fz-0004.frequenz.io:50051")
+    key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-    service_address = f"{host}:{port}"
-    grpc_channel = grpc.aio.insecure_channel(service_address)
     microgrid_id = 1
-    dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+
+    dispatcher = Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        key=key
+    )
     await dispatcher.start()
 
     actor = MagicMock() # replace with your actor

frequenz-dispatch-0.3.0/src/frequenz_dispatch.egg-info/requires.txt

@@ -0,0 +1,55 @@
+python-dateutil<3.0,>=2.8.2
+typing-extensions<5.0.0,>=4.11.0
+frequenz-sdk==1.0.0-rc900
+frequenz-channels<2.0.0,>=1.1.0
+frequenz-client-dispatch<0.7.0,>=0.6.0
+
+[dev]
+frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
+
+[dev-flake8]
+flake8==7.1.1
+flake8-docstrings==1.7.0
+flake8-pyproject==1.2.3
+pydoclint==0.5.6
+pydocstyle==6.3.0
+
+[dev-formatting]
+black==24.8.0
+isort==5.13.2
+
+[dev-mkdocs]
+black==24.8.0
+Markdown==3.7
+mike==2.1.3
+mkdocs-gen-files==0.5.0
+mkdocs-literate-nav==0.6.1
+mkdocs-macros-plugin==1.0.5
+mkdocs-material==9.5.34
+mkdocstrings[python]==0.25.2
+mkdocstrings-python==1.10.9
+frequenz-repo-config[lib]==0.10.0
+
+[dev-mypy]
+mypy==1.11.2
+grpc-stubs==1.53.0.5
+types-Markdown==3.7.0.20240822
+types-python-dateutil==2.9.0.20240821
+frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
+
+[dev-noxfile]
+uv==0.4.1
+nox==2024.4.15
+frequenz-repo-config[lib]==0.10.0
+
+[dev-pylint]
+pylint==3.2.7
+frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
+
+[dev-pytest]
+pytest==8.3.2
+frequenz-repo-config[extra-lint-examples]==0.10.0
+pytest-mock==3.14.0
+pytest-asyncio==0.24.0
+async-solipsism==0.7
+time-machine==2.15.0

frequenz-dispatch-0.1.0/RELEASE_NOTES.md

@@ -1,14 +0,0 @@
-# Dispatch Highlevel Interface Release Notes
-
-## Summary
-
-This is the first release of the highlevel dispatch interface!
-
-## Upgrading
-
-* `Dispatcher.ready_to_execute()` was renamed to `Dispatcher.running_status_change()`
-
-## New Features
-
-* Introduced new class `Dispatch` (based on the client class) that contains useful functions and extended information about the received dispatch.
-* `Dispatcher.client` was added to provide an easy access to the client for updating, deleting and creating dispatches

frequenz-dispatch-0.1.0/src/frequenz_dispatch.egg-info/requires.txt

@@ -1,56 +0,0 @@
-python-dateutil<3.0,>=2.8.2
-typing-extensions==4.11.0
-frequenz-sdk==v1.0.0-rc6
-frequenz-channels==1.0.0
-frequenz-api-dispatch<0.14,>=0.13.0
-frequenz-client-dispatch==0.2.0
-frequenz-client-base<0.4.0,>=0.3.0
-frequenz-client-common<0.2.0,>=0.1.0
-
-[dev]
-frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
-
-[dev-flake8]
-flake8==7.0.0
-flake8-docstrings==1.7.0
-flake8-pyproject==1.2.3
-pydoclint==0.4.1
-pydocstyle==6.3.0
-
-[dev-formatting]
-black==24.4.2
-isort==5.13.2
-
-[dev-mkdocs]
-black==24.4.2
-Markdown==3.6
-mike==2.1.0
-mkdocs-gen-files==0.5.0
-mkdocs-literate-nav==0.6.1
-mkdocs-macros-plugin==1.0.5
-mkdocs-material==9.5.20
-mkdocstrings[python]==0.25.0
-frequenz-repo-config[lib]==0.9.2
-
-[dev-mypy]
-mypy==1.10.0
-types-Markdown==3.6.0.20240316
-types-python-dateutil==2.9.0.20240316
-frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
-
-[dev-noxfile]
-uv==0.1.39
-nox==2024.4.15
-frequenz-repo-config[lib]==0.9.2
-
-[dev-pylint]
-pylint==3.1.0
-frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
-
-[dev-pytest]
-pytest==8.2.0
-frequenz-repo-config[extra-lint-examples]==0.9.2
-pytest-mock==3.14.0
-pytest-asyncio==0.23.6
-async-solipsism==0.6
-time-machine==2.14.1