Add missing ending full stop to docstrings.

llucax · llucax · commit 2f3eae175a0e · 2023-09-02T15:04:21.000+02:00
Signed-off-by: Leandro Lucarella &lt;luca-frequenz@llucax.com&gt;
diff --git a/tests/actor/power_distributing/test_distribution_algorithm.py b/tests/actor/power_distributing/test_distribution_algorithm.py
@@ -23,15 +23,15 @@
 
 @dataclass
 class Bound:
-    """Class to create protobuf Bound"""
+    """Class to create protobuf Bound."""
 
     lower: float
     upper: float
 
 
 @dataclass
 class Metric:
-    """Class to create protobuf Metric"""
+    """Class to create protobuf Metric."""
 
     now: Optional[float]
     bound: Optional[Bound] = None
@@ -277,7 +277,7 @@ def test_distribute_power_three_batteries_2(self) -> None:
         assert result.remaining_power == approx(0.0)
 
     def test_distribute_power_three_batteries_3(self) -> None:
-        """Test with batteries with no capacity"""
+        """Test with batteries with no capacity."""
         capacity: List[float] = [0, 49000, 0]
         components = self.create_components_with_capacity(3, capacity)
 
@@ -568,7 +568,7 @@ def test_consumption_three_batteries_4(self) -> None:
         assert result.remaining_power == approx(200.0)
 
     def test_consumption_three_batteries_5(self) -> None:
-        """Test what if some batteries has invalid SoC and capacity"""
+        """Test what if some batteries has invalid SoC and capacity."""
         capacity: List[Metric] = [Metric(98000), Metric(49000), Metric(0.0)]
         soc: List[Metric] = [
             Metric(80.0, Bound(0, 50)),
diff --git a/tests/actor/power_distributing/test_power_distributing.py b/tests/actor/power_distributing/test_power_distributing.py
@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Tests power distributor"""
+"""Tests power distributor."""
 
 from __future__ import annotations
 
@@ -41,7 +41,7 @@
 
 class TestPowerDistributingActor:
     # pylint: disable=protected-access
-    """Test tool to distribute power"""
+    """Test tool to distribute power."""
 
     _namespace = "power_distributor"
 
diff --git a/tests/actor/test_actor.py b/tests/actor/test_actor.py
@@ -47,7 +47,7 @@ def __init__(self) -> None:
         super().__init__(name="test")
 
     async def _run(self) -> None:
-        """Start the actor and crash upon receiving a message"""
+        """Start the actor and crash upon receiving a message."""
         print(f"{self} started")
         self.inc_restart_count()
         print(f"{self} done")
@@ -69,7 +69,7 @@ def __init__(
         self._recv = recv
 
     async def _run(self) -> None:
-        """Start the actor and crash upon receiving a message"""
+        """Start the actor and crash upon receiving a message."""
         print(f"{self} started")
         self.inc_restart_count()
         async for msg in self._recv:
@@ -94,7 +94,7 @@ def __init__(
         self._recv = recv
 
     async def _run(self) -> None:
-        """Start the actor and crash upon receiving a message"""
+        """Start the actor and crash upon receiving a message."""
         print(f"{self} started")
         self.inc_restart_count()
         async for _ in self._recv:
diff --git a/tests/actor/test_battery_pool_status.py b/tests/actor/test_battery_pool_status.py
@@ -20,7 +20,7 @@
 
 # pylint: disable=protected-access
 class TestBatteryPoolStatus:
-    """Tests for BatteryPoolStatus"""
+    """Tests for BatteryPoolStatus."""
 
     async def test_batteries_status(self, mocker: MockerFixture) -> None:
         """Basic tests for BatteryPoolStatus.
diff --git a/tests/actor/test_battery_status.py b/tests/actor/test_battery_status.py
@@ -149,7 +149,7 @@ class TestBatteryStatus:
     async def test_sync_update_status_with_messages(
         self, mocker: MockerFixture
     ) -> None:
-        """Test if messages changes battery status/
+        """Test if messages changes battery status.
 
         Tests uses FakeSelect to test status in sync way.
         Otherwise we would have lots of async calls and waiting.
@@ -539,7 +539,7 @@ async def test_sync_blocking_interrupted_with_invalid_message(
 
     @time_machine.travel("2022-01-01 00:00 UTC", tick=False)
     async def test_timers(self, mocker: MockerFixture) -> None:
-        """Test if messages changes battery status/
+        """Test if messages changes battery status.
 
         Tests uses FakeSelect to test status in sync way.
         Otherwise we would have lots of async calls and waiting.
@@ -689,7 +689,7 @@ class TestBatteryStatusRecovery:
     async def setup_tracker(
         self, mocker: MockerFixture
     ) -> AsyncIterator[tuple[MockMicrogrid, Receiver[Status]]]:
-        """Setup a BatteryStatusTracker instance to run tests with."""
+        """Set a BatteryStatusTracker instance up to run tests with."""
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(1)
         await mock_microgrid.start(mocker)
diff --git a/tests/actor/test_config_manager.py b/tests/actor/test_config_manager.py
@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-"""Test for ConfigManager"""
+"""Test for ConfigManager."""
 import pathlib
 
 import pytest
@@ -15,7 +15,7 @@
 
 
 class Item(BaseModel):
-    """Test item"""
+    """Test item."""
 
     item_id: int
     name: str
@@ -31,7 +31,7 @@ def create_content(number: int) -> str:
 
 
 class TestActorConfigManager:
-    """Test for ConfigManager"""
+    """Test for ConfigManager."""
 
     conf_path = "sdk/config.toml"
     conf_content = """
@@ -71,11 +71,12 @@ def real_config_file(
         return file_path
 
     async def test_update(self, config_file: pathlib.Path) -> None:
-        """
-        Test ConfigManager by checking if:
+        """Test ConfigManager.
+
+        Check if:
+
         - the initial content of the content file is correct
-        - the config file modifications are picked up and the new content
-            is correct
+        - the config file modifications are picked up and the new content is correct
         """
         config_channel: Broadcast[Config] = Broadcast(
             "Config Channel", resend_latest=True
diff --git a/tests/config/test_config.py b/tests/config/test_config.py
@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-"""Test for Config"""
+"""Test for Config."""
 import pathlib
 import re
 
@@ -16,14 +16,14 @@
 
 
 class Item(BaseModel):
-    """Test item"""
+    """Test item."""
 
     item_id: int
     name: str
 
 
 class TestConfig:
-    """Test for Config"""
+    """Test for Config."""
 
     conf_path = "sdk/config.toml"
     conf_content = """
@@ -61,7 +61,7 @@ def conf_vars(self, config_file: pathlib.Path) -> dict[str, Any]:
             return tomllib.load(file)
 
     def test_get(self, conf_vars: dict[str, Any]) -> None:
-        """Test get function"""
+        """Test get function."""
         config = Config(conf_vars=conf_vars)
 
         assert config.get("logging_lvl") == "DEBUG"
@@ -70,7 +70,7 @@ def test_get(self, conf_vars: dict[str, Any]) -> None:
         assert config.get("var2", default=0) == 0
 
     def test_getitem(self, conf_vars: dict[str, Any]) -> None:
-        """Test getitem function"""
+        """Test getitem function."""
         config = Config(conf_vars=conf_vars)
 
         assert config["logging_lvl"] == "DEBUG"
@@ -79,7 +79,7 @@ def test_getitem(self, conf_vars: dict[str, Any]) -> None:
             assert config["var2"]
 
     def test_contains(self, conf_vars: dict[str, Any]) -> None:
-        """Test contains function"""
+        """Test contains function."""
         config = Config(conf_vars=conf_vars)
 
         assert "logging_lvl" in config
@@ -116,7 +116,7 @@ def test_contains(self, conf_vars: dict[str, Any]) -> None:
     def test_get_as_success(
         self, key: str, expected_type: Any, value: Any, conf_vars: dict[str, Any]
     ) -> None:
-        """Test get_as function with proper arguments"""
+        """Test get_as function with proper arguments."""
 
         config = Config(conf_vars=conf_vars)
         result = config.get_as(key, expected_type)
@@ -136,7 +136,7 @@ def test_get_as_success(
     def test_get_as_validation_error(
         self, key: str, expected_type: Any, conf_vars: dict[str, Any]
     ) -> None:
-        """Test get_as function which raise ValidationError"""
+        """Test get_as function which raise ValidationError."""
         config = Config(conf_vars=conf_vars)
 
         err_msg = (
@@ -161,7 +161,7 @@ def test_get_dict_values_success(
         value: Any,
         conf_vars: dict[str, Any],
     ) -> None:
-        """Test get_as function with proper arguments"""
+        """Test get_as function with proper arguments."""
 
         config = Config(conf_vars=conf_vars)
         result = config.get_dict(key_prefix, expected_values_type)
@@ -178,7 +178,7 @@ def test_get_dict_values_success(
     def test_get_dict_success(
         self, key_prefix: str, expected_values_type: Any, conf_vars: dict[str, Any]
     ) -> None:
-        """Test get_as function with proper arguments"""
+        """Test get_as function with proper arguments."""
 
         config = Config(conf_vars=conf_vars)
 
diff --git a/tests/microgrid/test_microgrid_api.py b/tests/microgrid/test_microgrid_api.py
@@ -1,7 +1,8 @@
 # License: MIT
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-"""Tests of MicrogridApi"""
+"""Tests of MicrogridApi."""
+
 import asyncio
 from asyncio.tasks import ALL_COMPLETED
 from typing import List
diff --git a/tests/microgrid/test_timeout.py b/tests/microgrid/test_timeout.py
@@ -39,7 +39,7 @@
     "frequenz.sdk.microgrid.client._client.DEFAULT_GRPC_CALL_TIMEOUT", GRPC_CALL_TIMEOUT
 )
 async def test_components_timeout(mocker: MockerFixture) -> None:
-    """Test if the components() method properly raises AioRpcError"""
+    """Test if the components() method properly raises AioRpcError."""
     servicer = MockMicrogridServicer()
 
     def mock_list_components(
@@ -66,7 +66,7 @@ def mock_list_components(
     "frequenz.sdk.microgrid.client._client.DEFAULT_GRPC_CALL_TIMEOUT", GRPC_CALL_TIMEOUT
 )
 async def test_connections_timeout(mocker: MockerFixture) -> None:
-    """Test if the connections() method properly raises AioRpcError"""
+    """Test if the connections() method properly raises AioRpcError."""
     servicer = MockMicrogridServicer()
 
     def mock_list_connections(
@@ -93,7 +93,7 @@ def mock_list_connections(
     "frequenz.sdk.microgrid.client._client.DEFAULT_GRPC_CALL_TIMEOUT", GRPC_CALL_TIMEOUT
 )
 async def test_set_power_timeout(mocker: MockerFixture) -> None:
-    """Test if the set_power() method properly raises AioRpcError"""
+    """Test if the set_power() method properly raises AioRpcError."""
     servicer = MockMicrogridServicer()
 
     def mock_set_power(
diff --git a/tests/test_sdk.py b/tests/test_sdk.py
@@ -1,25 +1,23 @@
 # License: MIT
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-"""
-Top level tests for the `frequenz.sdk` pacakge
-"""
+"""Top level tests for the `frequenz.sdk` pacakge."""
 
 import frequenz.sdk
 from frequenz.sdk import config
 from frequenz.sdk.actor import ConfigManagingActor
 
 
 def test_sdk_import() -> None:
-    """Checks that `import frequenz.sdk` works"""
+    """Checks that `import frequenz.sdk` works."""
     assert frequenz.sdk is not None
 
 
 def test_sdk_import_config() -> None:
-    """Checks that `import frequenz.sdk` works"""
+    """Checks that `import frequenz.sdk` works."""
     assert config is not None
 
 
 def test_sdk_import_config_manager() -> None:
-    """Checks that `import frequenz.sdk` works"""
+    """Checks that `import frequenz.sdk` works."""
     assert ConfigManagingActor is not None
diff --git a/tests/timeseries/_battery_pool/test_battery_pool.py b/tests/timeseries/_battery_pool/test_battery_pool.py
@@ -62,7 +62,7 @@ def event_loop() -> Iterator[async_solipsism.EventLoop]:
 def get_components(
     mock_microgrid: MockMicrogridClient, component_category: ComponentCategory
 ) -> set[int]:
-    """Get components of given category from mock microgrid
+    """Get components of given category from mock microgrid.
 
     Args:
         mock_microgrid: mock microgrid
diff --git a/tests/timeseries/test_moving_window.py b/tests/timeseries/test_moving_window.py
@@ -57,8 +57,7 @@ async def push_logical_meter_data(
 def init_moving_window(
     size: timedelta,
 ) -> Tuple[MovingWindow, Sender[Sample[Quantity]]]:
-    """
-    Initialize the moving window with given shape
+    """Initialize the moving window with given shape.
 
     Args:
         size: The size of the `MovingWindow`
@@ -73,24 +72,23 @@ def init_moving_window(
 
 
 async def test_access_window_by_index() -> None:
-    """Test indexing a window by integer index"""
+    """Test indexing a window by integer index."""
     window, sender = init_moving_window(timedelta(seconds=1))
     async with window:
         await push_logical_meter_data(sender, [1])
         assert np.array_equal(window[0], 1.0)
 
 
 async def test_access_window_by_timestamp() -> None:
-    """Test indexing a window by timestamp"""
+    """Test indexing a window by timestamp."""
     window, sender = init_moving_window(timedelta(seconds=1))
     async with window:
         await push_logical_meter_data(sender, [1])
         assert np.array_equal(window[UNIX_EPOCH], 1.0)
 
 
 async def test_access_window_by_int_slice() -> None:
-    """
-    Test accessing a subwindow with an integer slice
+    """Test accessing a subwindow with an integer slice.
 
     Note that the second test is overwriting the data of the first test.
     since the push_lm_data function is starting with the same initial timestamp.
@@ -106,7 +104,7 @@ async def test_access_window_by_int_slice() -> None:
 
 
 async def test_access_window_by_ts_slice() -> None:
-    """Test accessing a subwindow with a timestamp slice"""
+    """Test accessing a subwindow with a timestamp slice."""
     window, sender = init_moving_window(timedelta(seconds=5))
     async with window:
         await push_logical_meter_data(sender, range(0, 5))
@@ -116,7 +114,7 @@ async def test_access_window_by_ts_slice() -> None:
 
 
 async def test_access_empty_window() -> None:
-    """Test accessing an empty window, should throw IndexError"""
+    """Test accessing an empty window, should throw IndexError."""
     window, _ = init_moving_window(timedelta(seconds=5))
     async with window:
         with pytest.raises(IndexError, match=r"^The buffer is empty\.$"):
diff --git a/tests/timeseries/test_periodic_feature_extractor.py b/tests/timeseries/test_periodic_feature_extractor.py
@@ -74,9 +74,7 @@ async def init_feature_extractor_no_data(
 
 
 async def test_interval_shifting() -> None:
-    """
-    Test if a interval is properly shifted into a moving window
-    """
+    """Test if a interval is properly shifted into a moving window."""
     async with init_feature_extractor(
         [1, 2, 2, 1, 1, 1, 2, 2, 1, 1], timedelta(seconds=5)
     ) as feature_extractor:
diff --git a/tests/timeseries/test_quantities.py b/tests/timeseries/test_quantities.py
diff --git a/tests/timeseries/test_resampling.py b/tests/timeseries/test_resampling.py
