conson-xp 1.45.0__py3-none-any.whl → 1.47.0__py3-none-any.whl

xp/cli/commands/conbus/conbus_scan_commands.py

@@ -18,7 +18,8 @@ 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:
-    r"""Scan all datapoints of a function_code for a module.
+    r"""
+    Scan all datapoints of a function_code for a module.
 
     Args:
         ctx: Click context object.
@@ -34,7 +35,8 @@ def scan_module(ctx: Context, serial_number: str, function_code: str) -> None:
     )
 
     def on_progress(progress: str) -> None:
-        """Handle progress updates during module scan.
+        """
+        Handle progress updates during module scan.
 
         Args:
             progress: Progress message string.
@@ -42,7 +44,8 @@ def scan_module(ctx: Context, serial_number: str, function_code: str) -> None:
         click.echo(progress)
 
     def on_finish(service_response: ConbusResponse) -> None:
-        """Handle successful completion of module scan.
+        """
+        Handle successful completion of module scan.
 
         Args:
             service_response: Scan response object.

xp/cli/commands/file_commands.py

@@ -36,7 +36,8 @@ def decode_log_file(
     time_range: str,
     summary: bool,
 ) -> None:
-    r"""Decode and parse console bus log file.
+    r"""
+    Decode and parse console bus log file.
 
     Args:
         ctx: Click context object.
@@ -114,7 +115,8 @@ def decode_log_file(
 @click.pass_context
 @handle_service_errors(Exception)
 def analyze_log_file(ctx: Context, log_file_path: str) -> None:
-    r"""Analyze console bus log file for patterns and statistics.
+    r"""
+    Analyze console bus log file for patterns and statistics.
 
     Args:
         ctx: Click context object.
@@ -148,7 +150,8 @@ 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:
-    r"""Validate console bus log file format and telegram checksums.
+    r"""
+    Validate console bus log file format and telegram checksums.
 
     Args:
         ctx: Click context object.

xp/cli/commands/homekit/homekit.py

@@ -35,7 +35,8 @@ 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.
@@ -98,7 +99,8 @@ 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.

xp/cli/commands/homekit/homekit_start_commands.py

@@ -12,7 +12,8 @@ from xp.services.homekit.homekit_service import HomeKitService
 @homekit.command("start")
 @click.pass_context
 def homekit_start(ctx: Context) -> None:
-    r"""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.

xp/cli/commands/module_commands.py

@@ -26,7 +26,8 @@ def module() -> None:
 @click.pass_context
 @list_command(ModuleTypeNotFoundError)
 def module_info(ctx: Context, identifier: str) -> None:
-    r"""Get information about a module type by code or name.
+    r"""
+    Get information about a module type by code or name.
 
     Args:
         ctx: Click context object.
@@ -65,7 +66,8 @@ 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:
-    r"""List module types, optionally filtered by category.
+    r"""
+    List module types, optionally filtered by category.
 
     Args:
         ctx: Click context object.
@@ -122,7 +124,8 @@ 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:
-    r"""Search for module types by name or description.
+    r"""
+    Search for module types by name or description.
 
     Args:
         ctx: Click context object.
@@ -159,7 +162,8 @@ def module_search(ctx: Context, query: str, field: tuple) -> None:
 @click.pass_context
 @list_command(Exception)
 def module_categories(ctx: Context) -> None:
-    r"""List all available module categories.
+    r"""
+    List all available module categories.
 
     Args:
         ctx: Click context object.

xp/cli/commands/reverse_proxy_commands.py

@@ -41,7 +41,8 @@ def reverse_proxy() -> None:
 @handle_service_errors(ReverseProxyError)
 @click.pass_context
 def start_proxy(ctx: Context, port: int, config: str) -> None:
-    r"""Start the Conbus reverse proxy server.
+    r"""
+    Start the Conbus reverse proxy server.
 
     The proxy listens on the specified port and forwards all telegrams
     to the target server configured in cli.yml. All traffic is monitored
@@ -80,7 +81,8 @@ def start_proxy(ctx: Context, port: int, config: str) -> None:
 
         # Handle graceful shutdown on SIGINT
         def signal_handler(signum: int, frame: Optional[FrameType]) -> None:
-            """Handle shutdown signals for graceful proxy termination.
+            """
+            Handle shutdown signals for graceful proxy termination.
 
             Args:
                 signum: Signal number received.
@@ -116,7 +118,8 @@ def start_proxy(ctx: Context, port: int, config: str) -> None:
 @reverse_proxy.command("stop")
 @handle_service_errors(ReverseProxyError)
 def stop_proxy() -> None:
-    r"""Stop the running Conbus reverse proxy server.
+    r"""
+    Stop the running Conbus reverse proxy server.
 
     Examples:
         \b
@@ -146,7 +149,8 @@ def stop_proxy() -> None:
 @reverse_proxy.command("status")
 @handle_service_errors(Exception)
 def proxy_status() -> None:
-    r"""Get status of the Conbus reverse proxy server.
+    r"""
+    Get status of the Conbus reverse proxy server.
 
     Shows current running state, listen port, target server,
     and active connection details.

xp/cli/commands/server/server_commands.py

@@ -32,7 +32,8 @@ def server() -> None:
 @click.pass_context
 @handle_service_errors(ServerError)
 def start_server(ctx: Context, port: int, config: str) -> None:
-    r"""Start the Conbus emulator server.
+    r"""
+    Start the Conbus emulator server.
 
     Args:
         ctx: Click context object.
@@ -80,7 +81,8 @@ def start_server(ctx: Context, port: int, config: str) -> None:
 @server.command("stop")
 @handle_service_errors(ServerError)
 def stop_server() -> None:
-    r"""Stop the running Conbus emulator server.
+    r"""
+    Stop the running Conbus emulator server.
 
     Examples:
         \b
@@ -104,7 +106,8 @@ def stop_server() -> None:
 @server.command("status")
 @handle_service_errors(Exception)
 def server_status() -> None:
-    r"""Get status of the Conbus emulator server.
+    r"""
+    Get status of the Conbus emulator server.
 
     Examples:
         \b

xp/cli/commands/telegram/telegram_blink_commands.py

@@ -16,7 +16,8 @@ from xp.services.telegram.telegram_blink_service import BlinkError, TelegramBlin
 @click.argument("serial_number", type=SERIAL)
 @handle_service_errors(BlinkError)
 def blink_on(serial_number: str) -> None:
-    r"""Generate a telegram to start blinking module LED.
+    r"""
+    Generate a telegram to start blinking module LED.
 
     Args:
         serial_number: 10-digit module serial number.
@@ -50,7 +51,8 @@ def blink_on(serial_number: str) -> None:
 @click.argument("serial_number", type=SERIAL)
 @handle_service_errors(BlinkError)
 def blink_off(serial_number: str) -> None:
-    r"""Generate a telegram to stop blinking module LED.
+    r"""
+    Generate a telegram to stop blinking module LED.
 
     Args:
         serial_number: 10-digit module serial number.

xp/cli/commands/telegram/telegram_checksum_commands.py

@@ -22,7 +22,8 @@ from xp.services.telegram.telegram_checksum_service import TelegramChecksumServi
 )
 @handle_service_errors(Exception)
 def calculate_checksum(data: str, algorithm: str) -> None:
-    r"""Calculate checksum for given data string.
+    r"""
+    Calculate checksum for given data string.
 
     Args:
         data: Data string to calculate checksum for.
@@ -70,7 +71,8 @@ def calculate_checksum(data: str, algorithm: str) -> None:
 )
 @handle_service_errors(Exception)
 def validate_checksum(data: str, expected_checksum: str, algorithm: str) -> None:
-    r"""Validate data against expected checksum.
+    r"""
+    Validate data against expected checksum.
 
     Args:
         data: Data string to validate.

xp/cli/commands/telegram/telegram_discover_commands.py

@@ -17,7 +17,8 @@ from xp.services.telegram.telegram_discover_service import (
 @telegram.command("discover")
 @handle_service_errors(DiscoverError)
 def generate_discover() -> None:
-    r"""Generate a discover telegram for device enumeration.
+    r"""
+    Generate a discover telegram for device enumeration.
 
     Examples:
         \b

xp/cli/commands/telegram/telegram_linknumber_commands.py

@@ -20,7 +20,8 @@ from xp.services.telegram.telegram_link_number_service import (
 @click.argument("link_number", type=int)
 @handle_service_errors(LinkNumberError)
 def generate_set_link_number(serial_number: str, link_number: int) -> None:
-    r"""Generate a telegram to set module link number.
+    r"""
+    Generate a telegram to set module link number.
 
     Args:
         serial_number: 10-digit module serial number.
@@ -57,7 +58,8 @@ def generate_set_link_number(serial_number: str, link_number: int) -> None:
 @click.argument("serial_number", type=SERIAL)
 @handle_service_errors(LinkNumberError)
 def generate_read_link_number(serial_number: str) -> None:
-    r"""Generate a telegram to read module link number.
+    r"""
+    Generate a telegram to read module link number.
 
     Args:
         serial_number: 10-digit module serial number.

xp/cli/commands/telegram/telegram_parse_commands.py

@@ -17,7 +17,8 @@ from xp.services.telegram.telegram_service import TelegramParsingError, Telegram
 @click.argument("telegram_string")
 @handle_service_errors(TelegramParsingError)
 def parse_any_telegram(telegram_string: str) -> None:
-    r"""Auto-detect and parse any type of telegram (event, system, reply, or discover).
+    r"""
+    Auto-detect and parse any type of telegram (event, system, reply, or discover).
 
     Args:
         telegram_string: Telegram string to parse.
@@ -47,7 +48,8 @@ def parse_any_telegram(telegram_string: str) -> None:
 @click.argument("telegram_string")
 @handle_service_errors(TelegramParsingError)
 def validate_telegram(telegram_string: str) -> None:
-    r"""Validate the format of an event telegram.
+    r"""
+    Validate the format of an event telegram.
 
     Args:
         telegram_string: Telegram string to validate.

xp/cli/commands/telegram/telegram_version_commands.py

@@ -19,7 +19,8 @@ from xp.services.telegram.telegram_version_service import (
 @click.argument("serial_number", type=SERIAL)
 @handle_service_errors(VersionParsingError)
 def generate_version_request(serial_number: str) -> None:
-    r"""Generate a telegram to request version information from a device.
+    r"""
+    Generate a telegram to request version information from a device.
 
     Args:
         serial_number: 10-digit module serial number.

xp/cli/commands/term/term_commands.py

@@ -9,7 +9,8 @@ from xp.cli.commands.term.term import term
 @term.command("protocol")
 @click.pass_context
 def protocol_monitor(ctx: Context) -> None:
-    r"""Start TUI for real-time protocol monitoring.
+    r"""
+    Start TUI for real-time protocol monitoring.
 
     Displays live RX/TX telegram stream from Conbus server
     in an interactive terminal interface.
@@ -30,7 +31,8 @@ def protocol_monitor(ctx: Context) -> None:
 @term.command("state")
 @click.pass_context
 def state_monitor(ctx: Context) -> None:
-    r"""Start TUI for module state monitoring.
+    r"""
+    Start TUI for module state monitoring.
 
     Displays module states from Conson configuration with real-time
     updates in an interactive terminal interface.

xp/cli/main.py

@@ -28,7 +28,8 @@ from xp.utils.logging import LoggerService
 @click.version_option()
 @click.pass_context
 def cli(ctx: click.Context) -> None:
-    """XP CLI tool for remote console bus operations.
+    """
+    XP CLI tool for remote console bus operations.
 
     Args:
         ctx: Click context object for passing state between commands.

xp/cli/utils/click_tree.py

@@ -6,7 +6,8 @@ import click
 
 
 def add_tree_command(cli_group: click.Group, command_name: str = "help") -> Any:
-    """Add a tree command to any Click group.
+    """
+    Add a tree command to any Click group.
 
     Args:
         cli_group: The Click group to add the tree command to.
@@ -17,7 +18,8 @@ def add_tree_command(cli_group: click.Group, command_name: str = "help") -> Any:
     """
 
     def print_command_tree(group: click.Group, ctx: click.Context, suffix: str) -> None:
-        """Print command tree recursively.
+        """
+        Print command tree recursively.
 
         Args:
             group: The Click group to print.
@@ -39,7 +41,8 @@ def add_tree_command(cli_group: click.Group, command_name: str = "help") -> Any:
     @cli_group.command(command_name)
     @click.pass_context
     def tree_command(ctx: click.Context) -> None:
-        """Show complete command tree.
+        """
+        Show complete command tree.
 
         Args:
             ctx: The Click context.

xp/cli/utils/datapoint_type_choice.py

@@ -9,7 +9,8 @@ from xp.models.telegram.datapoint_type import DataPointType
 
 # noinspection DuplicatedCode
 class DatapointTypeChoice(click.ParamType):
-    """Click parameter type for validating DataPointType enum values.
+    """
+    Click parameter type for validating DataPointType enum values.
 
     Attributes:
         name: The parameter type name.
@@ -25,7 +26,8 @@ class DatapointTypeChoice(click.ParamType):
     def convert(
         self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]
     ) -> Any:
-        """Convert and validate input to DataPointType enum.
+        """
+        Convert and validate input to DataPointType enum.
 
         Args:
             value: The input value to convert.

xp/cli/utils/decorators.py

@@ -11,7 +11,8 @@ from xp.cli.utils.formatters import OutputFormatter
 def handle_service_errors(
     *service_exceptions: Type[Exception],
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Handle common service exceptions with consistent JSON error formatting.
+    """
+    Handle common service exceptions with consistent JSON error formatting.
 
     Args:
         service_exceptions: Tuple of exception types to catch and handle.
@@ -21,7 +22,8 @@ def handle_service_errors(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply error handling to the decorated function.
+        """
+        Apply error handling to the decorated function.
 
         Args:
             func: The function to decorate.
@@ -32,7 +34,8 @@ def handle_service_errors(
 
         @functools.wraps(func)
         def wrapper(*args: Any, **kwargs: Any) -> Any:
-            """Execute function with error handling.
+            """
+            Execute function with error handling.
 
             Args:
                 args: Positional arguments passed to the decorated function.
@@ -64,7 +67,8 @@ def handle_service_errors(
 
 
 def common_options(func: Callable[..., Any]) -> Callable[..., Any]:
-    """Add validation option to command.
+    """
+    Add validation option to command.
 
     Args:
         func: The function to decorate.
@@ -78,7 +82,8 @@ def common_options(func: Callable[..., Any]) -> Callable[..., Any]:
 def telegram_parser_command(
     service_exceptions: Tuple[Type[Exception], ...] = (),
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Apply telegram parsing commands with standard error handling.
+    """
+    Apply telegram parsing commands with standard error handling.
 
     Args:
         service_exceptions: Additional service exceptions to handle.
@@ -88,7 +93,8 @@ def telegram_parser_command(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply telegram parser decorators.
+        """
+        Apply telegram parser decorators.
 
         Args:
             func: The function to decorate.
@@ -113,7 +119,8 @@ def telegram_parser_command(
 def service_command(
     *service_exceptions: Type[Exception],
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Apply service-based commands with error handling and JSON output.
+    """
+    Apply service-based commands with error handling and JSON output.
 
     Args:
         service_exceptions: Service exception types to handle.
@@ -123,7 +130,8 @@ def service_command(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply service command decorators.
+        """
+        Apply service command decorators.
 
         Args:
             func: The function to decorate.
@@ -140,7 +148,8 @@ def service_command(
 def list_command(
     *service_exceptions: Type[Exception],
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Apply list/search commands with common options.
+    """
+    Apply list/search commands with common options.
 
     Args:
         service_exceptions: Service exception types to handle.
@@ -150,7 +159,8 @@ def list_command(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply list command decorators.
+        """
+        Apply list command decorators.
 
         Args:
             func: The function to decorate.
@@ -165,14 +175,16 @@ def list_command(
 
 
 def file_operation_command() -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Apply file operation commands with common filters.
+    """
+    Apply file operation commands with common filters.
 
     Returns:
         Decorator function for file operation commands.
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply file operation decorators.
+        """
+        Apply file operation decorators.
 
         Args:
             func: The function to decorate.
@@ -201,7 +213,8 @@ def file_operation_command() -> Callable[[Callable[..., Any]], Callable[..., Any
 def with_formatter(
     formatter_class: Any = None,
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Inject a formatter instance into the command.
+    """
+    Inject a formatter instance into the command.
 
     Args:
         formatter_class: Custom formatter class to use.
@@ -211,7 +224,8 @@ def with_formatter(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply formatter injection.
+        """
+        Apply formatter injection.
 
         Args:
             func: The function to decorate.
@@ -222,7 +236,8 @@ def with_formatter(
 
         @functools.wraps(func)
         def wrapper(*args: Any, **kwargs: Any) -> Any:
-            """Execute function with injected formatter.
+            """
+            Execute function with injected formatter.
 
             Args:
                 args: Positional arguments passed to the decorated function.
@@ -244,7 +259,8 @@ def with_formatter(
 def require_arguments(
     *required_args: str,
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Validate required arguments are present.
+    """
+    Validate required arguments are present.
 
     Args:
         required_args: Names of required arguments.
@@ -254,7 +270,8 @@ def require_arguments(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply argument validation.
+        """
+        Apply argument validation.
 
         Args:
             func: The function to decorate.
@@ -265,7 +282,8 @@ def require_arguments(
 
         @functools.wraps(func)
         def wrapper(*args: Any, **kwargs: Any) -> Any:
-            """Execute function with argument validation.
+            """
+            Execute function with argument validation.
 
             Args:
                 args: Positional arguments passed to the decorated function.
@@ -300,14 +318,16 @@ def require_arguments(
 
 
 def connection_command() -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-    """Apply commands that connect to remote services.
+    """
+    Apply commands that connect to remote services.
 
     Returns:
         Decorator function for connection commands.
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        """Apply connection command decorators.
+        """
+        Apply connection command decorators.
 
         Args:
             func: The function to decorate.
@@ -318,7 +338,8 @@ def connection_command() -> Callable[[Callable[..., Any]], Callable[..., Any]]:
 
         @functools.wraps(func)
         def wrapper(*args: Any, **kwargs: Any) -> Any:
-            """Execute function with connection error handling.
+            """
+            Execute function with connection error handling.
 
             Args:
                 args: Positional arguments passed to the decorated function.

xp/cli/utils/error_handlers.py

@@ -16,7 +16,8 @@ class CLIErrorHandler:
         raw_input: str,
         context: Optional[Dict[str, Any]] = None,
     ) -> None:
-        """Handle telegram parsing errors with JSON formatting.
+        """
+        Handle telegram parsing errors with JSON formatting.
 
         Args:
             error: The parsing error that occurred.
@@ -40,7 +41,8 @@ class CLIErrorHandler:
     def handle_connection_error(
         error: Exception, config: Optional[Dict[str, Any]] = None
     ) -> None:
-        """Handle connection/network errors with JSON formatting.
+        """
+        Handle connection/network errors with JSON formatting.
 
         Args:
             error: The connection error that occurred.
@@ -76,7 +78,8 @@ class CLIErrorHandler:
     def handle_service_error(
         error: Exception, operation: str, context: Optional[Dict[str, Any]] = None
     ) -> None:
-        """Handle general service errors with JSON formatting.
+        """
+        Handle general service errors with JSON formatting.
 
         Args:
             error: The service error that occurred.
@@ -98,7 +101,8 @@ class CLIErrorHandler:
 
     @staticmethod
     def handle_validation_error(error: Exception, input_data: str) -> None:
-        """Handle validation errors with JSON formatting.
+        """
+        Handle validation errors with JSON formatting.
 
         Args:
             error: The validation error that occurred.
@@ -120,7 +124,8 @@ class CLIErrorHandler:
         file_path: str,
         operation: str = "processing",
     ) -> None:
-        """Handle file operation errors with JSON formatting.
+        """
+        Handle file operation errors with JSON formatting.
 
         Args:
             error: The file error that occurred.
@@ -141,7 +146,8 @@ class CLIErrorHandler:
     def handle_not_found_error(
         error: Exception, item_type: str, identifier: str
     ) -> None:
-        """Handle 'not found' errors with JSON formatting.
+        """
+        Handle 'not found' errors with JSON formatting.
 
         Args:
             error: The not found error that occurred.
@@ -166,7 +172,8 @@ class ServerErrorHandler(CLIErrorHandler):
     def handle_server_startup_error(
         error: Exception, port: int, config_path: str
     ) -> None:
-        """Handle server startup errors with JSON formatting.
+        """
+        Handle server startup errors with JSON formatting.
 
         Args:
             error: The server startup error that occurred.
@@ -189,7 +196,8 @@ class ServerErrorHandler(CLIErrorHandler):
 
     @staticmethod
     def handle_server_not_running_error() -> None:
-        """Handle errors when server is not running with JSON formatting.
+        """
+        Handle errors when server is not running with JSON formatting.
 
         Raises:
             SystemExit: Always exits with code 1 after displaying error.