conson-xp 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

xp/cli/commands/conbus/conbus_linknumber_commands.py

@@ -22,15 +22,15 @@ from xp.services.conbus.conbus_linknumber_set_service import ConbusLinknumberSet
 def set_linknumber_command(
     ctx: click.Context, serial_number: str, link_number: int
 ) -> None:
-    """
-    Set the link number for a specific module.
+    r"""Set the link number for a specific module.
 
-    SERIAL_NUMBER: 10-digit module serial number
-    LINK_NUMBER: Link number to set (0-99)
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        link_number: Link number to set (0-99).
 
     Examples:
-
-    \b
+        \b
         xp conbus linknumber set 0123450001 25
     """
     service = (
@@ -38,6 +38,11 @@ def set_linknumber_command(
     )
 
     def on_finish(response: ConbusLinknumberResponse) -> None:
+        """Handle successful completion of link number set command.
+
+        Args:
+            response: Link number response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     with service:
@@ -53,14 +58,14 @@ def set_linknumber_command(
 @click.pass_context
 @connection_command()
 def get_linknumber_command(ctx: click.Context, serial_number: str) -> None:
-    """
-    Get the current link number for a specific module.
+    r"""Get the current link number for a specific module.
 
-    SERIAL_NUMBER: 10-digit module serial number
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
     Examples:
-
-    \b
+        \b
         xp conbus linknumber get 0123450001
     """
     service = (
@@ -68,6 +73,11 @@ def get_linknumber_command(ctx: click.Context, serial_number: str) -> None:
     )
 
     def on_finish(response: ConbusLinknumberResponse) -> None:
+        """Handle successful completion of link number get command.
+
+        Args:
+            response: Link number response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     with service:

xp/cli/commands/conbus/conbus_msactiontable_commands.py

@@ -26,13 +26,29 @@ from xp.services.conbus.actiontable.msactiontable_service import (
 def conbus_download_msactiontable(
     ctx: Context, serial_number: str, xpmoduletype: str
 ) -> None:
-    """Download MS action table from XP24 module"""
+    """Download MS action table from XP24 module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        xpmoduletype: XP module type.
+    """
     service = ctx.obj.get("container").get_container().resolve(MsActionTableService)
 
     def progress_callback(progress: str) -> None:
+        """Handle progress updates during MS action table download.
+
+        Args:
+            progress: Progress message string.
+        """
         click.echo(progress, nl=False)
 
     def finish_callback(action_table: ActionTable) -> None:
+        """Handle successful completion of MS action table download.
+
+        Args:
+            action_table: Downloaded MS action table object.
+        """
         output = {
             "serial_number": serial_number,
             "xpmoduletype": xpmoduletype,
@@ -41,6 +57,14 @@ def conbus_download_msactiontable(
         click.echo(json.dumps(output, indent=2, default=str))
 
     def error_callback(error: str) -> None:
+        """Handle errors during MS action table download.
+
+        Args:
+            error: Error message string.
+
+        Raises:
+            Abort: Always raised to abort the command on error.
+        """
         click.echo(f"Error: {error}")
         raise click.Abort()
 

xp/cli/commands/conbus/conbus_output_commands.py

@@ -23,16 +23,25 @@ from xp.services.conbus.conbus_output_service import ConbusOutputService
 @click.pass_context
 @connection_command()
 def xp_output_on(ctx: click.Context, serial_number: str, output_number: int) -> None:
-    """Send ON command for output_number XP module serial_number
+    r"""Send ON command for output_number XP module serial_number.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number.
 
-    \b
+    Examples:
+        \b
         xp conbus output on 0011223344 0  # Turn on output 0
     """
     service = ctx.obj.get("container").get_container().resolve(ConbusOutputService)
 
     def on_finish(response: ConbusOutputResponse) -> None:
+        """Handle successful completion of output on command.
+
+        Args:
+            response: Output response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     with service:
@@ -50,16 +59,25 @@ def xp_output_on(ctx: click.Context, serial_number: str, output_number: int) ->
 @click.pass_context
 @connection_command()
 def xp_output_off(ctx: click.Context, serial_number: str, output_number: int) -> None:
-    """Send OFF command for output_number XP module serial_number
+    r"""Send OFF command for output_number XP module serial_number.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number.
 
-    \b
+    Examples:
+        \b
         xp conbus output off 0011223344 1    # Turn off output 1
     """
     service = ctx.obj.get("container").get_container().resolve(ConbusOutputService)
 
     def on_finish(response: ConbusOutputResponse) -> None:
+        """Handle successful completion of output off command.
+
+        Args:
+            response: Output response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     with service:
@@ -76,11 +94,14 @@ def xp_output_off(ctx: click.Context, serial_number: str, output_number: int) ->
 @click.pass_context
 @connection_command()
 def xp_output_status(ctx: click.Context, serial_number: str) -> None:
-    """Query output state command to XP module serial_number.
+    r"""Query output state command to XP module serial_number.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
-    \b
+    Examples:
+        \b
         xp conbus output status 0011223344    # Query output status
     """
     service: ConbusDatapointService = (
@@ -88,6 +109,11 @@ def xp_output_status(ctx: click.Context, serial_number: str) -> None:
     )
 
     def on_finish(response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of output status query.
+
+        Args:
+            response: Datapoint response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     with service:
@@ -103,11 +129,14 @@ def xp_output_status(ctx: click.Context, serial_number: str) -> None:
 @click.pass_context
 @connection_command()
 def xp_module_state(ctx: click.Context, serial_number: str) -> None:
-    """Query module state of the XP module serial_number
+    r"""Query module state of the XP module serial_number.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
-    \b
+    Examples:
+        \b
         xp conbus output state 0011223344    # Query module state
     """
     service: ConbusDatapointService = (
@@ -115,6 +144,11 @@ def xp_module_state(ctx: click.Context, serial_number: str) -> None:
     )
 
     def on_finish(response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of module state query.
+
+        Args:
+            response: Datapoint response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     with service:

xp/cli/commands/conbus/conbus_raw_commands.py

@@ -18,28 +18,39 @@ from xp.services.conbus.conbus_raw_service import ConbusRawService
 @click.pass_context
 @connection_command()
 def send_raw_telegrams(ctx: Context, raw_telegrams: str) -> None:
-    """
-    Send raw telegram sequence to Conbus server.
+    r"""Send raw telegram sequence to Conbus server.
 
     Accepts a string containing one or more telegrams in format <...>.
     Multiple telegrams should be concatenated without separators.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        raw_telegrams: Raw telegram string(s).
 
-    \b
+    Examples:
+        \b
         xp conbus raw '<S2113010000F02D12>'
         xp conbus raw '<S2113010000F02D12><S2113010001F02D12><S2113010002F02D12>'
-        xp conbus raw '<S0012345003F02D12FM><S0012345004F02D12FD><S0012345005F02D12FI><S0012345006F02D12FL><S0012345007F02D12FK><S0012345008F02D12FJ><S0012345009F02D12FF>'
+        xp conbus raw '<S0012345003F02D12FM>...<S0012345009F02D12FF>'
     """
     service: ConbusRawService = (
         ctx.obj.get("container").get_container().resolve(ConbusRawService)
     )
 
     def on_progress(message: str) -> None:
+        """Handle progress updates during raw telegram sending.
+
+        Args:
+            message: Progress message string.
+        """
         click.echo(message)
-        pass
 
     def on_finish(service_response: ConbusRawResponse) -> None:
+        """Handle successful completion of raw telegram sending.
+
+        Args:
+            service_response: Raw response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service:

xp/cli/commands/conbus/conbus_receive_commands.py

@@ -20,29 +20,37 @@ from xp.services.conbus.conbus_receive_service import (
 @connection_command()
 @click.pass_context
 def receive_telegrams(ctx: Context, timeout: float) -> None:
-    """
-    Receive waiting event telegrams from Conbus server.
+    r"""Receive waiting event telegrams from Conbus server.
 
     Connects to the Conbus server and receives any waiting event telegrams
     without sending any data first. Useful for collecting pending notifications
     or events from the server.
 
-    Arguments:
-        :param timeout: Timeout in seconds for receiving telegrams (default: 2.0)
+    Args:
+        ctx: Click context object.
+        timeout: Timeout in seconds for receiving telegrams (default: 2.0).
 
     Examples:
-
-    \b
+        \b
         xp conbus receive
         xp conbus receive 5.0
     """
 
     def finish(response_received: ConbusReceiveResponse) -> None:
+        """Handle successful completion of telegram receive operation.
+
+        Args:
+            response_received: Receive response object with telegrams.
+        """
         click.echo(json.dumps(response_received.to_dict(), indent=2))
 
     def progress(telegram_received: str) -> None:
+        """Handle progress updates during telegram receive operation.
+
+        Args:
+            telegram_received: Received telegram string.
+        """
         click.echo(telegram_received)
-        pass
 
     service = ctx.obj.get("container").get_container().resolve(ConbusReceiveService)
     with service:

xp/cli/commands/conbus/conbus_scan_commands.py

@@ -18,12 +18,15 @@ from xp.services.conbus.conbus_scan_service import ConbusScanService
 @click.pass_context
 @connection_command()
 def scan_module(ctx: Context, serial_number: str, function_code: str) -> None:
-    """
-    Scan all datapoints of a function_code for a module.
+    r"""Scan all datapoints of a function_code for a module.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        function_code: Function code.
 
-    \b
+    Examples:
+        \b
         xp conbus scan 0012345011 02 # Scan all datapoints of function Read data points (02)
     """
     service: ConbusScanService = (
@@ -31,9 +34,19 @@ def scan_module(ctx: Context, serial_number: str, function_code: str) -> None:
     )
 
     def on_progress(progress: str) -> None:
+        """Handle progress updates during module scan.
+
+        Args:
+            progress: Progress message string.
+        """
         click.echo(progress)
 
     def on_finish(service_response: ConbusResponse) -> None:
+        """Handle successful completion of module scan.
+
+        Args:
+            service_response: Scan response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service:

xp/cli/commands/file_commands.py

@@ -18,9 +18,7 @@ from xp.cli.utils.formatters import OutputFormatter, StatisticsFormatter
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def file() -> None:
-    """
-    File operations for console bus logs
-    """
+    """Perform file operations for console bus logs."""
     pass
 
 
@@ -38,13 +36,22 @@ def decode_log_file(
     time_range: str,
     summary: bool,
 ) -> None:
-    """
-    Decode and parse console bus log file.
+    r"""Decode and parse console bus log file.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        log_file_path: Path to the log file to decode.
+        filter_type: Filter by telegram type.
+        filter_direction: Filter by telegram direction.
+        time_range: Filter by time range.
+        summary: Show summary statistics only.
 
-    \b
+    Examples:
+        \b
         xp file decode conbus.log
+
+    Raises:
+        SystemExit: If time range is invalid or log file cannot be parsed.
     """
     from xp.services.log_file_service import LogFileService
     from xp.utils.time_utils import TimeParsingError, parse_time_range
@@ -105,12 +112,14 @@ def decode_log_file(
 @click.pass_context
 @handle_service_errors(Exception)
 def analyze_log_file(ctx: Context, log_file_path: str) -> None:
-    """
-    Analyze console bus log file for patterns and statistics.
+    r"""Analyze console bus log file for patterns and statistics.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        log_file_path: Path to the log file to analyze.
 
-    \b
+    Examples:
+        \b
         xp file analyze conbus.log
     """
     from xp.services.log_file_service import LogFileService
@@ -135,12 +144,14 @@ def analyze_log_file(ctx: Context, log_file_path: str) -> None:
 @click.pass_context
 @handle_service_errors(Exception)
 def validate_log_file(ctx: Context, log_file_path: str) -> None:
-    """
-    Validate console bus log file format and telegram checksums.
+    r"""Validate console bus log file format and telegram checksums.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        log_file_path: Path to the log file to validate.
 
-    \b
+    Examples:
+        \b
         xp file validate conbus.log
     """
     from xp.services.log_file_service import LogFileService

xp/cli/commands/homekit/homekit.py

@@ -10,11 +10,7 @@ from xp.cli.utils.decorators import service_command
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def homekit() -> None:
-    """
-    HomeKit management commands.
-
-    Manage the HomeKit server for XP Protocol operations.
-    """
+    """Manage the HomeKit server for XP Protocol operations."""
     pass
 
 
@@ -22,7 +18,7 @@ def homekit() -> None:
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def config() -> None:
-    """HomeKit configuration management"""
+    """Manage HomeKit configuration."""
     pass
 
 
@@ -39,7 +35,12 @@ def config() -> None:
 )
 @service_command()
 def validate(conson_config: str, homekit_config: str) -> None:
-    """Validate homekit.yml and conson.yml coherence"""
+    """Validate homekit.yml and conson.yml coherence.
+
+    Args:
+        conson_config: Path to conson.yml configuration file.
+        homekit_config: Path to homekit.yml configuration file.
+    """
     from xp.services.homekit.homekit_config_validator import ConfigValidationService
 
     try:
@@ -97,7 +98,12 @@ def validate(conson_config: str, homekit_config: str) -> None:
 )
 @service_command()
 def show_config(conson_config: str, homekit_config: str) -> None:
-    """Display parsed configuration summary"""
+    """Display parsed configuration summary.
+
+    Args:
+        conson_config: Path to conson.yml configuration file.
+        homekit_config: Path to homekit.yml configuration file.
+    """
     from xp.services.homekit.homekit_config_validator import ConfigValidationService
 
     try:

xp/cli/commands/homekit/homekit_start_commands.py

@@ -12,18 +12,18 @@ from xp.services.homekit.homekit_service import HomeKitService
 @homekit.command("start")
 @click.pass_context
 def homekit_start(ctx: Context) -> None:
-    """
-    Start the HomeKit server.
+    r"""Start the HomeKit server.
 
     This command starts the XP Protocol HomeKit server using HAP-python.
     The server provides HomeKit endpoints for Conbus operations.
 
-    Examples:
+    Args:
+        ctx: Click context object.
 
-    \b
+    Examples:
+        \b
         # Start server on default host and port
         xp homekit start
-
     """
     click.echo("Starting XP Protocol HomeKit server...")
 

xp/cli/commands/module_commands.py

@@ -17,9 +17,7 @@ from xp.services.module_type_service import ModuleTypeNotFoundError, ModuleTypeS
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def module() -> None:
-    """
-    Module type operations
-    """
+    """Perform module type operations."""
     pass
 
 
@@ -28,12 +26,14 @@ def module() -> None:
 @click.pass_context
 @list_command(ModuleTypeNotFoundError)
 def module_info(ctx: Context, identifier: str) -> None:
-    """
-    Get information about a module type by code or name.
+    r"""Get information about a module type by code or name.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        identifier: Module code or name.
 
-    \b
+    Examples:
+        \b
         xp module info 14
         xp module info XP2606
     """
@@ -63,12 +63,15 @@ def module_info(ctx: Context, identifier: str) -> None:
 @click.pass_context
 @list_command(Exception)
 def module_list(ctx: Context, category: str, group_by_category: bool) -> None:
-    """
-    List module types, optionally filtered by category.
+    r"""List module types, optionally filtered by category.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        category: Filter by category.
+        group_by_category: Group modules by category.
 
-    \b
+    Examples:
+        \b
         xp module list
         xp module list --category "Interface Panels"
         xp module list --group-by-category
@@ -115,12 +118,15 @@ def module_list(ctx: Context, category: str, group_by_category: bool) -> None:
 @click.pass_context
 @list_command(Exception)
 def module_search(ctx: Context, query: str, field: tuple) -> None:
-    """
-    Search for module types by name or description.
+    r"""Search for module types by name or description.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        query: Search query.
+        field: Fields to search in.
 
-    \b
+    Examples:
+        \b
         xp module search "push button"
         xp module search --field name "XP"
     """
@@ -147,12 +153,13 @@ def module_search(ctx: Context, query: str, field: tuple) -> None:
 @click.pass_context
 @list_command(Exception)
 def module_categories(ctx: Context) -> None:
-    """
-    List all available module categories.
+    r"""List all available module categories.
 
-    Examples:
+    Args:
+        ctx: Click context object.
 
-    \b
+    Examples:
+        \b
         xp module categories
     """
     service = ctx.obj.get("container").get_container().resolve(ModuleTypeService)