Remove ComponentStatus and Component.status

These were removed from the microgrid API v0.18.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/client/microgrid/component/__init__.py

@@ -51,7 +51,6 @@
 )
 from ._relay import Relay
 from ._state_sample import ComponentErrorCode, ComponentStateCode, ComponentStateSample
-from ._status import ComponentStatus
 from ._types import (
     ComponentTypes,
     ProblematicComponentTypes,
@@ -74,7 +73,6 @@
     "ComponentErrorCode",
     "ComponentStateCode",
     "ComponentStateSample",
-    "ComponentStatus",
     "ComponentTypes",
     "Converter",
     "CryptoMiner",

src/frequenz/client/microgrid/component/_component.py

@@ -4,7 +4,6 @@
 """Base component from which all other components inherit."""
 
 import dataclasses
-import logging
 from collections.abc import Mapping
 from datetime import datetime, timezone
 from typing import Any, Self
@@ -16,9 +15,6 @@
 from ..metrics._bounds import Bounds
 from ..metrics._metric import Metric
 from ._category import ComponentCategory
-from ._status import ComponentStatus
-
-_logger = logging.getLogger(__name__)
 
 
 @dataclasses.dataclass(frozen=True, kw_only=True)
@@ -44,17 +40,6 @@ class Component:  # pylint: disable=too-many-instance-attributes
         and in case some low level code needs to know the category of a component.
         """
 
-    status: ComponentStatus | int = ComponentStatus.UNSPECIFIED
-    """The status of this component.
-
-    Tip:
-        You can also use
-        [`is_active_now()`][frequenz.client.microgrid.component.Component.is_active_now]
-        or
-        [`is_active_at()`][frequenz.client.microgrid.component.Component.is_active_at],
-        which also checks if the component is operational.
-    """
-
     name: str | None = None
     """The name of this component."""
 
@@ -100,48 +85,24 @@ def __new__(cls, *_: Any, **__: Any) -> Self:
             raise TypeError(f"Cannot instantiate {cls.__name__} directly")
         return super().__new__(cls)
 
-    def is_active_at(self, timestamp: datetime) -> bool:
-        """Check whether this component is active at a specific timestamp.
-
-        A component is considered active if it is in the active state and is
-        operational at the given timestamp. The operational lifetime is used to
-        determine whether the component is operational at the given timestamp.
-
-        If a component has an unspecified status, it is assumed to be active
-        and a warning is logged.
+    def is_operational_at(self, timestamp: datetime) -> bool:
+        """Check whether this component is operational at a specific timestamp.
 
         Args:
             timestamp: The timestamp to check.
 
         Returns:
-            Whether this component is active at the given timestamp.
+            Whether this component is operational at the given timestamp.
         """
-        if self.status is ComponentStatus.UNSPECIFIED:
-            _logger.warning(
-                "Component %s has an unspecified status. Assuming it is active.",
-                self,
-            )
-            return self.operational_lifetime.is_operational_at(timestamp)
-
-        return (
-            self.status is ComponentStatus.ACTIVE
-            and self.operational_lifetime.is_operational_at(timestamp)
-        )
-
-    def is_active_now(self) -> bool:
-        """Check whether this component is currently active.
-
-        A component is considered active if it is in the active state and is
-        operational at the current time. The operational lifetime is used to
-        determine whether the component is operational at the current time.
+        return self.operational_lifetime.is_operational_at(timestamp)
 
-        If a component has an unspecified status, it is assumed to be active
-        and a warning is logged.
+    def is_operational_now(self) -> bool:
+        """Check whether this component is currently operational.
 
         Returns:
-            Whether this component is active at the current time.
+            Whether this component is operational at the current time.
         """
-        return self.is_active_at(datetime.now(timezone.utc))
+        return self.is_operational_at(datetime.now(timezone.utc))
 
     @property
     def identity(self) -> tuple[ComponentId, MicrogridId]:

src/frequenz/client/microgrid/component/_component_proto.py

@@ -56,7 +56,6 @@
     UnspecifiedComponent,
 )
 from ._relay import Relay
-from ._status import ComponentStatus
 from ._types import ComponentTypes
 from ._voltage_transformer import VoltageTransformer
 
@@ -109,7 +108,6 @@ class ComponentBaseData(NamedTuple):
     manufacturer: str | None
     model_name: str | None
     category: ComponentCategory | int
-    status: ComponentStatus | int
     lifetime: Lifetime
     rated_bounds: dict[Metric | int, Bounds]
     category_specific_metadata: dict[str, Any]
@@ -147,12 +145,6 @@ def component_base_from_proto_with_issues(
     if model_name is None:
         minor_issues.append("model_name is empty")
 
-    status = enum_from_proto(message.status, ComponentStatus)
-    if status is ComponentStatus.UNSPECIFIED:
-        major_issues.append("status is unspecified")
-    elif isinstance(status, int):
-        major_issues.append("status is unrecognized")
-
     lifetime = _get_operational_lifetime_from_proto(
         message, major_issues=major_issues, minor_issues=minor_issues
     )
@@ -193,7 +185,6 @@ def component_base_from_proto_with_issues(
         manufacturer,
         model_name,
         category,
-        status,
         lifetime,
         rated_bounds,
         category_specific_metadata,
@@ -229,7 +220,6 @@ def component_from_proto_with_issues(
             name=base_data.name,
             manufacturer=base_data.manufacturer,
             model_name=base_data.model_name,
-            status=base_data.status,
             category=base_data.category,
             operational_lifetime=base_data.lifetime,
             category_specific_metadata=base_data.category_specific_metadata,
@@ -244,7 +234,6 @@ def component_from_proto_with_issues(
                 name=base_data.name,
                 manufacturer=base_data.manufacturer,
                 model_name=base_data.model_name,
-                status=base_data.status,
                 category=base_data.category,
                 operational_lifetime=base_data.lifetime,
                 rated_bounds=base_data.rated_bounds,
@@ -266,7 +255,6 @@ def component_from_proto_with_issues(
                 name=base_data.name,
                 manufacturer=base_data.manufacturer,
                 model_name=base_data.model_name,
-                status=base_data.status,
                 operational_lifetime=base_data.lifetime,
                 rated_bounds=base_data.rated_bounds,
             )
@@ -291,7 +279,6 @@ def component_from_proto_with_issues(
                         name=base_data.name,
                         manufacturer=base_data.manufacturer,
                         model_name=base_data.model_name,
-                        status=base_data.status,
                         operational_lifetime=base_data.lifetime,
                         rated_bounds=base_data.rated_bounds,
                     )
@@ -303,7 +290,6 @@ def component_from_proto_with_issues(
                         name=base_data.name,
                         manufacturer=base_data.manufacturer,
                         model_name=base_data.model_name,
-                        status=base_data.status,
                         operational_lifetime=base_data.lifetime,
                         rated_bounds=base_data.rated_bounds,
                         type=battery_type,
@@ -340,7 +326,6 @@ def component_from_proto_with_issues(
                         name=base_data.name,
                         manufacturer=base_data.manufacturer,
                         model_name=base_data.model_name,
-                        status=base_data.status,
                         operational_lifetime=base_data.lifetime,
                         rated_bounds=base_data.rated_bounds,
                     )
@@ -354,7 +339,6 @@ def component_from_proto_with_issues(
                         name=base_data.name,
                         manufacturer=base_data.manufacturer,
                         model_name=base_data.model_name,
-                        status=base_data.status,
                         operational_lifetime=base_data.lifetime,
                         rated_bounds=base_data.rated_bounds,
                         type=ev_charger_type,
@@ -370,7 +354,6 @@ def component_from_proto_with_issues(
                 name=base_data.name,
                 manufacturer=base_data.manufacturer,
                 model_name=base_data.model_name,
-                status=base_data.status,
                 operational_lifetime=base_data.lifetime,
                 rated_bounds=base_data.rated_bounds,
                 rated_fuse_current=rated_fuse_current,
@@ -408,7 +391,6 @@ def component_from_proto_with_issues(
                         name=base_data.name,
                         manufacturer=base_data.manufacturer,
                         model_name=base_data.model_name,
-                        status=base_data.status,
                         operational_lifetime=base_data.lifetime,
                         rated_bounds=base_data.rated_bounds,
                     )
@@ -422,7 +404,6 @@ def component_from_proto_with_issues(
                         name=base_data.name,
                         manufacturer=base_data.manufacturer,
                         model_name=base_data.model_name,
-                        status=base_data.status,
                         operational_lifetime=base_data.lifetime,
                         rated_bounds=base_data.rated_bounds,
                         type=inverter_type,
@@ -436,7 +417,6 @@ def component_from_proto_with_issues(
                 name=base_data.name,
                 manufacturer=base_data.manufacturer,
                 model_name=base_data.model_name,
-                status=base_data.status,
                 operational_lifetime=base_data.lifetime,
                 rated_bounds=base_data.rated_bounds,
                 primary_voltage=message.category_type.voltage_transformer.primary,

src/frequenz/client/microgrid/component/_status.py

@@ -15,11 +15,7 @@
 from google.protobuf.timestamp_pb2 import Timestamp
 
 from frequenz.client.microgrid import Lifetime
-from frequenz.client.microgrid.component import (
-    Component,
-    ComponentCategory,
-    ComponentStatus,
-)
+from frequenz.client.microgrid.component import Component, ComponentCategory
 from frequenz.client.microgrid.component._component_proto import ComponentBaseData
 from frequenz.client.microgrid.metrics import Bounds, Metric
 
@@ -58,7 +54,6 @@ def default_component_base_data(
         manufacturer=DEFAULT_MANUFACTURER,
         model_name=DEFAULT_MODEL_NAME,
         category=ComponentCategory.UNSPECIFIED,
-        status=ComponentStatus.ACTIVE,
         lifetime=DEFAULT_LIFETIME,
         rated_bounds={Metric.AC_ACTIVE_ENERGY: Bounds(lower=0, upper=100)},
         category_specific_metadata={},
@@ -74,7 +69,6 @@ def assert_base_data(base_data: ComponentBaseData, other: Component) -> None:
     assert base_data.manufacturer == other.manufacturer
     assert base_data.model_name == other.model_name
     assert base_data.category == other.category
-    assert base_data.status == other.status
     assert base_data.lifetime == other.operational_lifetime
     assert base_data.rated_bounds == other.rated_bounds
     assert base_data.category_specific_metadata == other.category_specific_metadata
@@ -88,11 +82,6 @@ def base_data_as_proto(base_data: ComponentBaseData) -> components_pb2.Component
         name=base_data.name or "",
         manufacturer=base_data.manufacturer or "",
         model_name=base_data.model_name or "",
-        status=(
-            base_data.status
-            if isinstance(base_data.status, int)
-            else int(base_data.status.value)  # type: ignore[arg-type]
-        ),
         category=(
             base_data.category
             if isinstance(base_data.category, int)

tests/component/component_proto/conftest.py

@@ -4,12 +4,11 @@
 """Tests for protobuf conversion of the base/common part of Component objects."""
 
 
-import pytest
 from frequenz.api.common.v1.microgrid.components import battery_pb2
 from google.protobuf.timestamp_pb2 import Timestamp
 
 from frequenz.client.microgrid import Lifetime
-from frequenz.client.microgrid.component import ComponentCategory, ComponentStatus
+from frequenz.client.microgrid.component import ComponentCategory
 from frequenz.client.microgrid.component._component_proto import (
     ComponentBaseData,
     component_base_from_proto_with_issues,
@@ -35,9 +34,8 @@ def test_complete(default_component_base_data: ComponentBaseData) -> None:
     assert parsed == base_data
 
 
-@pytest.mark.parametrize("status", [ComponentStatus.UNSPECIFIED, 999])
-def test_missing_metadata(
-    default_component_base_data: ComponentBaseData, status: ComponentStatus | int
+def test_missing_category_specific_info(
+    default_component_base_data: ComponentBaseData,
 ) -> None:
     """Test parsing with missing optional metadata."""
     major_issues: list[str] = []
@@ -47,7 +45,6 @@ def test_missing_metadata(
         manufacturer=None,
         model_name=None,
         category=ComponentCategory.UNSPECIFIED,
-        status=status,
         lifetime=Lifetime(),
         rated_bounds={},
         category_specific_metadata={},
@@ -60,12 +57,7 @@ def test_missing_metadata(
         proto, major_issues=major_issues, minor_issues=minor_issues
     )
 
-    expected_major_issues = ["category is unspecified"]
-    if status == ComponentStatus.UNSPECIFIED:
-        expected_major_issues.append("status is unspecified")
-    else:
-        expected_major_issues.append("status is unrecognized")
-    assert sorted(major_issues) == sorted(expected_major_issues)
+    assert sorted(major_issues) == sorted(["category is unspecified"])
     assert sorted(minor_issues) == sorted(
         [
             "name is empty",

tests/component/component_proto/test_base.py

@@ -13,7 +13,6 @@
     Battery,
     BatteryType,
     ComponentCategory,
-    ComponentStatus,
     LiIonBattery,
     NaIonBattery,
     UnrecognizedBattery,
@@ -53,7 +52,6 @@ def test_abstract_battery_cannot_be_instantiated(
             name="test_battery",
             manufacturer="test_manufacturer",
             model_name="test_model",
-            status=ComponentStatus.ACTIVE,
             type=BatteryType.LI_ION,
         )
 
@@ -85,15 +83,13 @@ def test_recognized_battery_types(
         name=case.name,
         manufacturer="test_manufacturer",
         model_name="test_model",
-        status=ComponentStatus.ACTIVE,
     )
 
     assert battery.id == component_id
     assert battery.microgrid_id == microgrid_id
     assert battery.name == case.name
     assert battery.manufacturer == "test_manufacturer"
     assert battery.model_name == "test_model"
-    assert battery.status == ComponentStatus.ACTIVE
     assert battery.category == ComponentCategory.BATTERY
     assert battery.type == case.expected_type
 
@@ -108,7 +104,6 @@ def test_unrecognized_battery_type(
         name="unrecognized_battery",
         manufacturer="test_manufacturer",
         model_name="test_model",
-        status=ComponentStatus.ACTIVE,
         type=999,
     )
 
@@ -117,6 +112,5 @@ def test_unrecognized_battery_type(
     assert battery.name == "unrecognized_battery"
     assert battery.manufacturer == "test_manufacturer"
     assert battery.model_name == "test_model"
-    assert battery.status == ComponentStatus.ACTIVE
     assert battery.category == ComponentCategory.BATTERY
     assert battery.type == 999