frequenz-client-common 0.3.0__tar.gz → 0.3.2__tar.gz

{frequenz_client_common-0.3.0/src/frequenz_client_common.egg-info → frequenz_client_common-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: frequenz-client-common
-Version: 0.3.0
+Version: 0.3.2
 Summary: Common code and utilities for Frequenz API clients
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -20,46 +20,48 @@ Classifier: Typing :: Typed
 Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: typing-extensions<5,>=4.5.0
+Requires-Dist: typing-extensions<5,>=4.13.0
 Requires-Dist: frequenz-api-common<7,>=0.6.0
+Requires-Dist: frequenz-core<2,>=1.0.0
 Provides-Extra: dev-flake8
-Requires-Dist: flake8==7.1.1; extra == "dev-flake8"
+Requires-Dist: flake8==7.2.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.5.9; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.6.6; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
-Requires-Dist: black==24.10.0; extra == "dev-formatting"
-Requires-Dist: isort==5.13.2; extra == "dev-formatting"
+Requires-Dist: black==25.1.0; extra == "dev-formatting"
+Requires-Dist: isort==6.0.1; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
-Requires-Dist: black==24.10.0; extra == "dev-mkdocs"
-Requires-Dist: Markdown==3.7; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.8; extra == "dev-mkdocs"
+Requires-Dist: black==25.1.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.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.5.47; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.27.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.12.2; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.11.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.12; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.29.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.16.10; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.3; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.13.0; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.7.0.20241204; extra == "dev-mypy"
+Requires-Dist: mypy==1.15.0; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.8.0.20250415; extra == "dev-mypy"
 Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2024.10.9; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.11.0; extra == "dev-noxfile"
+Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.3; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.2; extra == "dev-pylint"
+Requires-Dist: pylint==3.3.6; extra == "dev-pylint"
 Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.3.4; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.11.0; extra == "dev-pytest"
+Requires-Dist: pytest==8.3.5; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.3; extra == "dev-pytest"
 Requires-Dist: pytest-mock==3.14.0; extra == "dev-pytest"
-Requires-Dist: pytest-asyncio==0.24.0; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==0.26.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.7; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
 
 # Frequenz Client Common Library
 

frequenz_client_common-0.3.2/RELEASE_NOTES.md

@@ -0,0 +1,19 @@
+# Frequenz Client Common Library Release Notes
+
+## Summary
+
+This release replaces the failed v0.3.1 release.
+
+## Upgrading
+
+- The `typing-extensions` dependency minimum version was bumped to 4.13 to support Python 3.12.
+
+## New Features
+
+- New `BaseId` class to create unique IDs for entities in the system.
+- New ID classes for microgrid-related entities:
+
+   * `EnterpriseId`
+   * `MicrogridId`
+   * `ComponentId`
+   * `SensorId`

{frequenz_client_common-0.3.0 → frequenz_client_common-0.3.2}/pyproject.toml

@@ -3,9 +3,9 @@
 
 [build-system]
 requires = [
-  "setuptools == 75.6.0",
-  "setuptools_scm[toml] == 8.1.0",
-  "frequenz-repo-config[lib] == 0.11.0",
+  "setuptools == 80.3.1",
+  "setuptools_scm[toml] == 8.3.1",
+  "frequenz-repo-config[lib] == 0.13.3",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -26,8 +26,9 @@ classifiers = [
 ]
 requires-python = ">= 3.11, < 4"
 dependencies = [
-  "typing-extensions >= 4.5.0, < 5",
+  "typing-extensions >= 4.13.0, < 5",
   "frequenz-api-common >= 0.6.0, < 7",
+  "frequenz-core >= 1.0.0, < 2",
 ]
 dynamic = ["version"]
 
@@ -37,45 +38,42 @@ email = "floss@frequenz.com"
 
 [project.optional-dependencies]
 dev-flake8 = [
-  "flake8 == 7.1.1",
+  "flake8 == 7.2.0",
   "flake8-docstrings == 1.7.0",
-  "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.5.9",
+  "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
+  "pydoclint == 0.6.6",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 24.10.0", "isort == 5.13.2"]
+dev-formatting = ["black == 25.1.0", "isort == 6.0.1"]
 dev-mkdocs = [
-  "black == 24.10.0",
-  "Markdown==3.7",
+  "Markdown == 3.8",
+  "black == 25.1.0",
   "mike == 2.1.3",
   "mkdocs-gen-files == 0.5.0",
-  "mkdocs-literate-nav == 0.6.1",
+  "mkdocs-literate-nav == 0.6.2",
   "mkdocs-macros-plugin == 1.3.7",
-  "mkdocs-material == 9.5.47",
-  "mkdocstrings[python] == 0.27.0",
-  "mkdocstrings-python == 1.12.2",
-  "frequenz-repo-config[lib] == 0.11.0",
+  "mkdocs-material == 9.6.12",
+  "mkdocstrings[python] == 0.29.1",
+  "mkdocstrings-python == 1.16.10",
+  "frequenz-repo-config[lib] == 0.13.3",
 ]
 dev-mypy = [
-  "mypy == 1.13.0",
-  "types-Markdown == 3.7.0.20241204",
+  "mypy == 1.15.0",
+  "types-Markdown == 3.8.0.20250415",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
-dev-noxfile = [
-  "nox == 2024.10.9",
-  "frequenz-repo-config[lib] == 0.11.0",
-]
+dev-noxfile = ["nox == 2025.5.1", "frequenz-repo-config[lib] == 0.13.3"]
 dev-pylint = [
-  "pylint == 3.3.2",
+  "pylint == 3.3.6",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.3.4",
-  "frequenz-repo-config[extra-lint-examples] == 0.11.0",
+  "pytest == 8.3.5",
+  "frequenz-repo-config[extra-lint-examples] == 0.13.3",
   "pytest-mock == 3.14.0",
-  "pytest-asyncio == 0.24.0",
+  "pytest-asyncio == 0.26.0",
   "async-solipsism == 0.7",
 ]
 dev = [
@@ -147,6 +145,18 @@ disable = [
 ]
 
 [tool.pytest.ini_options]
+addopts = "-vv"
+filterwarnings = [
+  "error",
+  "once::DeprecationWarning",
+  "once::PendingDeprecationWarning",
+  # We ignore warnings about protobuf gencode version being one version older
+  # than the current version, as this is supported by protobuf, and we expect to
+  # have such cases. If we go too far, we will get a proper error anyways.
+  # We use a raw string (single quotes) to avoid the need to escape special
+  # characters 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"

frequenz_client_common-0.3.2/src/frequenz/client/common/microgrid/__init__.py

@@ -0,0 +1,18 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Frequenz microgrid definition."""
+
+from typing import final
+
+from frequenz.core.id import BaseId
+
+
+@final
+class EnterpriseId(BaseId, str_prefix="EID"):
+    """A unique identifier for an enterprise account."""
+
+
+@final
+class MicrogridId(BaseId, str_prefix="MID"):
+    """A unique identifier for a microgrid."""

{frequenz_client_common-0.3.0 → frequenz_client_common-0.3.2}/src/frequenz/client/common/microgrid/components/__init__.py

@@ -2,9 +2,11 @@
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
 """Defines the components that can be used in a microgrid."""
+
 from __future__ import annotations
 
 from enum import Enum
+from typing import final
 
 # pylint: disable=no-name-in-module
 from frequenz.api.common.v1.microgrid.components.components_pb2 import (
@@ -16,10 +18,16 @@ from frequenz.api.common.v1.microgrid.components.components_pb2 import (
 from frequenz.api.common.v1.microgrid.components.components_pb2 import (
     ComponentStateCode as PBComponentStateCode,
 )
+from frequenz.core.id import BaseId
 
 # pylint: enable=no-name-in-module
 
 
+@final
+class ComponentId(BaseId, str_prefix="CID"):
+    """A unique identifier for a microgrid component."""
+
+
 class ComponentCategory(Enum):
     """Possible types of microgrid component."""
 

frequenz_client_common-0.3.2/src/frequenz/client/common/microgrid/sensors.py

@@ -0,0 +1,13 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Microgrid sensors."""
+
+from typing import final
+
+from frequenz.core.id import BaseId
+
+
+@final
+class SensorId(BaseId, str_prefix="SID"):
+    """A unique identifier for a microgrid sensor."""

{frequenz_client_common-0.3.0 → frequenz_client_common-0.3.2/src/frequenz_client_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: frequenz-client-common
-Version: 0.3.0
+Version: 0.3.2
 Summary: Common code and utilities for Frequenz API clients
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -20,46 +20,48 @@ Classifier: Typing :: Typed
 Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: typing-extensions<5,>=4.5.0
+Requires-Dist: typing-extensions<5,>=4.13.0
 Requires-Dist: frequenz-api-common<7,>=0.6.0
+Requires-Dist: frequenz-core<2,>=1.0.0
 Provides-Extra: dev-flake8
-Requires-Dist: flake8==7.1.1; extra == "dev-flake8"
+Requires-Dist: flake8==7.2.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.5.9; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.6.6; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
-Requires-Dist: black==24.10.0; extra == "dev-formatting"
-Requires-Dist: isort==5.13.2; extra == "dev-formatting"
+Requires-Dist: black==25.1.0; extra == "dev-formatting"
+Requires-Dist: isort==6.0.1; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
-Requires-Dist: black==24.10.0; extra == "dev-mkdocs"
-Requires-Dist: Markdown==3.7; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.8; extra == "dev-mkdocs"
+Requires-Dist: black==25.1.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.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.5.47; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.27.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.12.2; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.11.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.12; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.29.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.16.10; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.3; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.13.0; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.7.0.20241204; extra == "dev-mypy"
+Requires-Dist: mypy==1.15.0; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.8.0.20250415; extra == "dev-mypy"
 Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2024.10.9; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.11.0; extra == "dev-noxfile"
+Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.3; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.2; extra == "dev-pylint"
+Requires-Dist: pylint==3.3.6; extra == "dev-pylint"
 Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.3.4; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.11.0; extra == "dev-pytest"
+Requires-Dist: pytest==8.3.5; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.3; extra == "dev-pytest"
 Requires-Dist: pytest-mock==3.14.0; extra == "dev-pytest"
-Requires-Dist: pytest-asyncio==0.24.0; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==0.26.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.7; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
 
 # Frequenz Client Common Library
 

{frequenz_client_common-0.3.0 → frequenz_client_common-0.3.2}/src/frequenz_client_common.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ src/frequenz/client/common/conftest.py
 src/frequenz/client/common/py.typed
 src/frequenz/client/common/metric/__init__.py
 src/frequenz/client/common/microgrid/__init__.py
+src/frequenz/client/common/microgrid/sensors.py
 src/frequenz/client/common/microgrid/components/__init__.py
 src/frequenz/client/common/pagination/__init__.py
 src/frequenz_client_common.egg-info/PKG-INFO

{frequenz_client_common-0.3.0 → frequenz_client_common-0.3.2}/src/frequenz_client_common.egg-info/requires.txt

@@ -1,48 +1,49 @@
-typing-extensions<5,>=4.5.0
+typing-extensions<5,>=4.13.0
 frequenz-api-common<7,>=0.6.0
+frequenz-core<2,>=1.0.0
 
 [dev]
 frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
 
 [dev-flake8]
-flake8==7.1.1
+flake8==7.2.0
 flake8-docstrings==1.7.0
 flake8-pyproject==1.2.3
-pydoclint==0.5.9
+pydoclint==0.6.6
 pydocstyle==6.3.0
 
 [dev-formatting]
-black==24.10.0
-isort==5.13.2
+black==25.1.0
+isort==6.0.1
 
 [dev-mkdocs]
-black==24.10.0
-Markdown==3.7
+Markdown==3.8
+black==25.1.0
 mike==2.1.3
 mkdocs-gen-files==0.5.0
-mkdocs-literate-nav==0.6.1
+mkdocs-literate-nav==0.6.2
 mkdocs-macros-plugin==1.3.7
-mkdocs-material==9.5.47
-mkdocstrings[python]==0.27.0
-mkdocstrings-python==1.12.2
-frequenz-repo-config[lib]==0.11.0
+mkdocs-material==9.6.12
+mkdocstrings[python]==0.29.1
+mkdocstrings-python==1.16.10
+frequenz-repo-config[lib]==0.13.3
 
 [dev-mypy]
-mypy==1.13.0
-types-Markdown==3.7.0.20241204
+mypy==1.15.0
+types-Markdown==3.8.0.20250415
 frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-nox==2024.10.9
-frequenz-repo-config[lib]==0.11.0
+nox==2025.5.1
+frequenz-repo-config[lib]==0.13.3
 
 [dev-pylint]
-pylint==3.3.2
+pylint==3.3.6
 frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.3.4
-frequenz-repo-config[extra-lint-examples]==0.11.0
+pytest==8.3.5
+frequenz-repo-config[extra-lint-examples]==0.13.3
 pytest-mock==3.14.0
-pytest-asyncio==0.24.0
+pytest-asyncio==0.26.0
 async-solipsism==0.7

frequenz_client_common-0.3.0/RELEASE_NOTES.md

@@ -1,19 +0,0 @@
-# Frequenz Client Common Library Release Notes
-
-## Summary
-
-Update of the Pagination `Params` data class.
-
-## Upgrading
-
-* Pagination `Params` has been changed such that the `page_size` and `page_token` fields are now no longer optional.
-
-## New Features
-
-* Additional information for energy metric.
-* Add component state codes.
-* Add component error codes.
-
-## Bug Fixes
-
-<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

frequenz_client_common-0.3.0/src/frequenz/client/common/microgrid/__init__.py

@@ -1,4 +0,0 @@
-# License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
-
-"""Frequenz microgrid definition."""