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

xp/cli/utils/formatters.py

@@ -8,7 +8,8 @@ class OutputFormatter:
     """Handles standardized output formatting for CLI commands."""
 
     def __init__(self, json_output: bool = False):
-        """Initialize the output formatter.
+        """
+        Initialize the output formatter.
 
         Args:
             json_output: Whether to format output as JSON (default: False).
@@ -16,7 +17,8 @@ class OutputFormatter:
         self.json_output = json_output
 
     def success_response(self, data: Dict[str, Any]) -> str:
-        """Format a successful response.
+        """
+        Format a successful response.
 
         Args:
             data: Response data to format.
@@ -31,7 +33,8 @@ class OutputFormatter:
     def error_response(
         self, error: str, extra_data: Optional[Dict[str, Any]] = None
     ) -> str:
-        """Format an error response.
+        """
+        Format an error response.
 
         Args:
             error: Error message.
@@ -49,7 +52,8 @@ class OutputFormatter:
         return f"Error: {error}"
 
     def validation_response(self, is_valid: bool, data: Dict[str, Any]) -> str:
-        """Format a validation response.
+        """
+        Format a validation response.
 
         Args:
             is_valid: Whether validation passed.
@@ -66,7 +70,8 @@ class OutputFormatter:
         return f"Status: {status}"
 
     def checksum_status(self, is_valid: bool) -> str:
-        """Format checksum validation status.
+        """
+        Format checksum validation status.
 
         Args:
             is_valid: Whether checksum is valid.
@@ -81,7 +86,8 @@ class OutputFormatter:
 
     @staticmethod
     def _format_text_response(data: Dict[str, Any]) -> str:
-        """Format data for human-readable text output.
+        """
+        Format data for human-readable text output.
 
         Args:
             data: Data dictionary to format.
@@ -119,7 +125,8 @@ class TelegramFormatter(OutputFormatter):
     def format_telegram_summary(
         self, telegram_data: Dict[str, Any], service_formatter_method: Any = None
     ) -> str:
-        """Format telegram summary using service method when available.
+        """
+        Format telegram summary using service method when available.
 
         Args:
             telegram_data: Telegram data to format.
@@ -148,7 +155,8 @@ class TelegramFormatter(OutputFormatter):
     def format_validation_result(
         self, parsed_telegram: Any, checksum_valid: Optional[bool], service_summary: str
     ) -> str:
-        """Format telegram validation results.
+        """
+        Format telegram validation results.
 
         Args:
             parsed_telegram: Parsed telegram object.
@@ -177,7 +185,8 @@ class ListFormatter(OutputFormatter):
     def format_list_response(
         self, items: list, title: str, item_formatter: Any = None
     ) -> str:
-        """Format a list of items with optional custom formatter.
+        """
+        Format a list of items with optional custom formatter.
 
         Args:
             items: List of items to format.
@@ -212,7 +221,8 @@ class ListFormatter(OutputFormatter):
         return "\n".join(lines)
 
     def format_search_results(self, matches: list, query: str) -> str:
-        """Format search results.
+        """
+        Format search results.
 
         Args:
             matches: List of matching items.
@@ -257,7 +267,8 @@ class StatisticsFormatter(OutputFormatter):
     def format_file_statistics(
         self, file_path: str, stats: Dict[str, Any], entry_count: int
     ) -> str:
-        """Format file analysis statistics.
+        """
+        Format file analysis statistics.
 
         Args:
             file_path: Path to the analyzed file.

xp/cli/utils/module_type_choice.py

@@ -8,7 +8,8 @@ from xp.models.telegram.module_type_code import ModuleTypeCode
 
 
 class ModuleTypeChoice(click.ParamType):
-    """Click parameter type for validating ModuleTypeCode enum values.
+    """
+    Click parameter type for validating ModuleTypeCode enum values.
 
     Attributes:
         name: The parameter type name.
@@ -24,7 +25,8 @@ class ModuleTypeChoice(click.ParamType):
     def convert(
         self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]
     ) -> int:
-        """Convert and validate input to ModuleTypeCode value.
+        """
+        Convert and validate input to ModuleTypeCode value.
 
         Args:
             value: The input value to convert.

xp/cli/utils/serial_number_type.py

@@ -6,7 +6,8 @@ import click
 
 
 class SerialNumberParamType(click.ParamType):
-    """Click parameter type for validating and formatting serial numbers.
+    """
+    Click parameter type for validating and formatting serial numbers.
 
     Attributes:
         name: The parameter type name.
@@ -17,7 +18,8 @@ class SerialNumberParamType(click.ParamType):
     def convert(
         self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]
     ) -> Optional[str]:
-        """Convert and validate serial number input.
+        """
+        Convert and validate serial number input.
 
         Args:
             value: The input value to convert.

xp/cli/utils/system_function_choice.py

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

xp/cli/utils/xp_module_type.py

@@ -6,7 +6,8 @@ import click
 
 
 class XpModuleTypeChoice(click.ParamType):
-    """Click parameter type for validating XP module types.
+    """
+    Click parameter type for validating XP module types.
 
     Attributes:
         name: The parameter type name.
@@ -22,7 +23,8 @@ class XpModuleTypeChoice(click.ParamType):
     def convert(
         self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]
     ) -> Any:
-        """Convert and validate XP module type input.
+        """
+        Convert and validate XP module type input.
 
         Args:
             value: The input value to convert.

xp/models/actiontable/actiontable.py

@@ -1,6 +1,6 @@
 """XP20 Action Table models for input actions and settings."""
 
-from dataclasses import dataclass, field
+from pydantic import BaseModel, Field
 
 from xp.models import ModuleTypeCode
 from xp.models.telegram.input_action_type import InputActionType
@@ -9,9 +9,9 @@ from xp.models.telegram.timeparam_type import TimeParam
 
 # CP20 0 0 > 1 OFF;
 # CP20 0 0 > 1 ~ON;
-@dataclass
-class ActionTableEntry:
-    """Entry in an action table mapping input events to output actions.
+class ActionTableEntry(BaseModel):
+    """
+    Entry in an action table mapping input events to output actions.
 
     Attributes:
         module_type: Type code of the module.
@@ -32,12 +32,12 @@ class ActionTableEntry:
     inverted: bool = False
 
 
-@dataclass
-class ActionTable:
-    """Action Table for managing action on events.
+class ActionTable(BaseModel):
+    """
+    Action Table for managing action on events.
 
     Attributes:
         entries: List of action table entries.
     """
 
-    entries: list[ActionTableEntry] = field(default_factory=list)
+    entries: list[ActionTableEntry] = Field(default_factory=list)

xp/models/actiontable/actiontable_type.py

@@ -0,0 +1,20 @@
+"""ActionTable type enumeration."""
+
+from enum import Enum
+
+
+class ActionTableType(str, Enum):
+    """
+    ActionTable types for download/upload operations.
+
+    Attributes:
+        ACTIONTABLE: Standard action table.
+        MSACTIONTABLE_XP20: Master station action table (XP20 format).
+        MSACTIONTABLE_XP24: Master station action table (XP24 format).
+        MSACTIONTABLE_XP33: Master station action table (XP33 format).
+    """
+
+    ACTIONTABLE = "actiontable"
+    MSACTIONTABLE_XP20 = "msactiontable_xp20"
+    MSACTIONTABLE_XP24 = "msactiontable_xp24"
+    MSACTIONTABLE_XP33 = "msactiontable_xp33"

xp/models/actiontable/msactiontable_xp20.py

@@ -4,7 +4,8 @@ from pydantic import BaseModel, Field
 
 
 class InputChannel(BaseModel):
-    """Configuration for a single input channel in XP20 action table.
+    """
+    Configuration for a single input channel in XP20 action table.
 
     Attributes:
         invert: Input inversion flag
@@ -24,7 +25,8 @@ class InputChannel(BaseModel):
 
 
 class Xp20MsActionTable(BaseModel):
-    """XP20 Action Table for managing 8 input channels.
+    """
+    XP20 Action Table for managing 8 input channels.
 
     Contains configuration for 8 input channels (input1 through input8),
     each with flags for inversion, short/long press detection, group functions,
@@ -51,7 +53,8 @@ class Xp20MsActionTable(BaseModel):
     input8: InputChannel = Field(default_factory=InputChannel)
 
     def to_short_format(self) -> list[str]:
-        """Convert action table to short format string.
+        """
+        Convert action table to short format string.
 
         Returns:
             Short format string with each channel on a separate line.
@@ -79,7 +82,8 @@ class Xp20MsActionTable(BaseModel):
 
     @classmethod
     def from_short_format(cls, short_str: list[str]) -> "Xp20MsActionTable":
-        """Parse short format string into action table.
+        """
+        Parse short format string into action table.
 
         Args:
             short_str: Short format string with 8 channel lines.

xp/models/actiontable/msactiontable_xp24.py

@@ -9,7 +9,8 @@ from xp.models.telegram.timeparam_type import TimeParam
 
 
 class InputAction(BaseModel):
-    """Represents an input action with type and parameter.
+    """
+    Represents an input action with type and parameter.
 
     Attributes:
         model_config: Pydantic configuration to preserve enum objects.
@@ -27,7 +28,8 @@ class InputAction(BaseModel):
     def validate_action_type(
         cls, v: Union[str, int, InputActionType]
     ) -> InputActionType:
-        """Convert string or int to InputActionType enum.
+        """
+        Convert string or int to InputActionType enum.
 
         Args:
             v: Input value (can be string name, int value, or enum).
@@ -55,7 +57,8 @@ class InputAction(BaseModel):
     @field_validator("param", mode="before")
     @classmethod
     def validate_time_param(cls, v: Union[str, int, TimeParam]) -> TimeParam:
-        """Convert string or int to TimeParam enum.
+        """
+        Convert string or int to TimeParam enum.
 
         Args:
             v: Input value (can be string name, int value, or enum).
@@ -82,7 +85,8 @@ class InputAction(BaseModel):
 
 
 class Xp24MsActionTable(BaseModel):
-    """XP24 Action Table for managing input actions and settings.
+    """
+    XP24 Action Table for managing input actions and settings.
 
     Each input has an action type (TOGGLE, ON, LEVELSET, etc.)
     with an optional parameter string.
@@ -159,7 +163,8 @@ class Xp24MsActionTable(BaseModel):
     mutual_deadtime: int = MS300  # Master timing (MS300=12 or MS500=20)
 
     def to_short_format(self) -> list[str]:
-        """Convert action table to short format string.
+        """
+        Convert action table to short format string.
 
         Returns:
             Short format string with settings (e.g., "XP24 T:1 T:2 T:0 T:0 | M12:0 M34:0 C12:0 C34:0 DT:12").
@@ -194,7 +199,8 @@ class Xp24MsActionTable(BaseModel):
 
     @classmethod
     def from_short_format(cls, short_str: list[str]) -> "Xp24MsActionTable":
-        """Parse short format string into action table.
+        """
+        Parse short format string into action table.
 
         Args:
             short_str: Short format string.

xp/models/actiontable/msactiontable_xp33.py

@@ -8,7 +8,8 @@ from xp.models.telegram.timeparam_type import TimeParam
 
 
 class Xp33Output(BaseModel):
-    """Represents an XP33 output configuration.
+    """
+    Represents an XP33 output configuration.
 
     Attributes:
         min_level: Minimum output level (0-100).
@@ -26,7 +27,8 @@ class Xp33Output(BaseModel):
 
 
 class Xp33Scene(BaseModel):
-    """Represents a scene configuration.
+    """
+    Represents a scene configuration.
 
     Attributes:
         output1_level: Output level for output 1 (0-100).
@@ -43,7 +45,8 @@ class Xp33Scene(BaseModel):
     @field_validator("time", mode="before")
     @classmethod
     def validate_time_param(cls, v: Union[str, int, TimeParam]) -> TimeParam:
-        """Convert string or int to TimeParam enum.
+        """
+        Convert string or int to TimeParam enum.
 
         Args:
             v: Input value (can be string name, int value, or enum).
@@ -70,7 +73,8 @@ class Xp33Scene(BaseModel):
 
 
 class Xp33MsActionTable(BaseModel):
-    """XP33 Action Table for managing outputs and scenes.
+    """
+    XP33 Action Table for managing outputs and scenes.
 
     Attributes:
         output1: Configuration for output 1.
@@ -92,7 +96,8 @@ class Xp33MsActionTable(BaseModel):
     scene4: Xp33Scene = Field(default_factory=Xp33Scene)
 
     def to_short_format(self) -> list[str]:
-        """Convert action table to short format string.
+        """
+        Convert action table to short format string.
 
         Returns:
             Short format string (multi-line format with OUT and SCENE lines).
@@ -122,7 +127,8 @@ class Xp33MsActionTable(BaseModel):
 
     @classmethod
     def from_short_format(cls, short_str: list[str]) -> "Xp33MsActionTable":
-        """Parse short format string into action table.
+        """
+        Parse short format string into action table.
 
         Args:
             short_str: Short format string (list of lines).
@@ -205,7 +211,8 @@ class Xp33MsActionTable(BaseModel):
 
     @staticmethod
     def _format_output(output: Xp33Output) -> str:
-        """Format output configuration to short string.
+        """
+        Format output configuration to short string.
 
         Args:
             output: Xp33Output instance.
@@ -223,7 +230,8 @@ class Xp33MsActionTable(BaseModel):
 
     @staticmethod
     def _parse_output(output_str: str) -> Xp33Output:
-        """Parse output configuration from short string.
+        """
+        Parse output configuration from short string.
 
         Args:
             output_str: Short string like "MIN:10 MAX:90 SO:1 SF:0 LE:1".
@@ -277,7 +285,8 @@ class Xp33MsActionTable(BaseModel):
 
     @staticmethod
     def _format_scene(scene: Xp33Scene) -> str:
-        """Format scene configuration to short string.
+        """
+        Format scene configuration to short string.
 
         Args:
             scene: Xp33Scene instance.
@@ -295,7 +304,8 @@ class Xp33MsActionTable(BaseModel):
 
     @staticmethod
     def _parse_scene(scene_str: str) -> Xp33Scene:
-        """Parse scene configuration from short string.
+        """
+        Parse scene configuration from short string.
 
         Args:
             scene_str: Short string like "OUT1:50 OUT2:60 OUT3:70 T:T5SEC".

xp/models/conbus/conbus.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusRequest:
-    """Represents a Conbus send request.
+    """
+    Represents a Conbus send request.
 
     Attributes:
         serial_number: Serial number of the target device.
@@ -29,7 +30,8 @@ class ConbusRequest:
             self.timestamp = datetime.now()
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the request.
@@ -44,7 +46,8 @@ class ConbusRequest:
 
 @dataclass
 class ConbusResponse:
-    """Represents a response from Conbus send operation.
+    """
+    Represents a response from Conbus send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -71,7 +74,8 @@ class ConbusResponse:
         self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_autoreport.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusAutoreportResponse:
-    """Represents a response from Conbus auto report operations (get/set).
+    """
+    Represents a response from Conbus auto report operations (get/set).
 
     Attributes:
         success: Whether the operation was successful.
@@ -37,7 +38,8 @@ class ConbusAutoreportResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_blink.py

@@ -12,7 +12,8 @@ from xp.models.telegram.system_telegram import SystemTelegram
 
 @dataclass
 class ConbusBlinkResponse:
-    """Represents a response from Conbus send operation.
+    """
+    Represents a response from Conbus send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -46,7 +47,8 @@ class ConbusBlinkResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_client_config.py

@@ -8,7 +8,8 @@ from pydantic import BaseModel, Field
 
 
 class ClientConfig(BaseModel):
-    """Client connection configuration.
+    """
+    Client connection configuration.
 
     Attributes:
         ip: IP address of the Conbus server.
@@ -22,7 +23,8 @@ class ClientConfig(BaseModel):
 
 
 class ConbusClientConfig(BaseModel):
-    """Configuration for Conbus client connection.
+    """
+    Configuration for Conbus client connection.
 
     Attributes:
         conbus: Client configuration settings.
@@ -32,7 +34,8 @@ class ConbusClientConfig(BaseModel):
 
     @classmethod
     def from_yaml(cls, file_path: str) -> "ConbusClientConfig":
-        """Load configuration from YAML file.
+        """
+        Load configuration from YAML file.
 
         Args:
             file_path: Path to the YAML configuration file.

xp/models/conbus/conbus_connection_status.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusConnectionStatus:
-    """Represents the current connection status.
+    """
+    Represents the current connection status.
 
     Attributes:
         connected: Whether currently connected.
@@ -24,7 +25,8 @@ class ConbusConnectionStatus:
     error: Optional[str] = None
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the connection status.

xp/models/conbus/conbus_custom.py

@@ -9,7 +9,8 @@ from xp.models.telegram.reply_telegram import ReplyTelegram
 
 @dataclass
 class ConbusCustomResponse:
-    """Represents a response from Conbus send operation.
+    """
+    Represents a response from Conbus send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -41,7 +42,8 @@ class ConbusCustomResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_datapoint.py

@@ -11,7 +11,8 @@ from xp.models.telegram.system_function import SystemFunction
 
 @dataclass
 class ConbusDatapointResponse:
-    """Represents a response from Conbus send operation.
+    """
+    Represents a response from Conbus send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -49,7 +50,8 @@ class ConbusDatapointResponse:
             self.datapoints = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_discover.py

@@ -6,7 +6,8 @@ from typing import Any, Dict, Optional, TypedDict
 
 
 class DiscoveredDevice(TypedDict):
-    """Discovered device information.
+    """
+    Discovered device information.
 
     Attributes:
         serial_number: Serial number of the device.
@@ -23,7 +24,8 @@ class DiscoveredDevice(TypedDict):
 
 @dataclass
 class ConbusDiscoverResponse:
-    """Represents a response from Conbus send operation.
+    """
+    Represents a response from Conbus send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -49,7 +51,8 @@ class ConbusDiscoverResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_event_list.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusEventListResponse:
-    """Represents a response from Conbus event list operation.
+    """
+    Represents a response from Conbus event list operation.
 
     Attributes:
         events: Dict mapping event keys to list of module names.
@@ -23,7 +24,8 @@ class ConbusEventListResponse:
             self.timestamp = datetime.now()
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.