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

{frequenz-client-common-0.2.0/src/frequenz_client_common.egg-info → frequenz_client_common-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-client-common
-Version: 0.2.0
+Version: 0.3.0
 Summary: Common code and utilities for Frequenz API clients
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -19,15 +19,47 @@ 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.5.0
+Requires-Dist: frequenz-api-common<7,>=0.6.0
 Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.1.1; 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: 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"
 Provides-Extra: dev-mkdocs
+Requires-Dist: black==24.10.0; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.7; 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-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"
 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: 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"
 Provides-Extra: dev-pylint
+Requires-Dist: pylint==3.3.2; 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-mock==3.14.0; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==0.24.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.7; extra == "dev-pytest"
 Provides-Extra: dev
-License-File: LICENSE
+Requires-Dist: frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 
 # Frequenz Client Common Library
 

frequenz_client_common-0.3.0/RELEASE_NOTES.md

@@ -0,0 +1,19 @@
+# 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.2.0 → frequenz_client_common-0.3.0}/pyproject.toml

@@ -3,9 +3,9 @@
 
 [build-system]
 requires = [
-  "setuptools == 68.1.0",
-  "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[lib] == 0.9.1",
+  "setuptools == 75.6.0",
+  "setuptools_scm[toml] == 8.1.0",
+  "frequenz-repo-config[lib] == 0.11.0",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -37,45 +37,46 @@ 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.9",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 24.4.2", "isort == 5.13.2"]
+dev-formatting = ["black == 24.10.0", "isort == 5.13.2"]
 dev-mkdocs = [
-  "black == 24.4.2",
-  "Markdown==3.6",
-  "mike == 2.0.0",
+  "black == 24.10.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.1",
+  "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",
 ]
 dev-mypy = [
-  "mypy == 1.10.0",
-  "types-Markdown == 3.6.0.20240316",
+  "mypy == 1.13.0",
+  "types-Markdown == 3.7.0.20241204",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
-  "nox == 2024.4.15",
-  "frequenz-repo-config[lib] == 0.9.1",
+  "nox == 2024.10.9",
+  "frequenz-repo-config[lib] == 0.11.0",
 ]
 dev-pylint = [
-  "pylint == 3.1.0",
+  "pylint == 3.3.2",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.2.0",
-  "frequenz-repo-config[extra-lint-examples] == 0.9.1",
+  "pytest == 8.3.4",
+  "frequenz-repo-config[extra-lint-examples] == 0.11.0",
   "pytest-mock == 3.14.0",
-  "pytest-asyncio == 0.23.6",
-  "async-solipsism == 0.6",
+  "pytest-asyncio == 0.24.0",
+  "async-solipsism == 0.7",
 ]
 dev = [
   "frequenz-client-common[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
@@ -131,10 +132,16 @@ 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",
+  "possibly-used-before-assignment",
+  "no-name-in-module",
   # Checked by flake8
+  "f-string-without-interpolation",
   "redefined-outer-name",
   "unused-import",
   "line-too-long",
+  "missing-function-docstring",
   "unused-variable",
   "unnecessary-lambda-assignment",
 ]
@@ -142,6 +149,7 @@ disable = [
 [tool.pytest.ini_options]
 testpaths = ["tests", "src"]
 asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 required_plugins = ["pytest-asyncio", "pytest-mock"]
 
 [tool.mypy]

{frequenz-client-common-0.2.0 → frequenz_client_common-0.3.0}/src/frequenz/client/common/metric/__init__.py

@@ -13,7 +13,18 @@ from frequenz.api.common.v1.metrics.metric_sample_pb2 import Metric as PBMetric
 
 
 class Metric(Enum):
-    """List of supported metrics."""
+    """List of supported metrics.
+
+    AC energy metrics information:
+    * This energy metric is reported directly from the component, and not a
+    result of aggregations in our systems. If a component does not have this
+    metric, this field cannot be populated.
+    * Components that provide energy metrics reset this metric from time to
+    time. This behaviour is specific to each component model. E.g., some
+    components reset it on UTC 00:00:00.
+    * This energy metric does not specify the timestamp since when the energy
+    was being accumulated, and therefore can be inconsistent.
+    """
 
     # Default value
     UNSPECIFIED = PBMetric.METRIC_UNSPECIFIED
@@ -57,7 +68,7 @@ class Metric(Enum):
     AC_POWER_FACTOR_PHASE_2 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_2
     AC_POWER_FACTOR_PHASE_3 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_3
 
-    # AC energy metrics
+    # AC energy metrics - Please be careful when using and check Enum docs
     AC_APPARENT_ENERGY = PBMetric.METRIC_AC_APPARENT_ENERGY
     AC_APPARENT_ENERGY_PHASE_1 = PBMetric.METRIC_AC_APPARENT_ENERGY_PHASE_1
     AC_APPARENT_ENERGY_PHASE_2 = PBMetric.METRIC_AC_APPARENT_ENERGY_PHASE_2

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

@@ -0,0 +1,354 @@
+# License: MIT
+# 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
+
+# pylint: disable=no-name-in-module
+from frequenz.api.common.v1.microgrid.components.components_pb2 import (
+    ComponentCategory as PBComponentCategory,
+)
+from frequenz.api.common.v1.microgrid.components.components_pb2 import (
+    ComponentErrorCode as PBComponentErrorCode,
+)
+from frequenz.api.common.v1.microgrid.components.components_pb2 import (
+    ComponentStateCode as PBComponentStateCode,
+)
+
+# pylint: enable=no-name-in-module
+
+
+class ComponentCategory(Enum):
+    """Possible types of microgrid component."""
+
+    UNSPECIFIED = PBComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
+    """An unknown component category.
+
+    Useful for error handling, and marking unknown components in
+    a list of components with otherwise known categories.
+    """
+
+    GRID = PBComponentCategory.COMPONENT_CATEGORY_GRID
+    """The point where the local microgrid is connected to the grid."""
+
+    METER = PBComponentCategory.COMPONENT_CATEGORY_METER
+    """A meter, for measuring electrical metrics, e.g., current, voltage, etc."""
+
+    INVERTER = PBComponentCategory.COMPONENT_CATEGORY_INVERTER
+    """An electricity generator, with batteries or solar energy."""
+
+    BATTERY = PBComponentCategory.COMPONENT_CATEGORY_BATTERY
+    """A storage system for electrical energy, used by inverters."""
+
+    EV_CHARGER = PBComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
+    """A station for charging electrical vehicles."""
+
+    CHP = PBComponentCategory.COMPONENT_CATEGORY_CHP
+    """A heat and power combustion plant (CHP stands for combined heat and power)."""
+
+    @classmethod
+    def from_proto(
+        cls, component_category: PBComponentCategory.ValueType
+    ) -> ComponentCategory:
+        """Convert a protobuf ComponentCategory message to ComponentCategory enum.
+
+        Args:
+            component_category: protobuf enum to convert
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(t.value == component_category for t in ComponentCategory):
+            return ComponentCategory.UNSPECIFIED
+        return cls(component_category)
+
+    def to_proto(self) -> PBComponentCategory.ValueType:
+        """Convert a ComponentCategory enum to protobuf ComponentCategory message.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        return self.value
+
+
+class ComponentStateCode(Enum):
+    """All possible states of a microgrid component."""
+
+    UNSPECIFIED = PBComponentStateCode.COMPONENT_STATE_CODE_UNSPECIFIED
+    """Default value when the component state is not explicitly set."""
+
+    UNKNOWN = PBComponentStateCode.COMPONENT_STATE_CODE_UNKNOWN
+    """State when the component is in an unknown or undefined condition.
+
+    This is used when the sender is unable to classify the component into any
+    other state.
+    """
+    SWITCHING_OFF = PBComponentStateCode.COMPONENT_STATE_CODE_SWITCHING_OFF
+    """State when the component is in the process of switching off."""
+
+    OFF = PBComponentStateCode.COMPONENT_STATE_CODE_OFF
+    """State when the component has successfully switched off."""
+
+    SWITCHING_ON = PBComponentStateCode.COMPONENT_STATE_CODE_SWITCHING_ON
+    """State when the component is in the process of switching on from an off state."""
+
+    STANDBY = PBComponentStateCode.COMPONENT_STATE_CODE_STANDBY
+    """State when the component is in standby mode, and not immediately ready for operation."""
+
+    READY = PBComponentStateCode.COMPONENT_STATE_CODE_READY
+    """State when the component is fully operational and ready for use."""
+
+    CHARGING = PBComponentStateCode.COMPONENT_STATE_CODE_CHARGING
+    """State when the component is actively consuming energy."""
+
+    DISCHARGING = PBComponentStateCode.COMPONENT_STATE_CODE_DISCHARGING
+    """State when the component is actively producing or releasing energy."""
+
+    ERROR = PBComponentStateCode.COMPONENT_STATE_CODE_ERROR
+    """State when the component is in an error state and may need attention."""
+
+    EV_CHARGING_CABLE_UNPLUGGED = (
+        PBComponentStateCode.COMPONENT_STATE_CODE_EV_CHARGING_CABLE_UNPLUGGED
+    )
+    """The Electric Vehicle (EV) charging cable is unplugged from the charging station."""
+
+    EV_CHARGING_CABLE_PLUGGED_AT_STATION = (
+        PBComponentStateCode.COMPONENT_STATE_CODE_EV_CHARGING_CABLE_PLUGGED_AT_STATION
+    )
+    """The EV charging cable is plugged into the charging station."""
+
+    EV_CHARGING_CABLE_PLUGGED_AT_EV = (
+        PBComponentStateCode.COMPONENT_STATE_CODE_EV_CHARGING_CABLE_PLUGGED_AT_EV
+    )
+    """The EV charging cable is plugged into the vehicle."""
+
+    EV_CHARGING_CABLE_LOCKED_AT_STATION = (
+        PBComponentStateCode.COMPONENT_STATE_CODE_EV_CHARGING_CABLE_LOCKED_AT_STATION
+    )
+    """The EV charging cable is locked at the charging station end, indicating
+    readiness for charging."""
+
+    EV_CHARGING_CABLE_LOCKED_AT_EV = (
+        PBComponentStateCode.COMPONENT_STATE_CODE_EV_CHARGING_CABLE_LOCKED_AT_EV
+    )
+    """The EV charging cable is locked at the vehicle end, indicating that charging is active."""
+
+    RELAY_OPEN = PBComponentStateCode.COMPONENT_STATE_CODE_RELAY_OPEN
+    """The relay is in an open state, meaning no current can flow through."""
+
+    RELAY_CLOSED = PBComponentStateCode.COMPONENT_STATE_CODE_RELAY_CLOSED
+    """The relay is in a closed state, allowing current to flow."""
+
+    PRECHARGER_OPEN = PBComponentStateCode.COMPONENT_STATE_CODE_PRECHARGER_OPEN
+    """The precharger circuit is open, meaning it's not currently active."""
+
+    PRECHARGER_PRECHARGING = (
+        PBComponentStateCode.COMPONENT_STATE_CODE_PRECHARGER_PRECHARGING
+    )
+    """The precharger is in a precharging state, preparing the main circuit for activation."""
+
+    PRECHARGER_CLOSED = PBComponentStateCode.COMPONENT_STATE_CODE_PRECHARGER_CLOSED
+    """The precharger circuit is closed, allowing full current to flow to the main circuit."""
+
+    @classmethod
+    def from_proto(
+        cls, component_state: PBComponentStateCode.ValueType
+    ) -> ComponentStateCode:
+        """Convert a protobuf ComponentStateCode message to ComponentStateCode enum.
+
+        Args:
+            component_state: protobuf enum to convert
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(c.value == component_state for c in ComponentStateCode):
+            return ComponentStateCode.UNSPECIFIED
+        return cls(component_state)
+
+    def to_proto(self) -> PBComponentStateCode.ValueType:
+        """Convert a ComponentStateCode enum to protobuf ComponentStateCode message.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        return self.value
+
+
+class ComponentErrorCode(Enum):
+    """All possible errors that can occur across all microgrid component categories."""
+
+    UNSPECIFIED = PBComponentErrorCode.COMPONENT_ERROR_CODE_UNSPECIFIED
+    """Default value. No specific error is specified."""
+
+    UNKNOWN = PBComponentErrorCode.COMPONENT_ERROR_CODE_UNKNOWN
+    """The component is reporting an unknown or an undefined error, and the sender
+    cannot parse the component error to any of the variants below."""
+
+    SWITCH_ON_FAULT = PBComponentErrorCode.COMPONENT_ERROR_CODE_SWITCH_ON_FAULT
+    """Error indicating that the component could not be switched on."""
+
+    UNDERVOLTAGE = PBComponentErrorCode.COMPONENT_ERROR_CODE_UNDERVOLTAGE
+    """Error indicating that the component is operating under the minimum rated
+    voltage."""
+
+    OVERVOLTAGE = PBComponentErrorCode.COMPONENT_ERROR_CODE_OVERVOLTAGE
+    """Error indicating that the component is operating over the maximum rated
+    voltage."""
+
+    OVERCURRENT = PBComponentErrorCode.COMPONENT_ERROR_CODE_OVERCURRENT
+    """Error indicating that the component is drawing more current than the
+    maximum rated value."""
+
+    OVERCURRENT_CHARGING = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_OVERCURRENT_CHARGING
+    )
+    """Error indicating that the component's consumption current is over the
+    maximum rated value during charging."""
+
+    OVERCURRENT_DISCHARGING = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_OVERCURRENT_DISCHARGING
+    )
+    """Error indicating that the component's production current is over the
+    maximum rated value during discharging."""
+
+    OVERTEMPERATURE = PBComponentErrorCode.COMPONENT_ERROR_CODE_OVERTEMPERATURE
+    """Error indicating that the component is operating over the maximum rated
+    temperature."""
+
+    UNDERTEMPERATURE = PBComponentErrorCode.COMPONENT_ERROR_CODE_UNDERTEMPERATURE
+    """Error indicating that the component is operating under the minimum rated
+    temperature."""
+
+    HIGH_HUMIDITY = PBComponentErrorCode.COMPONENT_ERROR_CODE_HIGH_HUMIDITY
+    """Error indicating that the component is exposed to high humidity levels over
+    the maximum rated value."""
+
+    FUSE_ERROR = PBComponentErrorCode.COMPONENT_ERROR_CODE_FUSE_ERROR
+    """Error indicating that the component's fuse has blown."""
+
+    PRECHARGE_ERROR = PBComponentErrorCode.COMPONENT_ERROR_CODE_PRECHARGE_ERROR
+    """Error indicating that the component's precharge unit has failed."""
+
+    PLAUSIBILITY_ERROR = PBComponentErrorCode.COMPONENT_ERROR_CODE_PLAUSIBILITY_ERROR
+    """Error indicating plausibility issues within the system involving this
+    component."""
+
+    UNDERVOLTAGE_SHUTDOWN = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_UNDERVOLTAGE_SHUTDOWN
+    )
+    """Error indicating system shutdown due to undervoltage involving this
+    component."""
+
+    EV_UNEXPECTED_PILOT_FAILURE = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_EV_UNEXPECTED_PILOT_FAILURE
+    )
+    """Error indicating unexpected pilot failure in an electric vehicle (EV)
+    component."""
+
+    FAULT_CURRENT = PBComponentErrorCode.COMPONENT_ERROR_CODE_FAULT_CURRENT
+    """Error indicating fault current detected in the component."""
+
+    SHORT_CIRCUIT = PBComponentErrorCode.COMPONENT_ERROR_CODE_SHORT_CIRCUIT
+    """Error indicating a short circuit detected in the component."""
+
+    CONFIG_ERROR = PBComponentErrorCode.COMPONENT_ERROR_CODE_CONFIG_ERROR
+    """Error indicating a configuration error related to the component."""
+
+    ILLEGAL_COMPONENT_STATE_CODE_REQUESTED = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_ILLEGAL_COMPONENT_STATE_CODE_REQUESTED
+    )
+    """Error indicating an illegal state requested for the component."""
+
+    HARDWARE_INACCESSIBLE = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_HARDWARE_INACCESSIBLE
+    )
+    """Error indicating that the hardware of the component is inaccessible."""
+
+    INTERNAL = PBComponentErrorCode.COMPONENT_ERROR_CODE_INTERNAL
+    """Error indicating an internal error within the component."""
+
+    UNAUTHORIZED = PBComponentErrorCode.COMPONENT_ERROR_CODE_UNAUTHORIZED
+    """Error indicating that the component is unauthorized to perform the
+    last requested action."""
+
+    EV_CHARGING_CABLE_UNPLUGGED_FROM_STATION = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_EV_CHARGING_CABLE_UNPLUGGED_FROM_STATION
+    )
+    """Error indicating electric vehicle (EV) cable was abruptly unplugged from
+    the charging station."""
+
+    EV_CHARGING_CABLE_UNPLUGGED_FROM_EV = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_EV_CHARGING_CABLE_UNPLUGGED_FROM_EV
+    )
+    """Error indicating electric vehicle (EV) cable was abruptly unplugged from
+    the vehicle."""
+
+    EV_CHARGING_CABLE_LOCK_FAILED = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_EV_CHARGING_CABLE_LOCK_FAILED
+    )
+    """Error indicating electric vehicle (EV) cable lock failure."""
+
+    EV_CHARGING_CABLE_INVALID = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_EV_CHARGING_CABLE_INVALID
+    )
+    """Error indicating an invalid electric vehicle (EV) cable."""
+
+    EV_CONSUMER_INCOMPATIBLE = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_EV_CONSUMER_INCOMPATIBLE
+    )
+    """Error indicating an incompatible electric vehicle (EV) plug."""
+
+    BATTERY_IMBALANCE = PBComponentErrorCode.COMPONENT_ERROR_CODE_BATTERY_IMBALANCE
+    """Error indicating a battery system imbalance."""
+
+    BATTERY_LOW_SOH = PBComponentErrorCode.COMPONENT_ERROR_CODE_BATTERY_LOW_SOH
+    """Error indicating a low state of health (SOH) detected in the battery."""
+
+    BATTERY_BLOCK_ERROR = PBComponentErrorCode.COMPONENT_ERROR_CODE_BATTERY_BLOCK_ERROR
+    """Error indicating a battery block error."""
+
+    BATTERY_CONTROLLER_ERROR = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_BATTERY_CONTROLLER_ERROR
+    )
+    """Error indicating a battery controller error."""
+
+    BATTERY_RELAY_ERROR = PBComponentErrorCode.COMPONENT_ERROR_CODE_BATTERY_RELAY_ERROR
+    """Error indicating a battery relay error."""
+
+    BATTERY_CALIBRATION_NEEDED = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_BATTERY_CALIBRATION_NEEDED
+    )
+    """Error indicating that battery calibration is needed."""
+
+    RELAY_CYCLE_LIMIT_REACHED = (
+        PBComponentErrorCode.COMPONENT_ERROR_CODE_RELAY_CYCLE_LIMIT_REACHED
+    )
+    """Error indicating that the relays have been cycled for the maximum number of
+    times."""
+
+    @classmethod
+    def from_proto(
+        cls, component_error_code: PBComponentErrorCode.ValueType
+    ) -> ComponentErrorCode:
+        """Convert a protobuf ComponentErrorCode message to ComponentErrorCode enum.
+
+        Args:
+            component_error_code: protobuf enum to convert
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(c.value == component_error_code for c in ComponentErrorCode):
+            return ComponentErrorCode.UNSPECIFIED
+        return cls(component_error_code)
+
+    def to_proto(self) -> PBComponentErrorCode.ValueType:
+        """Convert a ComponentErrorCode enum to protobuf ComponentErrorCode message.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        return self.value

{frequenz-client-common-0.2.0 → frequenz_client_common-0.3.0}/src/frequenz/client/common/pagination/__init__.py

@@ -19,10 +19,10 @@ from frequenz.api.common.v1.pagination.pagination_params_pb2 import PaginationPa
 class Params:
     """Parameters for paginating list requests."""
 
-    page_size: int | None = None
+    page_size: int
     """The maximum number of results to be returned per request."""
 
-    page_token: str | None = None
+    page_token: str
     """The token identifying a specific page of the list results."""
 
     @classmethod

{frequenz-client-common-0.2.0 → frequenz_client_common-0.3.0/src/frequenz_client_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-client-common
-Version: 0.2.0
+Version: 0.3.0
 Summary: Common code and utilities for Frequenz API clients
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -19,15 +19,47 @@ 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.5.0
+Requires-Dist: frequenz-api-common<7,>=0.6.0
 Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.1.1; 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: 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"
 Provides-Extra: dev-mkdocs
+Requires-Dist: black==24.10.0; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.7; 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-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"
 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: 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"
 Provides-Extra: dev-pylint
+Requires-Dist: pylint==3.3.2; 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-mock==3.14.0; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==0.24.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.7; extra == "dev-pytest"
 Provides-Extra: dev
-License-File: LICENSE
+Requires-Dist: frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 
 # Frequenz Client Common Library
 

{frequenz-client-common-0.2.0 → frequenz_client_common-0.3.0}/src/frequenz_client_common.egg-info/requires.txt

@@ -5,43 +5,44 @@ frequenz-api-common<7,>=0.6.0
 frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
 
 [dev-flake8]
-flake8==7.0.0
+flake8==7.1.1
 flake8-docstrings==1.7.0
 flake8-pyproject==1.2.3
-pydoclint==0.4.1
+pydoclint==0.5.9
 pydocstyle==6.3.0
 
 [dev-formatting]
-black==24.4.2
+black==24.10.0
 isort==5.13.2
 
 [dev-mkdocs]
-black==24.4.2
-Markdown==3.6
-mike==2.0.0
+black==24.10.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.1
+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
 
 [dev-mypy]
-mypy==1.10.0
-types-Markdown==3.6.0.20240316
+mypy==1.13.0
+types-Markdown==3.7.0.20241204
 frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-nox==2024.4.15
-frequenz-repo-config[lib]==0.9.1
+nox==2024.10.9
+frequenz-repo-config[lib]==0.11.0
 
 [dev-pylint]
-pylint==3.1.0
+pylint==3.3.2
 frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.2.0
-frequenz-repo-config[extra-lint-examples]==0.9.1
+pytest==8.3.4
+frequenz-repo-config[extra-lint-examples]==0.11.0
 pytest-mock==3.14.0
-pytest-asyncio==0.23.6
-async-solipsism==0.6
+pytest-asyncio==0.24.0
+async-solipsism==0.7

frequenz-client-common-0.2.0/RELEASE_NOTES.md

@@ -1,5 +0,0 @@
-# Frequenz Client Common Library Release Notes
-
-## Upgrading
-
-* Upgrading metric `__init__` to names from api-common release [v0.6.0](https://github.com/frequenz-floss/frequenz-api-common/releases/tag/v0.6.0)

frequenz-client-common-0.2.0/src/frequenz/client/common/microgrid/components/__init__.py

@@ -1,67 +0,0 @@
-# License: MIT
-# 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
-
-# pylint: disable=no-name-in-module
-from frequenz.api.common.v1.microgrid.components.components_pb2 import (
-    ComponentCategory as PBComponentCategory,
-)
-
-# pylint: enable=no-name-in-module
-
-
-class ComponentCategory(Enum):
-    """Possible types of microgrid component."""
-
-    UNSPECIFIED = PBComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
-    """An unknown component category.
-
-    Useful for error handling, and marking unknown components in
-    a list of components with otherwise known categories.
-    """
-
-    GRID = PBComponentCategory.COMPONENT_CATEGORY_GRID
-    """The point where the local microgrid is connected to the grid."""
-
-    METER = PBComponentCategory.COMPONENT_CATEGORY_METER
-    """A meter, for measuring electrical metrics, e.g., current, voltage, etc."""
-
-    INVERTER = PBComponentCategory.COMPONENT_CATEGORY_INVERTER
-    """An electricity generator, with batteries or solar energy."""
-
-    BATTERY = PBComponentCategory.COMPONENT_CATEGORY_BATTERY
-    """A storage system for electrical energy, used by inverters."""
-
-    EV_CHARGER = PBComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
-    """A station for charging electrical vehicles."""
-
-    CHP = PBComponentCategory.COMPONENT_CATEGORY_CHP
-    """A heat and power combustion plant (CHP stands for combined heat and power)."""
-
-    @classmethod
-    def from_proto(
-        cls, component_category: PBComponentCategory.ValueType
-    ) -> ComponentCategory:
-        """Convert a protobuf ComponentCategory message to ComponentCategory enum.
-
-        Args:
-            component_category: protobuf enum to convert
-
-        Returns:
-            Enum value corresponding to the protobuf message.
-        """
-        if not any(t.value == component_category for t in ComponentCategory):
-            return ComponentCategory.UNSPECIFIED
-        return cls(component_category)
-
-    def to_proto(self) -> PBComponentCategory.ValueType:
-        """Convert a ComponentCategory enum to protobuf ComponentCategory message.
-
-        Returns:
-            Enum value corresponding to the protobuf message.
-        """
-        return self.value