Disable pylints no-name-in-module check (#81)

We can disable this rule because `mypy` already checks for this kind of
errors and this also fixes a long-standing issue with `pylint` that
can't figure out protobuf generate stuff have some members:

* pylint-dev/pylint#6281

And now that we disabled this check we can just use the protobuf modules
instead of having to declare one alias per each symbol we need. We did
this before just so we only need to use a `pylint`
`disable=no-name-in-module` one time in the import instead each time we
**used** the symbol.

Author: llucax

pyproject.toml

@@ -146,6 +146,7 @@ disable = [
   "unsubscriptable-object",
   # Checked by mypy
   "no-member",
+  "no-name-in-module",
   # Checked by flake8
   "f-string-without-interpolation",
   "line-too-long",

src/frequenz/client/microgrid/_client.py

@@ -9,30 +9,12 @@
 from typing import Any, TypeVar, cast
 
 import grpc.aio
-
-# pylint: disable=no-name-in-module
-from frequenz.api.common.components_pb2 import ComponentCategory as PbComponentCategory
-from frequenz.api.common.metrics_pb2 import Bounds as PbBounds
-from frequenz.api.microgrid.microgrid_pb2 import ComponentData as PbComponentData
-from frequenz.api.microgrid.microgrid_pb2 import ComponentFilter as PbComponentFilter
-from frequenz.api.microgrid.microgrid_pb2 import ComponentIdParam as PbComponentIdParam
-from frequenz.api.microgrid.microgrid_pb2 import ComponentList as PbComponentList
-from frequenz.api.microgrid.microgrid_pb2 import ConnectionFilter as PbConnectionFilter
-from frequenz.api.microgrid.microgrid_pb2 import ConnectionList as PbConnectionList
-from frequenz.api.microgrid.microgrid_pb2 import (
-    MicrogridMetadata as PbMicrogridMetadata,
-)
-from frequenz.api.microgrid.microgrid_pb2 import SetBoundsParam as PbSetBoundsParam
-from frequenz.api.microgrid.microgrid_pb2 import (
-    SetPowerActiveParam as PbSetPowerActiveParam,
-)
-from frequenz.api.microgrid.microgrid_pb2_grpc import MicrogridStub
-
-# pylint: enable=no-name-in-module
+from frequenz.api.common import components_pb2, metrics_pb2
+from frequenz.api.microgrid import microgrid_pb2, microgrid_pb2_grpc
 from frequenz.channels import Receiver
 from frequenz.client.base import channel, retry, streaming
-from google.protobuf.empty_pb2 import Empty  # pylint: disable=no-name-in-module
-from google.protobuf.timestamp_pb2 import Timestamp  # pylint: disable=no-name-in-module
+from google.protobuf.empty_pb2 import Empty
+from google.protobuf.timestamp_pb2 import Timestamp
 
 from ._component import (
     Component,
@@ -87,7 +69,7 @@ def __init__(
         self._server_url = server_url
         """The location of the microgrid API server as a URL."""
 
-        self.api = MicrogridStub(channel.parse_grpc_uri(server_url))
+        self.api = microgrid_pb2_grpc.MicrogridStub(channel.parse_grpc_uri(server_url))
         """The gRPC stub for the microgrid API."""
 
         self._broadcasters: dict[int, streaming.GrpcStreamBroadcaster[Any, Any]] = {}
@@ -113,9 +95,9 @@ async def components(self) -> Iterable[Component]:
             # grpc.aio is missing types and mypy thinks this is not awaitable,
             # but it is
             component_list = await cast(
-                Awaitable[PbComponentList],
+                Awaitable[microgrid_pb2.ComponentList],
                 self.api.ListComponents(
-                    PbComponentFilter(),
+                    microgrid_pb2.ComponentFilter(),
                     timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
                 ),
             )
@@ -127,7 +109,8 @@ async def components(self) -> Iterable[Component]:
             ) from grpc_error
 
         components_only = filter(
-            lambda c: c.category is not PbComponentCategory.COMPONENT_CATEGORY_SENSOR,
+            lambda c: c.category
+            is not components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
             component_list.components,
         )
         result: Iterable[Component] = map(
@@ -151,10 +134,10 @@ async def metadata(self) -> Metadata:
         Returns:
             the microgrid metadata.
         """
-        microgrid_metadata: PbMicrogridMetadata | None = None
+        microgrid_metadata: microgrid_pb2.MicrogridMetadata | None = None
         try:
             microgrid_metadata = await cast(
-                Awaitable[PbMicrogridMetadata],
+                Awaitable[microgrid_pb2.MicrogridMetadata],
                 self.api.GetMicrogridMetadata(
                     Empty(),
                     timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
@@ -196,14 +179,14 @@ async def connections(
                 most likely a subclass of
                 [GrpcError][frequenz.client.microgrid.GrpcError].
         """
-        connection_filter = PbConnectionFilter(starts=starts, ends=ends)
+        connection_filter = microgrid_pb2.ConnectionFilter(starts=starts, ends=ends)
         try:
             valid_components, all_connections = await asyncio.gather(
                 self.components(),
                 # grpc.aio is missing types and mypy thinks this is not
                 # awaitable, but it is
                 cast(
-                    Awaitable[PbConnectionList],
+                    Awaitable[microgrid_pb2.ConnectionList],
                     self.api.ListConnections(
                         connection_filter,
                         timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
@@ -237,7 +220,7 @@ async def _new_component_data_receiver(
         *,
         component_id: int,
         expected_category: ComponentCategory,
-        transform: Callable[[PbComponentData], _ComponentDataT],
+        transform: Callable[[microgrid_pb2.ComponentData], _ComponentDataT],
         maxsize: int,
     ) -> Receiver[_ComponentDataT]:
         """Return a new broadcaster receiver for a given `component_id`.
@@ -265,12 +248,14 @@ async def _new_component_data_receiver(
             broadcaster = streaming.GrpcStreamBroadcaster(
                 f"raw-component-data-{component_id}",
                 # We need to cast here because grpc says StreamComponentData is
-                # a grpc.CallIterator[PbComponentData] which is not an AsyncIterator,
-                # but it is a grpc.aio.UnaryStreamCall[..., PbComponentData], which it
-                # is.
+                # a grpc.CallIterator[microgrid_pb2.ComponentData] which is not an
+                # AsyncIterator, but it is a grpc.aio.UnaryStreamCall[...,
+                # microgrid_pb2.ComponentData], which it is.
                 lambda: cast(
-                    AsyncIterator[PbComponentData],
-                    self.api.StreamComponentData(PbComponentIdParam(id=component_id)),
+                    AsyncIterator[microgrid_pb2.ComponentData],
+                    self.api.StreamComponentData(
+                        microgrid_pb2.ComponentIdParam(id=component_id)
+                    ),
                 ),
                 transform,
                 retry_strategy=self._retry_strategy,
@@ -427,7 +412,9 @@ async def set_power(self, component_id: int, power_w: float) -> None:
             await cast(
                 Awaitable[Empty],
                 self.api.SetPowerActive(
-                    PbSetPowerActiveParam(component_id=component_id, power=power_w),
+                    microgrid_pb2.SetPowerActiveParam(
+                        component_id=component_id, power=power_w
+                    ),
                     timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
                 ),
             )
@@ -444,7 +431,7 @@ async def set_bounds(
         lower: float,
         upper: float,
     ) -> None:
-        """Send `PbSetBoundsParam`s received from a channel to the Microgrid service.
+        """Send `SetBoundsParam`s received from a channel to the Microgrid service.
 
         Args:
             component_id: ID of the component to set bounds for.
@@ -463,15 +450,17 @@ async def set_bounds(
         if lower > 0:
             raise ValueError(f"Lower bound {lower} must be less than or equal to 0.")
 
-        target_metric = PbSetBoundsParam.TargetMetric.TARGET_METRIC_POWER_ACTIVE
+        target_metric = (
+            microgrid_pb2.SetBoundsParam.TargetMetric.TARGET_METRIC_POWER_ACTIVE
+        )
         try:
             await cast(
                 Awaitable[Timestamp],
                 self.api.AddInclusionBounds(
-                    PbSetBoundsParam(
+                    microgrid_pb2.SetBoundsParam(
                         component_id=component_id,
                         target_metric=target_metric,
-                        bounds=PbBounds(lower=lower, upper=upper),
+                        bounds=metrics_pb2.Bounds(lower=lower, upper=upper),
                     ),
                     timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
                 ),

src/frequenz/client/microgrid/_component.py

@@ -6,13 +6,8 @@
 from dataclasses import dataclass
 from enum import Enum
 
-# pylint: disable=no-name-in-module
-from frequenz.api.common.components_pb2 import ComponentCategory as PbComponentCategory
-from frequenz.api.microgrid.grid_pb2 import Metadata as PbGridMetadata
-from frequenz.api.microgrid.inverter_pb2 import Metadata as PbInverterMetadata
-from frequenz.api.microgrid.inverter_pb2 import Type as PbInverterType
-
-# pylint: enable=no-name-in-module
+from frequenz.api.common import components_pb2
+from frequenz.api.microgrid import grid_pb2, inverter_pb2
 
 
 class ComponentType(Enum):
@@ -22,22 +17,22 @@ class ComponentType(Enum):
 class InverterType(ComponentType):
     """Enum representing inverter types."""
 
-    NONE = PbInverterType.TYPE_UNSPECIFIED
+    NONE = inverter_pb2.Type.TYPE_UNSPECIFIED
     """Unspecified inverter type."""
 
-    BATTERY = PbInverterType.TYPE_BATTERY
+    BATTERY = inverter_pb2.Type.TYPE_BATTERY
     """Battery inverter."""
 
-    SOLAR = PbInverterType.TYPE_SOLAR
+    SOLAR = inverter_pb2.Type.TYPE_SOLAR
     """Solar inverter."""
 
-    HYBRID = PbInverterType.TYPE_HYBRID
+    HYBRID = inverter_pb2.Type.TYPE_HYBRID
     """Hybrid inverter."""
 
 
 def component_type_from_protobuf(
-    component_category: PbComponentCategory.ValueType,
-    component_metadata: PbInverterMetadata,
+    component_category: components_pb2.ComponentCategory.ValueType,
+    component_metadata: inverter_pb2.Metadata,
 ) -> ComponentType | None:
     """Convert a protobuf InverterType message to Component enum.
 
@@ -53,7 +48,10 @@ def component_type_from_protobuf(
     # ComponentType values in the protobuf definition are not unique across categories
     # as of v0.11.0, so we need to check the component category first, before doing any
     # component type checks.
-    if component_category == PbComponentCategory.COMPONENT_CATEGORY_INVERTER:
+    if (
+        component_category
+        == components_pb2.ComponentCategory.COMPONENT_CATEGORY_INVERTER
+    ):
         if not any(int(t.value) == int(component_metadata.type) for t in InverterType):
             return None
 
@@ -65,30 +63,30 @@ def component_type_from_protobuf(
 class ComponentCategory(Enum):
     """Possible types of microgrid component."""
 
-    NONE = PbComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
+    NONE = components_pb2.ComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
     """Unspecified component category."""
 
-    GRID = PbComponentCategory.COMPONENT_CATEGORY_GRID
+    GRID = components_pb2.ComponentCategory.COMPONENT_CATEGORY_GRID
     """Grid component."""
 
-    METER = PbComponentCategory.COMPONENT_CATEGORY_METER
+    METER = components_pb2.ComponentCategory.COMPONENT_CATEGORY_METER
     """Meter component."""
 
-    INVERTER = PbComponentCategory.COMPONENT_CATEGORY_INVERTER
+    INVERTER = components_pb2.ComponentCategory.COMPONENT_CATEGORY_INVERTER
     """Inverter component."""
 
-    BATTERY = PbComponentCategory.COMPONENT_CATEGORY_BATTERY
+    BATTERY = components_pb2.ComponentCategory.COMPONENT_CATEGORY_BATTERY
     """Battery component."""
 
-    EV_CHARGER = PbComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
+    EV_CHARGER = components_pb2.ComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
     """EV charger component."""
 
-    CHP = PbComponentCategory.COMPONENT_CATEGORY_CHP
+    CHP = components_pb2.ComponentCategory.COMPONENT_CATEGORY_CHP
     """CHP component."""
 
 
 def component_category_from_protobuf(
-    component_category: PbComponentCategory.ValueType,
+    component_category: components_pb2.ComponentCategory.ValueType,
 ) -> ComponentCategory:
     """Convert a protobuf ComponentCategory message to ComponentCategory enum.
 
@@ -105,7 +103,7 @@ def component_category_from_protobuf(
             a valid component category as it does not form part of the
             microgrid itself)
     """
-    if component_category == PbComponentCategory.COMPONENT_CATEGORY_SENSOR:
+    if component_category == components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR:
         raise ValueError("Cannot create a component from a sensor!")
 
     if not any(t.value == component_category for t in ComponentCategory):
@@ -136,8 +134,8 @@ class GridMetadata(ComponentMetadata):
 
 
 def component_metadata_from_protobuf(
-    component_category: PbComponentCategory.ValueType,
-    component_metadata: PbGridMetadata,
+    component_category: components_pb2.ComponentCategory.ValueType,
+    component_metadata: grid_pb2.Metadata,
 ) -> GridMetadata | None:
     """Convert a protobuf GridMetadata message to GridMetadata class.
 
@@ -150,7 +148,7 @@ def component_metadata_from_protobuf(
     Returns:
         GridMetadata instance corresponding to the protobuf message.
     """
-    if component_category == PbComponentCategory.COMPONENT_CATEGORY_GRID:
+    if component_category == components_pb2.ComponentCategory.COMPONENT_CATEGORY_GRID:
         max_current = component_metadata.rated_fuse_current
         fuse = Fuse(max_current)
         return GridMetadata(fuse)

src/frequenz/client/microgrid/_component_data.py

@@ -8,12 +8,9 @@
 from datetime import datetime, timezone
 from typing import Self
 
-# pylint: disable=no-name-in-module
-from frequenz.api.microgrid.microgrid_pb2 import ComponentData as PbComponentData
+from frequenz.api.microgrid import microgrid_pb2
 
 from ._component_error import BatteryError, InverterError
-
-# pylint: enable=no-name-in-module
 from ._component_states import (
     BatteryComponentState,
     BatteryRelayState,
@@ -38,10 +35,10 @@ class ComponentData(ABC):
     # data from a protobuf message. The whole protobuf message is stored as the `raw`
     # attribute. When `ComponentData` is not instantiated from a protobuf message,
     # i.e. using the constructor, `raw` will be set to `None`.
-    raw: PbComponentData | None = field(default=None, init=False)
+    raw: microgrid_pb2.ComponentData | None = field(default=None, init=False)
     """Raw component data as decoded from the wire."""
 
-    def _set_raw(self, raw: PbComponentData) -> None:
+    def _set_raw(self, raw: microgrid_pb2.ComponentData) -> None:
         """Store raw protobuf message.
 
         It is preferred to keep the dataclasses immutable (frozen) and make the `raw`
@@ -55,7 +52,7 @@ def _set_raw(self, raw: PbComponentData) -> None:
 
     @classmethod
     @abstractmethod
-    def from_proto(cls, raw: PbComponentData) -> Self:
+    def from_proto(cls, raw: microgrid_pb2.ComponentData) -> Self:
         """Create ComponentData from a protobuf message.
 
         Args:
@@ -122,7 +119,7 @@ class MeterData(ComponentData):
     """The AC power frequency in Hertz (Hz)."""
 
     @classmethod
-    def from_proto(cls, raw: PbComponentData) -> Self:
+    def from_proto(cls, raw: microgrid_pb2.ComponentData) -> Self:
         """Create MeterData from a protobuf message.
 
         Args:
@@ -239,7 +236,7 @@ class BatteryData(ComponentData):  # pylint: disable=too-many-instance-attribute
     """List of errors in protobuf struct."""
 
     @classmethod
-    def from_proto(cls, raw: PbComponentData) -> Self:
+    def from_proto(cls, raw: microgrid_pb2.ComponentData) -> Self:
         """Create BatteryData from a protobuf message.
 
         Args:
@@ -377,7 +374,7 @@ class InverterData(ComponentData):  # pylint: disable=too-many-instance-attribut
     """List of errors from the component."""
 
     @classmethod
-    def from_proto(cls, raw: PbComponentData) -> Self:
+    def from_proto(cls, raw: microgrid_pb2.ComponentData) -> Self:
         """Create InverterData from a protobuf message.
 
         Args:
@@ -533,7 +530,7 @@ class EVChargerData(ComponentData):  # pylint: disable=too-many-instance-attribu
     """The state of the ev charger."""
 
     @classmethod
-    def from_proto(cls, raw: PbComponentData) -> Self:
+    def from_proto(cls, raw: microgrid_pb2.ComponentData) -> Self:
         """Create EVChargerData from a protobuf message.
 
         Args: