novnc: Improve docstrings for coverage

Signed-off-by: Albert Esteve <aesteve@redhat.com>

Author: aesteve-rh

packages/jumpstarter-driver-network/jumpstarter_driver_network/adapters/novnc.py

@@ -11,6 +11,21 @@
 @blocking
 @asynccontextmanager
 async def NovncAdapter(*, client: DriverClient, method: str = "connect", encrypt: bool = True):
+    """
+    Provide a noVNC URL that proxies a temporary local TCP listener to a remote
+    driver stream via a WebSocket bridge.
+
+    Parameters:
+        client (DriverClient): Client used to open the remote stream that will be
+                               bridged to the local listener.
+        method (str): Name of the async stream method to call on the client (default "connect").
+        encrypt (bool): If True request an encrypted (TLS) vnc connection;
+                        if False request an unencrypted vnc connection.
+
+    Returns:
+        str: The URL to connect to the VNC session.
+    """
+
     async def handler(conn):
         async with conn:
             async with client.stream_async(method) as stream:

packages/jumpstarter-driver-vnc/jumpstarter_driver_vnc/client.py

@@ -21,7 +21,12 @@ class VNClient(CompositeClient):
 
     @property
     def tcp(self) -> TCPClient:
-        """Get the TCP client."""
+        """
+        Access the underlying TCP client.
+
+        Returns:
+            TCPClient: The TCP client instance stored in this composite client's children mapping.
+        """
         return typing.cast("TCPClient", self.children["tcp"])
 
     def stream(self, method="connect"):
@@ -34,7 +39,15 @@ async def stream_async(self, method="connect"):
 
     @contextlib.contextmanager
     def session(self, *, encrypt: bool = True) -> typing.Iterator[str]:
-        """Create a new VNC session."""
+        """
+        Open a noVNC session and yield the connection URL.
+
+        Parameters:
+            encrypt (bool): If True, request an encrypted vnc connection.
+
+        Returns:
+            url (str): The URL to connect to the VNC session.
+        """
         with NovncAdapter(client=self.tcp, method="connect", encrypt=encrypt) as adapter:
             yield adapter
 
@@ -43,11 +56,32 @@ def get_default_encrypt(self) -> bool:
         return self.portal.call(DriverClient.call_async, self, "get_default_encrypt")
 
     def cli(self) -> click.Command:
-        """Return a click command handler for this driver."""
+        """
+        Provide a Click command group for running VNC sessions.
+
+        The returned command exposes a `session` subcommand that opens a VNC session,
+        prints the connection URL, optionally opens it in the user's browser,
+        and waits until the user cancels the session.
+
+        Returns:
+            click.Command: Click command group with a `session` subcommand that accepts
+            `--browser/--no-browser` and `--encrypt/--no-encrypt` options.
+        """
 
         @driver_click_group(self)
         def vnc():
-            """Open a VNC session."""
+            """
+            Open a VNC session and block until the user closes it.
+
+            When invoked, prints the connection URL for the noVNC session, optionally
+            opens that URL in the user's web browser, and waits for user-initiated
+            termination (for example, Ctrl+C). On exit, prints a message indicating
+            the session is closing.
+
+            Parameters:
+                browser (bool): If True, open the session URL in the default web browser.
+                encrypt_override (bool): If True, request an encrypted vnc connection.
+            """
 
         @vnc.command()
         @click.option("--browser/--no-browser", default=True, help="Open the session in a web browser.")
@@ -56,16 +90,26 @@ def vnc():
             "encrypt_override",
             flag_value=True,
             default=None,
-            help="Force an encrypted connection (wss://). Overrides the driver default.",
+            help="Force an encrypted vnc connection. Overrides the driver default.",
         )
         @click.option(
             "--no-encrypt",
             "encrypt_override",
             flag_value=False,
-            help="Force an unencrypted connection (ws://). Overrides the driver default.",
+            help="Force an unencrypted vnc connection. Overrides the driver default.",
         )
         def session(browser: bool, encrypt_override: bool | None):
-            """Open a VNC session."""
+            """
+            Open an interactive VNC session and wait for the user to terminate it.
+
+            Starts a VNC session using the client's session context, prints the connection
+            URL, optionally opens that URL in a web browser, and blocks until the user
+            cancels (e.g., Ctrl+C), then closes the session.
+
+            Parameters:
+                browser (bool): If True, open the session URL in the default web browser.
+                encrypt (bool): If True, request noVNC to use an encrypted vnc connection.
+            """
             encrypt = encrypt_override if encrypt_override is not None else self.get_default_encrypt()
             # The NovncAdapter is a blocking context manager that runs in a thread.
             # We can enter it, open the browser, and then just wait for the user

packages/jumpstarter-driver-vnc/jumpstarter_driver_vnc/driver.py

@@ -19,7 +19,13 @@ class Vnc(Composite):
     default_encrypt: bool = False
 
     def __post_init__(self):
-        """Initialize the VNC driver."""
+        """
+        Validate the VNC driver's post-initialization configuration.
+        Ensures the driver has a "tcp" child configured.
+
+        Raises:
+            ConfigurationError: If a "tcp" child is not present.
+        """
         super().__post_init__()
         if "tcp" not in self.children:
             raise ConfigurationError("A tcp child is required for Vnc")
@@ -31,5 +37,10 @@ async def get_default_encrypt(self) -> bool:
 
     @classmethod
     def client(cls) -> str:
-        """Return the client class path for this driver."""
+        """
+        Client class path for this driver.
+
+        Returns:
+            str: Dotted import path of the client class.
+        """
         return "jumpstarter_driver_vnc.client.VNClient"