frequenz-client-assets 0.0.2__tar.gz

frequenz_client_assets-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

frequenz_client_assets-0.0.2/MANIFEST.in

@@ -0,0 +1,13 @@
+exclude .cookiecutter-replay.json
+exclude .editorconfig
+exclude .gitignore
+exclude CODEOWNERS
+exclude CONTRIBUTING.md
+exclude mkdocs.yml
+exclude noxfile.py
+exclude src/conftest.py
+recursive-exclude .github *
+recursive-exclude benchmarks *
+recursive-exclude docs *
+recursive-exclude tests *
+recursive-include py *.pyi

frequenz_client_assets-0.0.2/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: frequenz-client-assets
+Version: 0.0.2
+Summary: Assets API client for Python
+Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
+License: MIT
+Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-client-assets-python/
+Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-client-assets-python/releases
+Project-URL: Issues, https://github.com/frequenz-floss/frequenz-client-assets-python/issues
+Project-URL: Repository, https://github.com/frequenz-floss/frequenz-client-assets-python
+Project-URL: Support, https://github.com/frequenz-floss/frequenz-client-assets-python/discussions/categories/support
+Keywords: frequenz,python,lib,library,frequenz-client-assets,client-assets,client,assets,api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions<5,>=4.13.0
+Requires-Dist: frequenz-api-assets<0.2.0,>=0.1.0
+Requires-Dist: frequenz-api-common<1,>=0.8.0
+Requires-Dist: frequenz-client-base<0.12.0,>=0.11.0
+Requires-Dist: frequenz-client-common<0.4.0,>=0.3.6
+Requires-Dist: grpcio<2,>=1.73.1
+Provides-Extra: cli
+Requires-Dist: asyncclick==8.3.0.4; extra == "cli"
+Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.6.10; extra == "dev-flake8"
+Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
+Provides-Extra: dev-formatting
+Requires-Dist: black==25.9.0; extra == "dev-formatting"
+Requires-Dist: isort==6.1.0; extra == "dev-formatting"
+Provides-Extra: dev-mkdocs
+Requires-Dist: Markdown==3.9; extra == "dev-mkdocs"
+Requires-Dist: black==25.9.0; extra == "dev-mkdocs"
+Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.4.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.17; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.30.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
+Provides-Extra: dev-mypy
+Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.9.0.20250906; extra == "dev-mypy"
+Requires-Dist: types-protobuf==6.32.1.20250918; extra == "dev-mypy"
+Requires-Dist: frequenz-client-assets[cli,dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
+Provides-Extra: dev-noxfile
+Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-noxfile"
+Provides-Extra: dev-pylint
+Requires-Dist: frequenz-client-assets[cli,dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
+Provides-Extra: dev-pytest
+Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
+Requires-Dist: pylint==3.3.8; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==1.1.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
+Provides-Extra: dev
+Requires-Dist: frequenz-client-assets[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
+
+# Frequenz Assets API Client
+
+[![Build Status](https://github.com/frequenz-floss/frequenz-client-assets-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-client-assets-python/actions/workflows/ci.yaml)
+[![PyPI Package](https://img.shields.io/pypi/v/frequenz-client-assets)](https://pypi.org/project/frequenz-client-assets/)
+[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-client-assets-python/)
+
+## Introduction
+
+Assets API client for Python
+
+## Supported Platforms
+
+The following platforms are officially supported (tested):
+
+- **Python:** 3.11
+- **Operating System:** Ubuntu Linux 20.04
+- **Architectures:** amd64, arm64
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_client_assets-0.0.2/README.md

@@ -0,0 +1,22 @@
+# Frequenz Assets API Client
+
+[![Build Status](https://github.com/frequenz-floss/frequenz-client-assets-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-client-assets-python/actions/workflows/ci.yaml)
+[![PyPI Package](https://img.shields.io/pypi/v/frequenz-client-assets)](https://pypi.org/project/frequenz-client-assets/)
+[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-client-assets-python/)
+
+## Introduction
+
+Assets API client for Python
+
+## Supported Platforms
+
+The following platforms are officially supported (tested):
+
+- **Python:** 3.11
+- **Operating System:** Ubuntu Linux 20.04
+- **Architectures:** amd64, arm64
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_client_assets-0.0.2/RELEASE_NOTES.md

@@ -0,0 +1,32 @@
+# Frequenz Assets API Client Release Notes
+
+## Summary
+
+This release updates the `frequenz-api-assets` dependency to use a version range instead of a specific Git reference, providing more flexibility for dependency updates while maintaining compatibility.
+
+## Changes
+
+### Dependency Updates
+
+* **Updated `frequenz-api-assets` dependency**:
+  * Changed from Git reference (`@ git+https://github.com/frequenz-floss/frequenz-api-assets.git@v0.x.x`) to version range (`>= 0.1.0, < 0.2.0`)
+  * Enables automatic updates within the specified version range
+  * Maintains backward compatibility while reducing maintenance overhead
+
+## Benefits
+
+* **Improved dependency management**: Version ranges allow for automatic updates within the specified range
+* **Better compatibility**: Ensures compatibility with the project while allowing for patch and minor version updates
+* **Reduced maintenance overhead**: Eliminates the need to manually update Git references for compatible versions
+
+## Migration Notes
+
+No migration required. This is a transparent dependency update that maintains full backward compatibility.
+
+## Files Changed
+
+* `pyproject.toml`: Updated the `frequenz-api-assets` dependency specification
+
+## Type of Change
+
+* [x] Dependency update

frequenz_client_assets-0.0.2/pyproject.toml

@@ -0,0 +1,199 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+[build-system]
+requires = [
+  "setuptools == 80.9.0",
+  "setuptools_scm[toml] == 9.2.0",
+  "frequenz-repo-config[lib] == 0.13.5",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "frequenz-client-assets"
+description = "Assets API client for Python"
+readme = "README.md"
+license = { text = "MIT" }
+keywords = [
+  "frequenz",
+  "python",
+  "lib",
+  "library",
+  "frequenz-client-assets",
+  "client-assets",
+  "client",
+  "assets",
+  "api",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Software Development :: Libraries",
+  "Typing :: Typed",
+]
+requires-python = ">= 3.11, < 4"
+dependencies = [
+  "typing-extensions >= 4.13.0, < 5",
+  "frequenz-api-assets >= 0.1.0, < 0.2.0",
+  "frequenz-api-common >= 0.8.0, < 1",
+  "frequenz-client-base >= 0.11.0, < 0.12.0",
+  "frequenz-client-common >= 0.3.6, < 0.4.0",
+  "grpcio >= 1.73.1, < 2",
+]
+dynamic = ["version"]
+
+[project.scripts]
+assets-cli = "frequenz.client.assets.cli.__main__:main"
+
+[[project.authors]]
+name = "Frequenz Energy-as-a-Service GmbH"
+email = "floss@frequenz.com"
+
+[project.optional-dependencies]
+cli = ["asyncclick == 8.3.0.4"]
+dev-flake8 = [
+  "flake8 == 7.3.0",
+  "flake8-docstrings == 1.7.0",
+  "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
+  "pydoclint == 0.6.10",
+  "pydocstyle == 6.3.0",
+]
+dev-formatting = ["black == 25.9.0", "isort == 6.1.0"]
+dev-mkdocs = [
+  "Markdown == 3.9",
+  "black == 25.9.0",
+  "mike == 2.1.3",
+  "mkdocs-gen-files == 0.5.0",
+  "mkdocs-literate-nav == 0.6.2",
+  "mkdocs-macros-plugin == 1.4.0",
+  "mkdocs-material == 9.6.17",
+  "mkdocstrings[python] == 0.30.0",
+  "mkdocstrings-python == 1.18.2",
+  "frequenz-repo-config[lib] == 0.13.5",
+]
+dev-mypy = [
+  "mypy == 1.18.2",
+  "grpc-stubs == 1.53.0.6",
+  "types-Markdown == 3.9.0.20250906",
+  "types-protobuf == 6.32.1.20250918",
+  # For checking the noxfile, docs/ script, and tests
+  "frequenz-client-assets[dev-mkdocs,dev-noxfile,dev-pytest,cli]",
+]
+dev-noxfile = ["nox == 2025.5.1", "frequenz-repo-config[lib] == 0.13.5"]
+dev-pylint = [
+  # dev-pytest already defines a dependency to pylint because of the examples
+  # For checking the noxfile, docs/ script, and tests
+  "frequenz-client-assets[dev-mkdocs,dev-noxfile,dev-pytest,cli]",
+]
+dev-pytest = [
+  "pytest == 8.4.1",
+  "pylint == 3.3.8", # We need this to check for the examples
+  "frequenz-repo-config[extra-lint-examples] == 0.13.5",
+  "pytest-mock == 3.15.1",
+  "pytest-asyncio == 1.1.0",
+  "async-solipsism == 0.8",
+]
+dev = [
+  "frequenz-client-assets[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
+]
+
+[project.urls]
+Documentation = "https://frequenz-floss.github.io/frequenz-client-assets-python/"
+Changelog = "https://github.com/frequenz-floss/frequenz-client-assets-python/releases"
+Issues = "https://github.com/frequenz-floss/frequenz-client-assets-python/issues"
+Repository = "https://github.com/frequenz-floss/frequenz-client-assets-python"
+Support = "https://github.com/frequenz-floss/frequenz-client-assets-python/discussions/categories/support"
+
+[tool.black]
+line-length = 88
+target-version = ['py311']
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+line_length = 88
+src_paths = ["benchmarks", "examples", "src", "tests"]
+
+[tool.flake8]
+# We give some flexibility to go over 88, there are cases like long URLs or
+# code in documentation that have extra indentation. Black will still take care
+# of making everything that can be 88 wide, 88 wide.
+max-line-length = 100
+extend-ignore = [
+  "E203", # Whitespace before ':' (conflicts with black)
+  "W503", # Line break before binary operator (conflicts with black)
+]
+# pydoclint options
+style = "google"
+check-return-types = false
+check-yield-types = false
+arg-type-hints-in-docstring = false
+arg-type-hints-in-signature = true
+allow-init-docstring = true
+
+[tool.pylint.similarities]
+ignore-comments = ['yes']
+ignore-docstrings = ['yes']
+ignore-imports = ['no']
+min-similarity-lines = 40
+
+[tool.pylint.messages_control]
+disable = [
+  "too-few-public-methods",
+  "too-many-return-statements",
+  # disabled because it conflicts with isort
+  "wrong-import-order",
+  "ungrouped-imports",
+  # 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",
+  "possibly-used-before-assignment",
+  "no-name-in-module",
+  # Checked by flake8
+  "f-string-without-interpolation",
+  "line-too-long",
+  "missing-function-docstring",
+  "redefined-outer-name",
+  "unnecessary-lambda-assignment",
+  "unused-import",
+  "unused-variable",
+]
+
+[tool.pytest.ini_options]
+addopts = "-vv"
+filterwarnings = [
+  "error",
+  "once::DeprecationWarning",
+  "once::PendingDeprecationWarning",
+  # We use a raw string (single quote) to avoid the need to escape special
+  # chars as this is a regex
+  'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning',
+]
+testpaths = ["tests", "src"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+required_plugins = ["pytest-asyncio", "pytest-mock"]
+
+[tool.mypy]
+explicit_package_bases = true
+namespace_packages = true
+# This option disables mypy cache, and it is sometimes useful to enable it if
+# you are getting weird intermittent error, or error in the CI but not locally
+# (or vice versa). In particular errors saying that type: ignore is not
+# used but getting the original ignored error when removing the type: ignore.
+# See for example: https://github.com/python/mypy/issues/2960
+#no_incremental = true
+packages = ["frequenz.client.assets"]
+strict = true
+
+[[tool.mypy.overrides]]
+module = ["mkdocs_macros.*", "sybil", "sybil.*"]
+ignore_missing_imports = true
+
+[tool.setuptools_scm]
+version_scheme = "post-release"

frequenz_client_assets-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

frequenz_client_assets-0.0.2/src/frequenz/client/assets/__init__.py

@@ -0,0 +1,18 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Assets API client."""
+
+from ._client import AssetsApiClient
+from ._delivery_area import DeliveryArea, EnergyMarketCodeType
+from ._location import Location
+from ._microgrid import Microgrid, MicrogridStatus
+
+__all__ = [
+    "AssetsApiClient",
+    "DeliveryArea",
+    "EnergyMarketCodeType",
+    "Microgrid",
+    "MicrogridStatus",
+    "Location",
+]

frequenz_client_assets-0.0.2/src/frequenz/client/assets/_client.py

@@ -0,0 +1,140 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""
+Assets API client.
+
+This module provides a client for the Assets API.
+"""
+
+from __future__ import annotations
+
+from frequenz.api.assets.v1 import assets_pb2, assets_pb2_grpc
+from frequenz.client.base import channel
+from frequenz.client.base.client import BaseApiClient, call_stub_method
+
+from frequenz.client.assets.electrical_component._electrical_component import (
+    ElectricalComponent,
+)
+
+from ._microgrid import Microgrid
+from ._microgrid_proto import microgrid_from_proto
+from .electrical_component._electrical_component_proto import electrical_component_proto
+from .exceptions import ClientNotConnected
+
+DEFAULT_GRPC_CALL_TIMEOUT = 60.0
+"""The default timeout for gRPC calls made by this client (in seconds)."""
+
+
+class AssetsApiClient(
+    BaseApiClient[assets_pb2_grpc.PlatformAssetsStub]
+):  # pylint: disable=too-many-arguments
+    """A client for the Assets API."""
+
+    def __init__(
+        self,
+        server_url: str,
+        *,
+        auth_key: str | None = None,
+        sign_secret: str | None = None,
+        channel_defaults: channel.ChannelOptions = channel.ChannelOptions(),
+        connect: bool = True,
+    ) -> None:
+        """
+        Initialize the AssetsApiClient.
+
+        Args:
+            server_url: The location of the microgrid API server in the form of a URL.
+                The following format is expected:
+                "grpc://hostname{:`port`}{?ssl=`ssl`}",
+                where the `port` should be an int between 0 and 65535 (defaulting to
+                9090) and `ssl` should be a boolean (defaulting to `true`).
+                For example: `grpc://localhost:1090?ssl=true`.
+            auth_key: The authentication key to use for the connection.
+            sign_secret: The secret to use for signing requests.
+            channel_defaults: The default options use to create the channel when not
+                specified in the URL.
+            connect: Whether to connect to the server as soon as a client instance is
+                created. If `False`, the client will not connect to the server until
+                [connect()][frequenz.client.base.client.BaseApiClient.connect] is
+                called.
+        """
+        super().__init__(
+            server_url,
+            assets_pb2_grpc.PlatformAssetsStub,
+            connect=connect,
+            channel_defaults=channel_defaults,
+            auth_key=auth_key,
+            sign_secret=sign_secret,
+        )
+
+    @property
+    def stub(self) -> assets_pb2_grpc.PlatformAssetsAsyncStub:
+        """
+        The gRPC stub for the Assets API.
+
+        Returns:
+            The gRPC stub for the Assets API.
+
+        Raises:
+            ClientNotConnected: If the client is not connected to the server.
+        """
+        if self._channel is None or self._stub is None:
+            raise ClientNotConnected(server_url=self.server_url, operation="stub")
+        # This type: ignore is needed because the stub is a sync stub, but we need to
+        # use the async stub, so we cast the sync stub to the async stub.
+        return self._stub  # type: ignore
+
+    async def get_microgrid(  # noqa: DOC502 (raises ApiClientError indirectly)
+        self, microgrid_id: int
+    ) -> Microgrid:
+        """
+        Get the details of a microgrid.
+
+        Args:
+            microgrid_id: The ID of the microgrid to get the details of.
+
+        Returns:
+            The details of the microgrid.
+
+        Raises:
+            ApiClientError: If there are any errors communicating with the Assets API,
+                most likely a subclass of [GrpcError][frequenz.client.base.exception.GrpcError].
+        """
+        response = await call_stub_method(
+            self,
+            lambda: self.stub.GetMicrogrid(
+                assets_pb2.GetMicrogridRequest(microgrid_id=microgrid_id),
+                timeout=DEFAULT_GRPC_CALL_TIMEOUT,
+            ),
+            method_name="GetMicrogrid",
+        )
+
+        return microgrid_from_proto(response.microgrid)
+
+    async def list_microgrid_electrical_components(
+        self, microgrid_id: int
+    ) -> list[ElectricalComponent]:
+        """
+        Get the electrical components of a microgrid.
+
+        Args:
+            microgrid_id: The ID of the microgrid to get the electrical components of.
+
+        Returns:
+            The electrical components of the microgrid.
+        """
+        response = await call_stub_method(
+            self,
+            lambda: self.stub.ListMicrogridElectricalComponents(
+                assets_pb2.ListMicrogridElectricalComponentsRequest(
+                    microgrid_id=microgrid_id,
+                ),
+                timeout=DEFAULT_GRPC_CALL_TIMEOUT,
+            ),
+            method_name="ListMicrogridElectricalComponents",
+        )
+
+        return [
+            electrical_component_proto(component) for component in response.components
+        ]

frequenz_client_assets-0.0.2/src/frequenz/client/assets/_delivery_area.py

@@ -0,0 +1,89 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Delivery area information for the energy market."""
+
+import enum
+from dataclasses import dataclass
+
+from frequenz.api.common.v1alpha8.grid import delivery_area_pb2
+
+
+@enum.unique
+class EnergyMarketCodeType(enum.Enum):
+    """The identification code types used in the energy market.
+
+    CodeType specifies the type of identification code used for uniquely
+    identifying various entities such as delivery areas, market participants,
+    and grid components within the energy market.
+
+    This enumeration aims to
+    offer compatibility across different jurisdictional standards.
+
+    Note: Understanding Code Types
+        Different regions or countries may have their own standards for uniquely
+        identifying various entities within the energy market. For example, in
+        Europe, the Energy Identification Code (EIC) is commonly used for this
+        purpose.
+
+    Note: Extensibility
+        New code types can be added to this enum to accommodate additional regional
+        standards, enhancing the API's adaptability.
+
+    Danger: Validation Required
+        The chosen code type should correspond correctly with the `code` field in
+        the relevant message objects, such as `DeliveryArea` or `Counterparty`.
+        Failure to match the code type with the correct code could lead to
+        processing errors.
+    """
+
+    UNSPECIFIED = delivery_area_pb2.ENERGY_MARKET_CODE_TYPE_UNSPECIFIED
+    """Unspecified type. This value is a placeholder and should not be used."""
+
+    EUROPE_EIC = delivery_area_pb2.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC
+    """European Energy Identification Code Standard."""
+
+    US_NERC = delivery_area_pb2.ENERGY_MARKET_CODE_TYPE_US_NERC
+    """North American Electric Reliability Corporation identifiers."""
+
+
+@dataclass(frozen=True, kw_only=True)
+class DeliveryArea:
+    """A geographical or administrative region where electricity deliveries occur.
+
+    DeliveryArea represents the geographical or administrative region, usually defined
+    and maintained by a Transmission System Operator (TSO), where electricity deliveries
+    for a contract occur.
+
+    The concept is important to energy trading as it delineates the agreed-upon delivery
+    location. Delivery areas can have different codes based on the jurisdiction in
+    which they operate.
+
+    Note: Jurisdictional Differences
+        This is typically represented by specific codes according to local jurisdiction.
+
+        In Europe, this is represented by an
+        [EIC](https://en.wikipedia.org/wiki/Energy_Identification_Code) (Energy
+        Identification Code). [List of
+        EICs](https://www.entsoe.eu/data/energy-identification-codes-eic/eic-approved-codes/).
+    """
+
+    code: str | None
+    """The code representing the unique identifier for the delivery area."""
+
+    code_type: EnergyMarketCodeType | int
+    """Type of code used for identifying the delivery area itself.
+
+    This code could be extended in the future, in case an unknown code type is
+    encountered, a plain integer value is used to represent it.
+    """
+
+    def __str__(self) -> str:
+        """Return a human-readable string representation of this instance."""
+        code = self.code or "<NO CODE>"
+        code_type = (
+            f"type={self.code_type}"
+            if isinstance(self.code_type, int)
+            else self.code_type.name
+        )
+        return f"{code}[{code_type}]"

frequenz_client_assets-0.0.2/src/frequenz/client/assets/_delivery_area_proto.py

@@ -0,0 +1,44 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Loading of DeliveryArea objects from protobuf messages."""
+
+import logging
+
+from frequenz.api.common.v1alpha8.grid import delivery_area_pb2
+from frequenz.client.common import enum_proto
+
+from ._delivery_area import DeliveryArea, EnergyMarketCodeType
+
+_logger = logging.getLogger(__name__)
+
+
+def delivery_area_from_proto(message: delivery_area_pb2.DeliveryArea) -> DeliveryArea:
+    """Convert a protobuf delivery area message to a delivery area object.
+
+    Args:
+        message: The protobuf message to convert.
+
+    Returns:
+        The resulting delivery area object.
+    """
+    issues: list[str] = []
+
+    code = message.code or None
+    if code is None:
+        issues.append("code is empty")
+
+    code_type = enum_proto.enum_from_proto(message.code_type, EnergyMarketCodeType)
+    if code_type is EnergyMarketCodeType.UNSPECIFIED:
+        issues.append("code_type is unspecified")
+    elif isinstance(code_type, int):
+        issues.append("code_type is unrecognized")
+
+    if issues:
+        _logger.warning(
+            "Found issues in delivery area: %s | Protobuf message:\n%s",
+            ", ".join(issues),
+            message,
+        )
+
+    return DeliveryArea(code=code, code_type=code_type)