conson-xp 1.46.0__py3-none-any.whl → 1.48.0__py3-none-any.whl

xp/services/telegram/telegram_discover_service.py

@@ -1,7 +1,8 @@
-"""Service for device discover telegram operations.
+"""
+Service for device discover telegram operations.
 
-This service handles generation and parsing of device discover system telegrams
-used for enumerating all connected devices on the console bus.
+This service handles generation and parsing of device discover system telegrams used for
+enumerating all connected devices on the console bus.
 """
 
 from typing import List, Set
@@ -24,7 +25,8 @@ class DeviceInfo:
     def __init__(
         self, serial_number: str, checksum_valid: bool = True, raw_telegram: str = ""
     ):
-        """Initialize device info.
+        """
+        Initialize device info.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -36,7 +38,8 @@ class DeviceInfo:
         self.raw_telegram = raw_telegram
 
     def __str__(self) -> str:
-        """Return string representation of device.
+        """
+        Return string representation of device.
 
         Returns:
             String with serial number and checksum status.
@@ -45,7 +48,8 @@ class DeviceInfo:
         return f"Device {self.serial_number} ({status})"
 
     def __repr__(self) -> str:
-        """Return repr representation of device.
+        """
+        Return repr representation of device.
 
         Returns:
             DeviceInfo constructor representation.
@@ -53,7 +57,8 @@ class DeviceInfo:
         return f"DeviceInfo(serial='{self.serial_number}', checksum_valid={self.checksum_valid})"
 
     def to_dict(self) -> dict:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary with device information.
@@ -99,7 +104,8 @@ class TelegramDiscoverService:
         return telegram
 
     def create_discover_telegram_object(self) -> SystemTelegram:
-        """Create a SystemTelegram object for discover broadcast.
+        """
+        Create a SystemTelegram object for discover broadcast.
 
         Returns:
             SystemTelegram object representing the discover command.
@@ -121,7 +127,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def is_discover_response(reply_telegram: ReplyTelegram) -> bool:
-        """Check if a reply telegram is a discover response.
+        """
+        Check if a reply telegram is a discover response.
 
         Args:
             reply_telegram: Reply telegram to check.
@@ -133,7 +140,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def _generate_discover_response(serial_number: str) -> str:
-        """Generate discover response telegram for a device.
+        """
+        Generate discover response telegram for a device.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -149,7 +157,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def get_unique_devices(devices: List[DeviceInfo]) -> List[DeviceInfo]:
-        """Filter out duplicate devices based on serial number.
+        """
+        Filter out duplicate devices based on serial number.
 
         Args:
             devices: List of discovered devices.
@@ -169,7 +178,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def validate_discover_response_format(raw_telegram: str) -> bool:
-        """Validate if a raw telegram matches discover response format.
+        """
+        Validate if a raw telegram matches discover response format.
 
         Args:
             raw_telegram: Raw telegram string to validate.
@@ -187,7 +197,8 @@ class TelegramDiscoverService:
         return match is not None
 
     def generate_discover_summary(self, devices: List[DeviceInfo]) -> dict:
-        """Generate a summary of a discover results.
+        """
+        Generate a summary of a discover results.
 
         Args:
             devices: List of discovered devices.
@@ -223,7 +234,8 @@ class TelegramDiscoverService:
         }
 
     def format_discover_results(self, devices: List[DeviceInfo]) -> str:
-        """Format discover results for human-readable output.
+        """
+        Format discover results for human-readable output.
 
         Args:
             devices: List of discovered devices.
@@ -263,7 +275,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def is_discover_request(telegram: SystemTelegram) -> bool:
-        """Check if telegram is a discover request.
+        """
+        Check if telegram is a discover request.
 
         Args:
             telegram: System telegram to check.

xp/services/telegram/telegram_link_number_service.py

@@ -1,7 +1,8 @@
-"""Service for link number telegram operations.
+"""
+Service for link number telegram operations.
 
-This service handles generation and parsing of link number system telegrams
-used for setting and reading module link numbers.
+This service handles generation and parsing of link number system telegrams used for
+setting and reading module link numbers.
 """
 
 from contextlib import suppress
@@ -34,7 +35,8 @@ class LinkNumberService:
 
     @staticmethod
     def generate_set_link_number_telegram(serial_number: str, link_number: int) -> str:
-        """Generate a telegram to set a module's link number.
+        """
+        Generate a telegram to set a module's link number.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -79,7 +81,8 @@ class LinkNumberService:
 
     @staticmethod
     def generate_read_link_number_telegram(serial_number: str) -> str:
-        """Generate a telegram to read a module's current link number.
+        """
+        Generate a telegram to read a module's current link number.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -115,7 +118,8 @@ class LinkNumberService:
     def create_set_link_number_telegram_object(
         self, serial_number: str, link_number: int
     ) -> SystemTelegram:
-        """Create a SystemTelegram object for setting link number.
+        """
+        Create a SystemTelegram object for setting link number.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -144,7 +148,8 @@ class LinkNumberService:
     def create_read_link_number_telegram_object(
         self, serial_number: str
     ) -> SystemTelegram:
-        """Create a SystemTelegram object for reading link number.
+        """
+        Create a SystemTelegram object for reading link number.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -169,7 +174,8 @@ class LinkNumberService:
 
     @staticmethod
     def parse_link_number_from_reply(reply_telegram: ReplyTelegram) -> Optional[int]:
-        """Parse the link number value from a reply telegram.
+        """
+        Parse the link number value from a reply telegram.
 
         Args:
             reply_telegram: Reply telegram containing link number data.
@@ -193,7 +199,8 @@ class LinkNumberService:
 
     @staticmethod
     def is_ack_response(reply_telegram: ReplyTelegram) -> bool:
-        """Check if a reply telegram is an ACK response.
+        """
+        Check if a reply telegram is an ACK response.
 
         Args:
             reply_telegram: Reply telegram to check.
@@ -205,7 +212,8 @@ class LinkNumberService:
 
     @staticmethod
     def is_nak_response(reply_telegram: ReplyTelegram) -> bool:
-        """Check if a reply telegram is a NAK response.
+        """
+        Check if a reply telegram is a NAK response.
 
         Args:
             reply_telegram: Reply telegram to check.

xp/services/telegram/telegram_output_service.py

@@ -18,7 +18,8 @@ class XPOutputError(Exception):
 
 
 class TelegramOutputService:
-    """Service for XP action operations.
+    """
+    Service for XP action operations.
 
     Handles parsing and validation of XP24 action telegrams,
     status queries, and action command generation.
@@ -37,7 +38,8 @@ class TelegramOutputService:
     XP_ACK_NAK_PATTERN = re.compile(r"^<R(\d{10})F(1[89])D([A-Z0-9]{2})>$")
 
     def __init__(self, telegram_service: TelegramService) -> None:
-        """Initialize the XP output service.
+        """
+        Initialize the XP output service.
 
         Args:
             telegram_service: TelegramService instance for parsing operations.
@@ -45,7 +47,8 @@ class TelegramOutputService:
         self.telegram_service = telegram_service
 
     def validate_output_number(self, output_number: int) -> None:
-        """Validate XP24 output number according to architecture constraints.
+        """
+        Validate XP24 output number according to architecture constraints.
 
         Args:
             output_number: Output number to validate (0-3).
@@ -66,7 +69,8 @@ class TelegramOutputService:
 
     @staticmethod
     def validate_serial_number(serial_number: str) -> None:
-        """Validate serial number format.
+        """
+        Validate serial number format.
 
         Args:
             serial_number: Serial number to validate.
@@ -88,7 +92,8 @@ class TelegramOutputService:
     def generate_system_action_telegram(
         self, serial_number: str, output_number: int, action: ActionType
     ) -> str:
-        """Generate XP24 action telegram string.
+        """
+        Generate XP24 action telegram string.
 
         Args:
             serial_number: Target module serial number.
@@ -121,7 +126,8 @@ class TelegramOutputService:
         return f"<{data_part}{checksum}>"
 
     def generate_system_status_telegram(self, serial_number: str) -> str:
-        """Generate XP output status query telegram.
+        """
+        Generate XP output status query telegram.
 
         Args:
             serial_number: Target module serial number.
@@ -144,7 +150,8 @@ class TelegramOutputService:
         return f"<{data_part}{checksum}>"
 
     def parse_reply_telegram(self, raw_telegram: str) -> OutputTelegram:
-        """Parse a raw XP output response telegram string.
+        """
+        Parse a raw XP output response telegram string.
 
         Args:
             raw_telegram: The raw telegram string (e.g., "<R0012345003F18DFF>").
@@ -194,7 +201,8 @@ class TelegramOutputService:
             raise XPOutputError(f"Invalid values in XP24 action telegram: {e}")
 
     def parse_system_telegram(self, raw_telegram: str) -> OutputTelegram:
-        """Parse a raw XP output telegram string.
+        """
+        Parse a raw XP output telegram string.
 
         Args:
             raw_telegram: The raw telegram string (e.g., "<S0012345008F27D00AAFN>").
@@ -247,7 +255,8 @@ class TelegramOutputService:
             raise XPOutputError(f"Invalid values in XP24 action telegram: {e}")
 
     def parse_status_response(self, raw_telegram: str) -> list[bool]:
-        """Parse XP24 status response telegram to extract output states.
+        """
+        Parse XP24 status response telegram to extract output states.
 
         Args:
             raw_telegram: Raw reply telegram (e.g., "<R0012345008F02D12xxxx1110FJ>").
@@ -284,7 +293,8 @@ class TelegramOutputService:
 
     @staticmethod
     def format_status_summary(status: Dict[int, bool]) -> str:
-        """Format status dictionary into human-readable summary.
+        """
+        Format status dictionary into human-readable summary.
 
         Args:
             status: Dictionary mapping output numbers to states.
@@ -301,7 +311,8 @@ class TelegramOutputService:
 
     @staticmethod
     def format_action_summary(telegram: OutputTelegram) -> str:
-        """Format XP24 action telegram for human-readable output.
+        """
+        Format XP24 action telegram for human-readable output.
 
         Args:
             telegram: The parsed action telegram.
@@ -323,7 +334,8 @@ class TelegramOutputService:
 
     @staticmethod
     def format_output_state(data_value: str) -> str:
-        """Format module output state data value for display.
+        """
+        Format module output state data value for display.
 
         Algorithm:
         1. Remove 'x' characters

xp/services/telegram/telegram_service.py

@@ -1,6 +1,8 @@
-"""Telegram Service for parsing XP telegrams.
+"""
+Telegram Service for parsing XP telegrams.
 
-This module provides telegram parsing functionality for event, system, and reply telegrams.
+This module provides telegram parsing functionality for event, system, and reply
+telegrams.
 """
 
 import logging
@@ -25,7 +27,8 @@ class TelegramParsingError(Exception):
 
 
 class TelegramService:
-    """Service for parsing event telegrams from the console bus.
+    """
+    Service for parsing event telegrams from the console bus.
 
     Handles parsing of telegrams in the format:
     <[EO]{module_type}L{link_number}I{output_number}{event_type}{checksum}>
@@ -53,7 +56,8 @@ class TelegramService:
         self.logger = logging.getLogger(__name__)
 
     def parse_event_telegram(self, raw_telegram: str) -> EventTelegram:
-        """Parse a raw telegram string into an EventTelegram object.
+        """
+        Parse a raw telegram string into an EventTelegram object.
 
         Args:
             raw_telegram: The raw telegram string (e.g., "<E14L00I02MAK>").
@@ -124,7 +128,8 @@ class TelegramService:
     def validate_checksum(
         telegram: Union[EventTelegram, ReplyTelegram, SystemTelegram, OutputTelegram],
     ) -> bool:
-        """Validate the checksum of a parsed telegram.
+        """
+        Validate the checksum of a parsed telegram.
 
         Args:
             telegram: The parsed telegram.
@@ -150,7 +155,8 @@ class TelegramService:
 
     @staticmethod
     def format_event_telegram_summary(telegram: EventTelegram) -> str:
-        """Format a telegram for human-readable output.
+        """
+        Format a telegram for human-readable output.
 
         Args:
             telegram: The parsed telegram.
@@ -171,7 +177,8 @@ class TelegramService:
         )
 
     def parse_system_telegram(self, raw_telegram: str) -> SystemTelegram:
-        """Parse a raw system telegram string into a SystemTelegram object.
+        """
+        Parse a raw system telegram string into a SystemTelegram object.
 
         Args:
             raw_telegram: The raw telegram string (e.g., "<S0020012521F02D18FN>").
@@ -229,7 +236,8 @@ class TelegramService:
             raise TelegramParsingError(f"Invalid values in system telegram: {e}")
 
     def parse_reply_telegram(self, raw_telegram: str) -> ReplyTelegram:
-        """Parse a raw reply telegram string into a ReplyTelegram object.
+        """
+        Parse a raw reply telegram string into a ReplyTelegram object.
 
         Args:
             raw_telegram: The raw telegram string (e.g., "<R0020012521F02D18+26,0§CIL>").
@@ -297,7 +305,8 @@ class TelegramService:
     def parse_telegram(
         self, raw_telegram: str
     ) -> Union[EventTelegram, SystemTelegram, ReplyTelegram]:
-        """Auto-detect and parse any type of telegram.
+        """
+        Auto-detect and parse any type of telegram.
 
         Args:
             raw_telegram: The raw telegram string.
@@ -329,7 +338,8 @@ class TelegramService:
 
     @staticmethod
     def format_system_telegram_summary(telegram: SystemTelegram) -> str:
-        """Format a system telegram for human-readable output.
+        """
+        Format a system telegram for human-readable output.
 
         Args:
             telegram: The parsed system telegram.
@@ -351,7 +361,8 @@ class TelegramService:
 
     @staticmethod
     def format_reply_telegram_summary(telegram: ReplyTelegram) -> str:
-        """Format a reply telegram for human-readable output.
+        """
+        Format a reply telegram for human-readable output.
 
         Args:
             telegram: The parsed reply telegram.

xp/services/telegram/telegram_version_service.py

@@ -1,7 +1,8 @@
-"""Version service for handling version information parsing and validation.
+"""
+Version service for handling version information parsing and validation.
 
-This service provides business logic for version operations,
-following the layered architecture pattern.
+This service provides business logic for version operations, following the layered
+architecture pattern.
 """
 
 import re
@@ -29,7 +30,8 @@ class VersionService:
 
     @staticmethod
     def parse_version_string(version_string: str) -> Response:
-        """Parse a version string into its components.
+        """
+        Parse a version string into its components.
 
         Args:
             version_string: Version string in format 'XP230_V1.00.04'
@@ -90,7 +92,8 @@ class VersionService:
 
     @staticmethod
     def generate_version_request_telegram(serial_number: str) -> Response:
-        """Generate a system telegram to request version information.
+        """
+        Generate a system telegram to request version information.
 
         Args:
             serial_number: 10-digit serial number of the device
@@ -138,7 +141,8 @@ class VersionService:
 
     @staticmethod
     def validate_version_telegram(telegram: SystemTelegram) -> Response:
-        """Validate if a system telegram is a valid version request.
+        """
+        Validate if a system telegram is a valid version request.
 
         Args:
             telegram: Parsed system telegram
@@ -190,7 +194,8 @@ class VersionService:
 
     @staticmethod
     def parse_version_reply(telegram: ReplyTelegram) -> Response:
-        """Parse version information from a reply telegram.
+        """
+        Parse version information from a reply telegram.
 
         Args:
             telegram: Parsed reply telegram containing version data
@@ -246,7 +251,8 @@ class VersionService:
 
     @staticmethod
     def format_version_summary(version_data: dict) -> str:
-        """Format version information for human-readable output.
+        """
+        Format version information for human-readable output.
 
         Args:
             version_data: Version information dictionary

xp/services/term/protocol_monitor_service.py

@@ -14,7 +14,8 @@ from xp.services.protocol.conbus_event_protocol import ConbusEventProtocol
 
 
 class ProtocolMonitorService:
-    """Service for protocol monitoring in terminal interface.
+    """
+    Service for protocol monitoring in terminal interface.
 
     Wraps ConbusEventProtocol and provides high-level operations
     for the TUI without exposing protocol implementation details.
@@ -38,7 +39,8 @@ class ProtocolMonitorService:
         conbus_protocol: ConbusEventProtocol,
         protocol_keys: ProtocolKeysConfig,
     ) -> None:
-        """Initialize the Protocol Monitor service.
+        """
+        Initialize the Protocol Monitor service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance.
@@ -77,7 +79,8 @@ class ProtocolMonitorService:
 
     @property
     def connection_state(self) -> ConnectionState:
-        """Get current connection state.
+        """
+        Get current connection state.
 
         Returns:
             Current connection state.
@@ -86,7 +89,8 @@ class ProtocolMonitorService:
 
     @property
     def server_info(self) -> str:
-        """Get server connection info (IP:port).
+        """
+        Get server connection info (IP:port).
 
         Returns:
             Server address in format "IP:port".
@@ -131,10 +135,11 @@ class ProtocolMonitorService:
             self.on_status_message.emit("Disconnected")
 
     def toggle_connection(self) -> None:
-        """Toggle connection state between connected and disconnected.
+        """
+        Toggle connection state between connected and disconnected.
 
-        Disconnects if currently connected or connecting.
-        Connects if currently disconnected or failed.
+        Disconnects if currently connected or connecting. Connects if currently
+        disconnected or failed.
         """
         if self._connection_state in (
             ConnectionState.CONNECTED,
@@ -145,7 +150,8 @@ class ProtocolMonitorService:
             self.connect()
 
     def _send_telegram(self, name: str, telegram: str) -> None:
-        """Send a raw telegram.
+        """
+        Send a raw telegram.
 
         Args:
             name: Display name for the telegram.
@@ -159,7 +165,8 @@ class ProtocolMonitorService:
             self.on_status_message.emit(f"Failed: {e}")
 
     def handle_key_press(self, key: str) -> bool:
-        """Handle protocol key press.
+        """
+        Handle protocol key press.
 
         Args:
             key: Key that was pressed.
@@ -184,7 +191,8 @@ class ProtocolMonitorService:
             self.on_status_message.emit(f"Connected to {self.server_info}")
 
     def _on_connection_failed(self, failure: Failure) -> None:
-        """Handle connection failed.
+        """
+        Handle connection failed.
 
         Args:
             failure: Twisted failure object with error details.
@@ -195,7 +203,8 @@ class ProtocolMonitorService:
             self.on_status_message.emit(failure.getErrorMessage())
 
     def _on_telegram_received(self, event: TelegramReceivedEvent) -> None:
-        """Handle telegram received.
+        """
+        Handle telegram received.
 
         Args:
             event: Telegram received event with frame data.
@@ -204,7 +213,8 @@ class ProtocolMonitorService:
         self.on_telegram_display.emit(display_event)
 
     def _on_telegram_sent(self, telegram: str) -> None:
-        """Handle telegram sent.
+        """
+        Handle telegram sent.
 
         Args:
             telegram: Sent telegram string.
@@ -217,7 +227,8 @@ class ProtocolMonitorService:
         self.logger.debug("Timeout occurred (continuous monitoring)")
 
     def _on_failed(self, error: str) -> None:
-        """Handle connection failed.
+        """
+        Handle connection failed.
 
         Args:
             error: Error message describing the failure.
@@ -234,7 +245,8 @@ class ProtocolMonitorService:
             self.disconnect()
 
     def get_keys(self) -> ItemsView[str, ProtocolKeyConfig]:
-        """Get protocol key mappings.
+        """
+        Get protocol key mappings.
 
         Returns:
             Dictionary items view of key to ProtocolKeyConfig mappings.
@@ -242,7 +254,8 @@ class ProtocolMonitorService:
         return self._protocol_keys.protocol.items()
 
     def __enter__(self) -> "ProtocolMonitorService":
-        """Enter context manager.
+        """
+        Enter context manager.
 
         Returns:
             Self for context management.
@@ -255,7 +268,8 @@ class ProtocolMonitorService:
         _exc_val: Optional[BaseException],
         _exc_tb: Optional[Any],
     ) -> None:
-        """Exit context manager and clean up resources.
+        """
+        Exit context manager and clean up resources.
 
         Args:
             _exc_type: Exception type if any.