Add back docstrings

Author: greschd

tests/launcher/integration/simple_test_launcher.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Simple launcher for testing module."""
 
 import dataclasses
 import pathlib
@@ -40,6 +41,8 @@
 
 @dataclasses.dataclass
 class SimpleLauncherConfig:
+    """Configuration for the SimpleLauncher."""
+
     script_path: str = dataclasses.field(
         default=str(SCRIPT_PATH),
         metadata={METADATA_KEY_DOC: "Location of the server Python script."},
@@ -50,10 +53,13 @@ class SimpleLauncherConfig:
 
 
 class SimpleLauncher(LauncherProtocol[SimpleLauncherConfig]):
+    """Simple launcher for testing."""
+
     CONFIG_MODEL = SimpleLauncherConfig
     SERVER_SPEC = {SERVER_KEY: ServerType.GRPC}
 
     def __init__(self, *, config: SimpleLauncherConfig):
+        """Initialize the SimpleLauncher with the given configuration."""
         self._script_path = config.script_path
         self._transport_options = config.transport_options
         if self._transport_options.mode != "uds":
@@ -69,6 +75,7 @@ def __init__(self, *, config: SimpleLauncherConfig):
         self._url = f"unix:{self._uds_file}"
 
     def start(self):
+        """Start the service."""
         self._process = subprocess.Popen(
             [
                 sys.executable,
@@ -81,6 +88,7 @@ def start(self):
         )
 
     def stop(self, *, timeout=None):
+        """Stop the service."""
         self._process.terminate()
         try:
             self._process.wait(timeout=timeout)
@@ -92,9 +100,11 @@ def stop(self, *, timeout=None):
         self._uds_file.unlink(missing_ok=True)
 
     def check(self, *, timeout: float | None = None) -> bool:
-        channel = self._transport_options.create_channel()
+        """Check if the server is responding to requests."""
+        channel = grpc.insecure_channel(self.urls[SERVER_KEY])
         return check_grpc_health(channel, timeout=timeout)
 
     @property
-    def transport_options(self):
-        return {SERVER_KEY: self._transport_options}
+    def urls(self):
+        """Return the URLs of the server."""
+        return {SERVER_KEY: self._url}

tests/launcher/integration/simple_test_server.py

@@ -29,6 +29,7 @@
 
 
 def main(uds_dir: str):
+    """Run the simple test server."""
     uds_file = pathlib.Path(uds_dir) / "simple_test_service.sock"
     if uds_file.exists():
         print(f"UDS file {uds_file} already exists.")

tests/launcher/integration/test_simple_launcher.py

@@ -40,15 +40,18 @@ class OtherConfig:
 
 @pytest.fixture(autouse=True)
 def monkeypatch_entrypoints(monkeypatch_entrypoints_from_plugins):
+    """Mock the entry points for the launcher plugins."""
     monkeypatch_entrypoints_from_plugins({PRODUCT_NAME: {"direct": SimpleLauncher}})
 
 
 def check_uds_file_removed(server):
+    """Check that the UDS file has been removed after stopping the server."""
     uds_file = pathlib.Path(server._launcher.transport_options["main"].uds_dir) / "simple_test_service.sock"
     assert not pathlib.Path(uds_file).exists()
 
 
 def test_default_config():
+    """Test the default configuration."""
     config.set_config_for(product_name=PRODUCT_NAME, launch_mode=LAUNCH_MODE, config=SimpleLauncherConfig())
     server = launch_product(PRODUCT_NAME)
     server.wait(timeout=10)
@@ -58,6 +61,7 @@ def test_default_config():
 
 
 def test_explicit_config():
+    """Test that the server can be launched with an explicit configuration."""
     server = launch_product(PRODUCT_NAME, launch_mode=LAUNCH_MODE, config=SimpleLauncherConfig())
     server.wait(timeout=10)
     server.stop()
@@ -66,6 +70,7 @@ def test_explicit_config():
 
 
 def test_stop_with_timeout():
+    """Test that the server can be stopped with a timeout and that it stops correctly."""
     server = launch_product(PRODUCT_NAME, launch_mode=LAUNCH_MODE, config=SimpleLauncherConfig())
     server.wait(timeout=10)
     server.stop(timeout=1.0)
@@ -74,16 +79,19 @@ def test_stop_with_timeout():
 
 
 def test_invalid_launch_mode_raises():
+    """Test that passing an invalid launch mode raises a KeyError."""
     with pytest.raises(KeyError):
         launch_product(PRODUCT_NAME, launch_mode="invalid_launch_mode", config=SimpleLauncherConfig())
 
 
 def test_invalid_config_raises():
+    """Test that passing an invalid configuration type raises a TypeError."""
     with pytest.raises(TypeError):
         launch_product(PRODUCT_NAME, launch_mode=LAUNCH_MODE, config=OtherConfig(int_attr=3))
 
 
 def test_contextmanager():
+    """Test that the context manager works correctly, starting and stopping the server."""
     with launch_product(PRODUCT_NAME, launch_mode=LAUNCH_MODE, config=SimpleLauncherConfig()) as server:
         server.wait(timeout=10)
         assert server.check()