Add missing docstrings

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

Author: llucax

tests/api_client/test_api_client.py

@@ -14,6 +14,11 @@ class FakeApiClient(ApiClient):
 
     @classmethod
     def api_major_version(cls) -> int:
+        """Return the major version of the API supported by the client.
+
+        Returns:
+            The major version of the API supported by the client.
+        """
         # Specifying the targeted API version here.
         return 1
 
@@ -42,16 +47,20 @@ class FakeGrpcClient(FakeApiClient):
 
     @classmethod
     def api_type(cls) -> ApiProtocol:
+        """Return the API type."""
         # Specifying the API protocol here as gRPC.
         return ApiProtocol.GRPC
 
     async def connect(self, connection_params: str) -> None:
+        """Connect to the API."""
         self.is_connected = True
 
     async def disconnect(self) -> None:
+        """Disconnect from the API."""
         self.is_connected = False
 
     def get_data(self) -> str:
+        """Get data from the API."""
         return "grpc data"
 
 
@@ -62,16 +71,20 @@ class FakeRestClient(FakeApiClient):
 
     @classmethod
     def api_type(cls) -> ApiProtocol:
+        """Return the API type."""
         # Same as `FakeGrpcClient`, but targeting REST protocol here.
         return ApiProtocol.REST
 
     async def connect(self, connection_params: str) -> None:
+        """Connect to the API."""
         self.is_connected = True
 
     async def disconnect(self) -> None:
+        """Disconnect from the API."""
         self.is_connected = False
 
     def get_data(self) -> str:
+        """Get data from the API."""
         return "rest data"
 
 

tests/microgrid/test_client.py

@@ -34,15 +34,19 @@
 
 
 class TestMicrogridGrpcClient:
+    """Tests for the microgrid client thin wrapper."""
+
     @staticmethod
     def create_client(port: int) -> client.MicrogridApiClient:
+        """Create a client for the mock API server."""
         return client.MicrogridGrpcClient(
             grpc.aio.insecure_channel(f"[::]:{port}"),
             f"[::]:{port}",
             retry_spec=LinearBackoff(interval=0.0, jitter=0.05),
         )
 
     async def test_components(self) -> None:
+        """Test the components() method."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57899)
         await server.start()
@@ -165,6 +169,7 @@ async def test_components(self) -> None:
             assert await server.graceful_shutdown()
 
     async def test_connections(self) -> None:
+        """Test the connections() method."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57898)
         await server.start()
@@ -390,6 +395,7 @@ def ListAllComponents(
             assert await server.graceful_shutdown()
 
     async def test_meter_data(self) -> None:
+        """Test the meter_data() method."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57899)
         await server.start()
@@ -422,6 +428,7 @@ async def test_meter_data(self) -> None:
         assert latest.component_id == 83
 
     async def test_battery_data(self) -> None:
+        """Test the battery_data() method."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57899)
         await server.start()
@@ -454,6 +461,7 @@ async def test_battery_data(self) -> None:
         assert latest.component_id == 83
 
     async def test_inverter_data(self) -> None:
+        """Test the inverter_data() method."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57899)
         await server.start()
@@ -486,6 +494,7 @@ async def test_inverter_data(self) -> None:
         assert latest.component_id == 83
 
     async def test_ev_charger_data(self) -> None:
+        """Test the ev_charger_data() method."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57899)
         await server.start()
@@ -563,6 +572,7 @@ async def test_discharge(self) -> None:
             assert await server.graceful_shutdown()
 
     async def test_set_bounds(self) -> None:
+        """Check if set_bounds is able to set bounds for component."""
         servicer = mock_api.MockMicrogridServicer()
         server = mock_api.MockGrpcServer(servicer, port=57899)
         await server.start()

tests/microgrid/test_graph.py

@@ -64,6 +64,7 @@ class TestComponentGraph:
 
     @pytest.fixture()
     def sample_input_components(self) -> Set[Component]:
+        """Create a sample set of components for testing purposes."""
         return {
             Component(11, ComponentCategory.GRID),
             Component(21, ComponentCategory.METER),
@@ -74,6 +75,7 @@ def sample_input_components(self) -> Set[Component]:
 
     @pytest.fixture()
     def sample_input_connections(self) -> Set[Connection]:
+        """Create a sample set of connections for testing purposes."""
         return {
             Connection(11, 21),
             Connection(21, 41),
@@ -95,6 +97,7 @@ def sample_graph(
         return _graph_implementation
 
     def test_without_filters(self) -> None:
+        """Test the graph component query without filters."""
         _graph_implementation = gr._MicrogridComponentGraph()
         graph: gr.ComponentGraph = _graph_implementation
 
@@ -210,6 +213,7 @@ def test_without_filters(self) -> None:
     def test_filter_graph_components_by_id(
         self, sample_graph: gr.ComponentGraph, ids: Set[int], expected: Set[Component]
     ) -> None:
+        """Test the graph component query with component ID filter."""
         # with component_id filter specified, we get back only components whose ID
         # matches one of the specified values
         assert len(sample_graph.components(component_id=ids)) == len(expected)
@@ -260,6 +264,7 @@ def test_filter_graph_components_by_type(
         types: Set[ComponentCategory],
         expected: Set[Component],
     ) -> None:
+        """Test the graph component query with component category filter."""
         # with component_id filter specified, we get back only components whose ID
         # matches one of the specified values
         assert len(sample_graph.components(component_category=types)) == len(expected)
@@ -292,6 +297,7 @@ def test_filter_graph_components_with_composite_filter(
         types: Set[ComponentCategory],
         expected: Set[Component],
     ) -> None:
+        """Test the graph component query with composite filter."""
         # when both filters are applied, they are combined via AND logic, i.e.
         # the component must have one of the specified IDs and be of one of
         # the specified types
@@ -306,11 +312,13 @@ def test_filter_graph_components_with_composite_filter(
     def test_components_without_filters(
         self, sample_input_components: Set[Component], sample_graph: gr.ComponentGraph
     ) -> None:
+        """Test the graph component query without filters."""
         # without any filter applied, we get back all the components in the graph
         assert len(sample_graph.components()) == len(sample_input_components)
         assert sample_graph.components() == sample_input_components
 
     def test_connection_filters(self) -> None:
+        """Test the graph connection query with filters."""
         _graph_implementation = gr._MicrogridComponentGraph(
             components={
                 Component(1, ComponentCategory.GRID),
@@ -528,6 +536,7 @@ class Test_MicrogridComponentGraph:
     """
 
     def test___init__(self) -> None:
+        """Test the constructor."""
         # it is possible to instantiate an empty graph, but
         # it will not be considered valid until it has been
         # populated with components and connections
@@ -604,6 +613,7 @@ def test___init__(self) -> None:
             )
 
     def test_refresh_from(self) -> None:
+        """Test the refresh_from method."""
         graph = gr._MicrogridComponentGraph()
         assert set(graph.components()) == set()
         assert list(graph.connections()) == []
@@ -765,6 +775,7 @@ def pretend_to_correct_errors(_g: gr._MicrogridComponentGraph) -> None:
         graph.validate()
 
     async def test_refresh_from_api(self) -> None:
+        """Test the refresh_from_api method."""
         graph = gr._MicrogridComponentGraph()
         assert graph.components() == set()
         assert graph.connections() == set()
@@ -885,6 +896,7 @@ async def test_refresh_from_api(self) -> None:
         assert await server.graceful_shutdown()
 
     def test_validate(self) -> None:
+        """Test the validate method."""
         # `validate` will fail if any of the following are the case:
         #
         #   * the graph data is not valid
@@ -953,6 +965,7 @@ def test_validate(self) -> None:
             graph.validate()
 
     def test__validate_graph(self) -> None:
+        """Test the _validate_graph method."""
         # to ensure clean testing of the individual method,
         # we cheat by setting underlying graph data directly
 
@@ -1003,6 +1016,7 @@ def test__validate_graph(self) -> None:
             graph._validate_graph()
 
     def test__validate_graph_root(self) -> None:
+        """Test the _validate_graph_root method."""
         # to ensure clean testing of the individual method,
         # we cheat by setting underlying graph data directly
 
@@ -1125,6 +1139,7 @@ def test__validate_graph_root(self) -> None:
         graph._validate_graph_root()
 
     def test__validate_grid_endpoint(self) -> None:
+        """Test the _validate_grid_endpoint method."""
         # to ensure clean testing of the individual method,
         # we cheat by setting underlying graph data directly
 
@@ -1194,6 +1209,7 @@ def test__validate_grid_endpoint(self) -> None:
         graph._validate_grid_endpoint()
 
     def test__validate_intermediary_components(self) -> None:
+        """Test the _validate_intermediary_components method."""
         # to ensure clean testing of the individual method,
         # we cheat by setting underlying graph data directly
 
@@ -1247,6 +1263,7 @@ def test__validate_intermediary_components(self) -> None:
         graph._validate_intermediary_components()
 
     def test__validate_leaf_components(self) -> None:
+        """Test the _validate_leaf_components method."""
         # to ensure clean testing of the individual method,
         # we cheat by setting underlying graph data directly
 
@@ -1336,6 +1353,7 @@ def test__validate_leaf_components(self) -> None:
         graph._validate_leaf_components()
 
     def test_graph_correction(self) -> None:
+        """Test the graph correction functionality."""
         # Simple test cases for our built-in graph correction
         # functionality.  We test only with `refresh_from`:
         # for `refresh_from_api` it suffices to test that any

tests/microgrid/test_mock_api.py

@@ -23,6 +23,7 @@
 
 
 def test_MockMicrogridServicer() -> None:
+    """Test the MockMicrogridServicer."""
     api = mock_api.MockMicrogridServicer()
     service_context_mock = Mock(spec=grpc.ServicerContext)
     assert (
@@ -211,6 +212,7 @@ def test_MockMicrogridServicer() -> None:
 
 
 async def test_MockGrpcServer() -> None:
+    """Test the MockGrpcServer."""
     servicer1 = mock_api.MockMicrogridServicer(
         components=[
             (1, ComponentCategory.COMPONENT_CATEGORY_GRID),