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

xp/services/protocol/protocol_factory.py

@@ -1,4 +1,5 @@
-"""Protocol Factory for Twisted protocol creation.
+"""
+Protocol Factory for Twisted protocol creation.
 
 This module provides factory classes for protocol instantiation.
 """
@@ -18,7 +19,8 @@ from xp.services.protocol import TelegramProtocol
 
 
 class TelegramFactory(protocol.ClientFactory):
-    """Factory for creating Telegram protocol instances.
+    """
+    Factory for creating Telegram protocol instances.
 
     Attributes:
         event_bus: Event bus for dispatching protocol events.
@@ -33,7 +35,8 @@ class TelegramFactory(protocol.ClientFactory):
         telegram_protocol: TelegramProtocol,
         connector: IConnector,
     ) -> None:
-        """Initialize TelegramFactory.
+        """
+        Initialize TelegramFactory.
 
         Args:
             event_bus: Event bus for protocol events.
@@ -46,7 +49,8 @@ class TelegramFactory(protocol.ClientFactory):
         self.logger = logging.getLogger(__name__)
 
     def buildProtocol(self, addr: IAddress) -> TelegramProtocol:
-        """Build protocol instance for connection.
+        """
+        Build protocol instance for connection.
 
         Args:
             addr: Address of the connection.
@@ -58,7 +62,8 @@ class TelegramFactory(protocol.ClientFactory):
         return self.telegram_protocol
 
     def clientConnectionFailed(self, connector: IConnector, reason: Failure) -> None:
-        """Handle connection failure event.
+        """
+        Handle connection failure event.
 
         Args:
             connector: Connection connector instance.
@@ -68,7 +73,8 @@ class TelegramFactory(protocol.ClientFactory):
         self.connector.stop()
 
     def clientConnectionLost(self, connector: IConnector, reason: Failure) -> None:
-        """Handle connection lost event.
+        """
+        Handle connection lost event.
 
         Args:
             connector: Connection connector instance.

xp/services/protocol/telegram_protocol.py

@@ -1,4 +1,5 @@
-"""Telegram Protocol for XP telegram communication.
+"""
+Telegram Protocol for XP telegram communication.
 
 This module provides the protocol implementation for telegram-based communication.
 """
@@ -20,7 +21,8 @@ from xp.utils import calculate_checksum
 
 
 class TelegramProtocol(protocol.Protocol):
-    """Twisted protocol for XP telegram communication with built-in debouncing.
+    """
+    Twisted protocol for XP telegram communication with built-in debouncing.
 
     Automatically deduplicates identical telegram frames sent within a
     configurable time window (default 50ms).
@@ -38,7 +40,8 @@ class TelegramProtocol(protocol.Protocol):
     event_bus: EventBus
 
     def __init__(self, event_bus: EventBus, debounce_ms: int = 50) -> None:
-        """Initialize TelegramProtocol.
+        """
+        Initialize TelegramProtocol.
 
         Args:
             event_bus: Event bus for dispatching protocol events.
@@ -64,7 +67,8 @@ class TelegramProtocol(protocol.Protocol):
             self.logger.error(f"Error scheduling async handler: {e}", exc_info=True)
 
     def _on_task_done(self, task: asyncio.Task) -> None:
-        """Handle async task completion.
+        """
+        Handle async task completion.
 
         Args:
             task: Completed async task.
@@ -92,7 +96,8 @@ class TelegramProtocol(protocol.Protocol):
             )
 
     def dataReceived(self, data: bytes) -> None:
-        """Handle received data from Twisted.
+        """
+        Handle received data from Twisted.
 
         Args:
             data: Raw bytes received from connection.
@@ -164,7 +169,8 @@ class TelegramProtocol(protocol.Protocol):
             )
 
     def sendFrame(self, data: bytes) -> None:
-        """Send telegram frame.
+        """
+        Send telegram frame.
 
         Args:
             data: Raw telegram payload (without checksum/framing).

xp/services/reverse_proxy_service.py

@@ -1,7 +1,8 @@
-"""Conbus Reverse Proxy Service for TCP relay with telegram monitoring.
+"""
+Conbus Reverse Proxy Service for TCP relay with telegram monitoring.
 
-This service implements a TCP reverse proxy that listens on port 10001 and forwards
-all telegrams to the configured Conbus server while printing bidirectional traffic.
+This service implements a TCP reverse proxy that listens on port 10001 and forwards all
+telegrams to the configured Conbus server while printing bidirectional traffic.
 """
 
 import logging
@@ -46,7 +47,8 @@ class ReverseProxyService:
         cli_config: ConbusClientConfig,
         listen_port: int,
     ):
-        """Initialize the Conbus reverse proxy service.
+        """
+        Initialize the Conbus reverse proxy service.
 
         Args:
             cli_config: Conbus client configuration.
@@ -66,7 +68,8 @@ class ReverseProxyService:
 
     @property
     def target_ip(self) -> str:
-        """Get target server IP.
+        """
+        Get target server IP.
 
         Returns:
             Target server IP address.
@@ -75,7 +78,8 @@ class ReverseProxyService:
 
     @property
     def target_port(self) -> int:
-        """Get target server port.
+        """
+        Get target server port.
 
         Returns:
             Target server port number.
@@ -83,7 +87,8 @@ class ReverseProxyService:
         return self.cli_config.conbus.port
 
     def start_proxy(self) -> Response:
-        """Start the reverse proxy server.
+        """
+        Start the reverse proxy server.
 
         Returns:
             Response object with success status and proxy details.
@@ -139,7 +144,8 @@ class ReverseProxyService:
             )
 
     def stop_proxy(self) -> Response:
-        """Stop the reverse proxy server.
+        """
+        Stop the reverse proxy server.
 
         Returns:
             Response object with success status.
@@ -171,7 +177,8 @@ class ReverseProxyService:
         )
 
     def get_status(self) -> Response:
-        """Get current proxy status and active connections.
+        """
+        Get current proxy status and active connections.
 
         Returns:
             Response object with proxy status and connection details.
@@ -230,7 +237,8 @@ class ReverseProxyService:
     def _handle_client(
         self, client_socket: socket.socket, client_address: tuple, conn_id: str
     ) -> None:
-        """Handle individual client connection with server relay.
+        """
+        Handle individual client connection with server relay.
 
         Args:
             client_socket: Client socket connection.
@@ -314,7 +322,8 @@ class ReverseProxyService:
         dest_label: str,
         conn_id: str,
     ) -> None:
-        """Relay data between sockets with telegram monitoring.
+        """
+        Relay data between sockets with telegram monitoring.
 
         Args:
             source_socket: Source socket to receive from.
@@ -366,7 +375,8 @@ class ReverseProxyService:
                 self.logger.error(f"Error in data relay: {e} [{conn_id}]")
 
     def _close_connection_pair(self, conn_id: str) -> None:
-        """Close both client and server sockets for a connection.
+        """
+        Close both client and server sockets for a connection.
 
         Args:
             conn_id: Connection identifier.
@@ -409,7 +419,8 @@ class ReverseProxyService:
 
     @staticmethod
     def timestamp() -> str:
-        """Generate timestamp string for logging.
+        """
+        Generate timestamp string for logging.
 
         Returns:
             Timestamp string in HH:MM:SS,mmm format.
@@ -417,7 +428,8 @@ class ReverseProxyService:
         return datetime.now().strftime("%H:%M:%S,%f")[:-3]
 
     def run_blocking(self) -> None:
-        """Run the proxy in blocking mode (for CLI usage).
+        """
+        Run the proxy in blocking mode (for CLI usage).
 
         Raises:
             ReverseProxyError: If proxy fails to start.

xp/services/server/base_server_service.py

@@ -1,7 +1,8 @@
-"""Base Server Service with shared functionality.
+"""
+Base Server Service with shared functionality.
 
-This module provides a base class for all XP device server services,
-containing common functionality like module type response generation.
+This module provides a base class for all XP device server services, containing common
+functionality like module type response generation.
 """
 
 import logging
@@ -20,12 +21,13 @@ class BaseServerService(ABC):
     """
     Base class for all XP device server services.
 
-    Provides common functionality that is shared across all device types,
-    such as module type response generation.
+    Provides common functionality that is shared across all device types, such as module
+    type response generation.
     """
 
     def __init__(self, serial_number: str):
-        """Initialize base server service.
+        """
+        Initialize base server service.
 
         Args:
             serial_number: The device serial number.
@@ -52,7 +54,8 @@ class BaseServerService(ABC):
     def generate_datapoint_type_response(
         self, datapoint_type: DataPointType
     ) -> Optional[str]:
-        """Generate datapoint_type response telegram.
+        """
+        Generate datapoint_type response telegram.
 
         Args:
             datapoint_type: The type of datapoint to query.
@@ -81,7 +84,8 @@ class BaseServerService(ABC):
         return telegram
 
     def _check_request_for_device(self, request: SystemTelegram) -> bool:
-        """Check if request is for this device (including broadcast).
+        """
+        Check if request is for this device (including broadcast).
 
         Args:
             request: The system telegram request to check.
@@ -93,7 +97,8 @@ class BaseServerService(ABC):
 
     @staticmethod
     def _build_response_telegram(data_part: str) -> str:
-        """Build a complete response telegram with checksum.
+        """
+        Build a complete response telegram with checksum.
 
         Args:
             data_part: The data part of the telegram without checksum.
@@ -105,7 +110,8 @@ class BaseServerService(ABC):
         return f"<{data_part}{checksum}>"
 
     def _log_response(self, response_type: str, telegram: str) -> None:
-        """Log response generation.
+        """
+        Log response generation.
 
         Args:
             response_type: The type of response being generated.
@@ -116,7 +122,8 @@ class BaseServerService(ABC):
         )
 
     def generate_discover_response(self) -> str:
-        """Generate discover response telegram.
+        """
+        Generate discover response telegram.
 
         Returns:
             The discover response telegram string.
@@ -129,7 +136,8 @@ class BaseServerService(ABC):
     def set_link_number(
         self, request: SystemTelegram, new_link_number: int
     ) -> Optional[str]:
-        """Set link number and generate ACK response.
+        """
+        Set link number and generate ACK response.
 
         Args:
             request: The system telegram request.
@@ -155,7 +163,8 @@ class BaseServerService(ABC):
         return None
 
     def _get_msactiontable_serializer(self) -> Optional[Any]:
-        """Get the MsActionTable serializer for this device.
+        """
+        Get the MsActionTable serializer for this device.
 
         Subclasses should override this to return their specific serializer.
 
@@ -165,7 +174,8 @@ class BaseServerService(ABC):
         return None
 
     def _get_msactiontable(self) -> Optional[Any]:
-        """Get the MsActionTable for this device.
+        """
+        Get the MsActionTable for this device.
 
         Subclasses should override this to return their msactiontable instance.
 
@@ -208,7 +218,8 @@ class BaseServerService(ABC):
     def _handle_download_msactiontable_ack_request(
         self, _request: SystemTelegram
     ) -> Optional[str]:
-        """Handle MsActionTable download ACK protocol.
+        """
+        Handle MsActionTable download ACK protocol.
 
         Args:
             _request: The system telegram request (unused, kept for signature consistency).
@@ -225,7 +236,8 @@ class BaseServerService(ABC):
         return self._build_response_telegram(f"R{self.serial_number}F19D")  # NAK
 
     def process_system_telegram(self, request: SystemTelegram) -> Optional[str]:
-        """Template method for processing system telegrams.
+        """
+        Template method for processing system telegrams.
 
         Args:
             request: The system telegram request to process.
@@ -287,7 +299,8 @@ class BaseServerService(ABC):
     def _handle_device_specific_data_request(
         self, request: SystemTelegram
     ) -> Optional[str]:
-        """Override in subclasses for device-specific data requests.
+        """
+        Override in subclasses for device-specific data requests.
 
         Args:
             request: The system telegram request.
@@ -298,7 +311,8 @@ class BaseServerService(ABC):
         return None
 
     def _handle_write_config_request(self, request: SystemTelegram) -> Optional[str]:
-        """Handle WRITE_CONFIG requests.
+        """
+        Handle WRITE_CONFIG requests.
 
         Args:
             request: The system telegram request.
@@ -312,7 +326,8 @@ class BaseServerService(ABC):
         return self._handle_device_specific_config_request()
 
     def _handle_action_request(self, request: SystemTelegram) -> Optional[str]:
-        """Handle ACTION requests.
+        """
+        Handle ACTION requests.
 
         Args:
             request: The system telegram request.
@@ -325,7 +340,8 @@ class BaseServerService(ABC):
     def _handle_device_specific_action_request(
         self, request: SystemTelegram
     ) -> Optional[str]:
-        """Override in subclasses for device-specific data requests.
+        """
+        Override in subclasses for device-specific data requests.
 
         Args:
             request: The system telegram request.
@@ -337,7 +353,8 @@ class BaseServerService(ABC):
 
     @staticmethod
     def _handle_device_specific_config_request() -> Optional[str]:
-        """Override in subclasses for device-specific config requests.
+        """
+        Override in subclasses for device-specific config requests.
 
         Returns:
             The response telegram string, or None if request cannot be handled.
@@ -345,7 +362,8 @@ class BaseServerService(ABC):
         return None
 
     def add_telegram_buffer(self, telegram: str) -> None:
-        """Add telegram to the buffer.
+        """
+        Add telegram to the buffer.
 
         Args:
             telegram: The telegram string to add to the buffer.
@@ -355,7 +373,8 @@ class BaseServerService(ABC):
             self.telegram_buffer.append(telegram)
 
     def collect_telegram_buffer(self) -> list[str]:
-        """Collecting telegrams from the buffer.
+        """
+        Collecting telegrams from the buffer.
 
         Returns:
             List of telegram strings from the buffer. The buffer is cleared after collection.

xp/services/server/client_buffer_manager.py

@@ -1,7 +1,8 @@
-"""Client buffer manager for broadcasting telegrams to connected clients.
+"""
+Client buffer manager for broadcasting telegrams to connected clients.
 
-This module provides thread-safe management of per-client telegram queues,
-enabling broadcast of telegrams from device services to all connected clients.
+This module provides thread-safe management of per-client telegram queues, enabling
+broadcast of telegrams from device services to all connected clients.
 """
 
 import queue
@@ -24,7 +25,8 @@ class ClientBufferManager:
         self._lock = threading.Lock()
 
     def register_client(self, client_socket: socket.socket) -> queue.Queue[str]:
-        """Register a new client and create its telegram queue.
+        """
+        Register a new client and create its telegram queue.
 
         Args:
             client_socket: The socket of the connecting client.
@@ -38,7 +40,8 @@ class ClientBufferManager:
             return client_queue
 
     def unregister_client(self, client_socket: socket.socket) -> None:
-        """Unregister a client and remove its telegram queue.
+        """
+        Unregister a client and remove its telegram queue.
 
         Args:
             client_socket: The socket of the disconnecting client.
@@ -47,7 +50,8 @@ class ClientBufferManager:
             self._buffers.pop(client_socket, None)
 
     def broadcast(self, telegram: str) -> None:
-        """Broadcast a telegram to all connected clients.
+        """
+        Broadcast a telegram to all connected clients.
 
         Args:
             telegram: The telegram string to broadcast.
@@ -57,7 +61,8 @@ class ClientBufferManager:
                 client_queue.put(telegram)
 
     def get_queue(self, client_socket: socket.socket) -> Optional[queue.Queue[str]]:
-        """Retrieve the queue for a specific client.
+        """
+        Retrieve the queue for a specific client.
 
         Args:
             client_socket: The socket of the client.

xp/services/server/cp20_server_service.py

@@ -1,7 +1,8 @@
-"""CP20 Server Service for device emulation.
+"""
+CP20 Server Service for device emulation.
 
-This service provides CP20-specific device emulation functionality,
-including response generation and device configuration handling.
+This service provides CP20-specific device emulation functionality, including response
+generation and device configuration handling.
 """
 
 from typing import Dict, Optional
@@ -22,8 +23,8 @@ class CP20ServerService(BaseServerService):
     """
     CP20 device emulation service.
 
-    Generates CP20-specific responses, handles CP20 device configuration,
-    and implements CP20 telegram format.
+    Generates CP20-specific responses, handles CP20 device configuration, and implements
+    CP20 telegram format.
     """
 
     def __init__(
@@ -32,7 +33,8 @@ class CP20ServerService(BaseServerService):
         _variant: str = "",
         _msactiontable_serializer: Optional[MsActionTableSerializer] = None,
     ):
-        """Initialize CP20 server service.
+        """
+        Initialize CP20 server service.
 
         Args:
             serial_number: The device serial number.
@@ -51,7 +53,8 @@ class CP20ServerService(BaseServerService):
         return None
 
     def get_device_info(self) -> Dict:
-        """Get CP20 device information.
+        """
+        Get CP20 device information.
 
         Returns:
             Dictionary containing device information.

xp/services/server/device_service_factory.py

@@ -1,7 +1,8 @@
-"""Device Service Factory for creating device instances.
+"""
+Device Service Factory for creating device instances.
 
-This module provides a factory for creating device service instances
-with proper dependency injection of serializers.
+This module provides a factory for creating device service instances with proper
+dependency injection of serializers.
 """
 
 from xp.services.actiontable.msactiontable_serializer import MsActionTableSerializer
@@ -24,10 +25,11 @@ from xp.services.server.xp230_server_service import XP230ServerService
 
 
 class DeviceServiceFactory:
-    """Factory for creating device service instances.
+    """
+    Factory for creating device service instances.
 
-    Encapsulates device creation logic and handles serializer injection
-    for different device types.
+    Encapsulates device creation logic and handles serializer injection for different
+    device types.
     """
 
     def __init__(
@@ -37,7 +39,8 @@ class DeviceServiceFactory:
         xp33ms_serializer: Xp33MsActionTableSerializer,
         ms_serializer: MsActionTableSerializer,
     ):
-        """Initialize device service factory.
+        """
+        Initialize device service factory.
 
         Args:
             xp20ms_serializer: XP20 MsActionTable serializer (injected via DI).
@@ -51,7 +54,8 @@ class DeviceServiceFactory:
         self.ms_serializer = ms_serializer
 
     def create_device(self, module_type: str, serial_number: str) -> BaseServerService:
-        """Create device instance for given module type.
+        """
+        Create device instance for given module type.
 
         Args:
             module_type: Module type code (e.g., "XP20", "XP33LR").

xp/services/server/server_service.py

@@ -1,7 +1,8 @@
-"""Conbus Server Service for emulating device discover responses.
+"""
+Conbus Server Service for emulating device discover responses.
 
-This service implements a TCP server that listens on port 10001 and responds to
-Discover Request telegrams with configurable device information.
+This service implements a TCP server that listens on port 10001 and responds to Discover
+Request telegrams with configurable device information.
 """
 
 import logging
@@ -32,8 +33,8 @@ class ServerService:
     """
     Main TCP server implementation for Conbus device emulation.
 
-    Manages TCP socket lifecycle, handles client connections,
-    parses Discover Request telegrams, and coordinates device responses.
+    Manages TCP socket lifecycle, handles client connections, parses Discover Request
+    telegrams, and coordinates device responses.
     """
 
     def __init__(
@@ -44,7 +45,8 @@ class ServerService:
         config_path: str = "server.yml",
         port: int = 10001,
     ):
-        """Initialize the Conbus server service.
+        """
+        Initialize the Conbus server service.
 
         Args:
             telegram_service: Service for parsing system telegrams.
@@ -121,7 +123,8 @@ class ServerService:
                 )
 
     def start_server(self) -> None:
-        """Start the TCP server on port 10001.
+        """
+        Start the TCP server on port 10001.
 
         Raises:
             ServerError: If server is already running or fails to start.
@@ -255,7 +258,8 @@ class ServerService:
                 self.logger.error(f"Error closing client socket: {e}")
 
     def _process_request(self, message: str) -> List[str]:
-        """Process incoming request and generate responses.
+        """
+        Process incoming request and generate responses.
 
         Args:
             message: Message potentially containing multiple telegrams in format <TELEGRAM><TELEGRAM2>...
@@ -284,7 +288,8 @@ class ServerService:
         return responses
 
     def _split_telegrams(self, message: str) -> List[str]:
-        """Split message into individual telegrams.
+        """
+        Split message into individual telegrams.
 
         Args:
             message: Raw message containing one or more telegrams in format <TELEGRAM><TELEGRAM2>...
@@ -319,7 +324,8 @@ class ServerService:
         return telegrams
 
     def _process_single_telegram(self, telegram: str) -> List[str]:
-        """Process a single telegram and generate responses.
+        """
+        Process a single telegram and generate responses.
 
         Args:
             telegram: A single telegram string.
@@ -376,7 +382,8 @@ class ServerService:
         return responses
 
     def get_server_status(self) -> dict:
-        """Get current server status.
+        """
+        Get current server status.
 
         Returns:
             Dictionary containing server status information.

xp/services/server/xp130_server_service.py

@@ -1,8 +1,9 @@
-"""XP130 Server Service for device emulation.
+"""
+XP130 Server Service for device emulation.
 
-This service provides XP130-specific device emulation functionality,
-including response generation and device configuration handling.
-XP130 is an Ethernet/TCPIP interface module.
+This service provides XP130-specific device emulation functionality, including response
+generation and device configuration handling. XP130 is an Ethernet/TCPIP interface
+module.
 """
 
 from typing import Dict, Optional
@@ -22,8 +23,8 @@ class XP130ServerService(BaseServerService):
     """
     XP130 device emulation service.
 
-    Generates XP130-specific responses, handles XP130 device configuration,
-    and implements XP130 telegram format for Ethernet/TCPIP interface module.
+    Generates XP130-specific responses, handles XP130 device configuration, and
+    implements XP130 telegram format for Ethernet/TCPIP interface module.
     """
 
     def __init__(
@@ -32,7 +33,8 @@ class XP130ServerService(BaseServerService):
         _variant: str = "",
         _msactiontable_serializer: Optional[MsActionTableSerializer] = None,
     ):
-        """Initialize XP130 server service.
+        """
+        Initialize XP130 server service.
 
         Args:
             serial_number: The device serial number.
@@ -50,7 +52,8 @@ class XP130ServerService(BaseServerService):
         self.gateway = "192.168.1.1"
 
     def get_device_info(self) -> Dict:
-        """Get XP130 device information.
+        """
+        Get XP130 device information.
 
         Returns:
             Dictionary containing device information.