Add component types aliases

These aliases are type unions for all supported components, and for all
known problematic, unspecified and unrecognized components. These
include the specific types of components with sub-types, like batteries,
EV chargers and inverters.

These type aliases only include concrete types, the base types are not
included, this way they can be used as type hints where match statements
should be used.

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

Author: llucax

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

@@ -50,6 +50,12 @@
 )
 from ._relay import Relay
 from ._status import ComponentStatus
+from ._types import (
+    ComponentTypes,
+    ProblematicComponentTypes,
+    UnrecognizedComponentTypes,
+    UnspecifiedComponentTypes,
+)
 from ._voltage_transformer import VoltageTransformer
 
 __all__ = [
@@ -62,6 +68,7 @@
     "Component",
     "ComponentCategory",
     "ComponentStatus",
+    "ComponentTypes",
     "Converter",
     "CryptoMiner",
     "DcEvCharger",
@@ -82,14 +89,17 @@
     "NaIonBattery",
     "Precharger",
     "ProblematicComponent",
+    "ProblematicComponentTypes",
     "Relay",
     "SolarInverter",
     "UnrecognizedBattery",
     "UnrecognizedComponent",
+    "UnrecognizedComponentTypes",
     "UnrecognizedEvCharger",
     "UnrecognizedInverter",
     "UnspecifiedBattery",
     "UnspecifiedComponent",
+    "UnspecifiedComponentTypes",
     "UnspecifiedEvCharger",
     "UnspecifiedInverter",
     "VoltageTransformer",

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

@@ -0,0 +1,65 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+
+"""All known component types."""
+
+from typing import TypeAlias
+
+from ._battery import BatteryTypes, UnrecognizedBattery, UnspecifiedBattery
+from ._chp import Chp
+from ._converter import Converter
+from ._crypto_miner import CryptoMiner
+from ._electrolyzer import Electrolyzer
+from ._ev_charger import EvChargerTypes, UnrecognizedEvCharger, UnspecifiedEvCharger
+from ._fuse import Fuse
+from ._grid_connection_point import GridConnectionPoint
+from ._hvac import Hvac
+from ._inverter import InverterTypes, UnrecognizedInverter, UnspecifiedInverter
+from ._meter import Meter
+from ._precharger import Precharger
+from ._problematic import (
+    MismatchedCategoryComponent,
+    UnrecognizedComponent,
+    UnspecifiedComponent,
+)
+from ._relay import Relay
+from ._voltage_transformer import VoltageTransformer
+
+UnspecifiedComponentTypes: TypeAlias = (
+    UnspecifiedBattery
+    | UnspecifiedComponent
+    | UnspecifiedEvCharger
+    | UnspecifiedInverter
+)
+"""All unspecified component types."""
+
+UnrecognizedComponentTypes: TypeAlias = (
+    UnrecognizedBattery
+    | UnrecognizedComponent
+    | UnrecognizedEvCharger
+    | UnrecognizedInverter
+)
+
+ProblematicComponentTypes: TypeAlias = (
+    MismatchedCategoryComponent | UnrecognizedComponentTypes | UnspecifiedComponentTypes
+)
+"""All possible component types that has a problem."""
+
+ComponentTypes: TypeAlias = (
+    BatteryTypes
+    | Chp
+    | Converter
+    | CryptoMiner
+    | Electrolyzer
+    | EvChargerTypes
+    | Fuse
+    | GridConnectionPoint
+    | Hvac
+    | InverterTypes
+    | Meter
+    | Precharger
+    | ProblematicComponentTypes
+    | Relay
+    | VoltageTransformer
+)
+"""All possible component types."""