conson-xp 1.46.0__tar.gz → 1.48.0__tar.gz

{conson_xp-1.46.0 → conson_xp-1.48.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.46.0
+Version: 1.48.0
 Summary: XP Protocol Communication Tools
 Author-Email: ldvchosal <ldvchosal@github.com>
 License: MIT License

{conson_xp-1.46.0 → conson_xp-1.48.0}/pyproject.toml

@@ -23,7 +23,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.46.0"
+version = "1.48.0"
 
 [project.license]
 file = "LICENSE"
@@ -59,6 +59,7 @@ dev = [
     "absolufy-imports>=0.3.1",
     "pytest-asyncio>=1.2.0",
     "types-docutils>=0.22.2.20251006",
+    "docformatter>=1.7.7",
 ]
 
 [tool.pytest.ini_options]
@@ -177,6 +178,7 @@ interrogate = "interrogate -vv src/"
 vulture = "vulture src/ tests/"
 refurb = "refurb src/ tests/"
 isort = "isort src/ tests/"
+docformatter = "docformatter src/ tests/"
 bump-version = "pdm bump -v minor"
 env = "echo ${PATH}"
 install = "pdm install"
@@ -197,6 +199,7 @@ composite = [
     "clean",
     "lint",
     "format",
+    "docformatter",
     "typecheck",
     "flake8",
     "interrogate",
@@ -250,6 +253,14 @@ color = true
 generate-badge = "."
 badge-format = "svg"
 
+[tool.docformatter]
+recursive = true
+wrap-summaries = 88
+wrap-descriptions = 88
+close-quotes-on-newline = true
+pre-summary-newline = true
+in-place = true
+
 [build-system]
 requires = [
     "pdm-backend",

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/__init__.py

@@ -1,9 +1,10 @@
-"""XP CLI tool for remote console bus operations.
+"""
+XP CLI tool for remote console bus operations.
 
 conson-xp package.
 """
 
-__version__ = "1.46.0"
+__version__ = "1.48.0"
 __manufacturer__ = "salchichon"
 __model__ = "xp.cli"
 __serial__ = "2025.09.23.000"

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus.py

@@ -19,7 +19,7 @@ def conbus() -> None:
     help_options_color="green",
 )
 def conbus_blink() -> None:
-    """Perform Conbus client operations for sending blink telegrams to remote servers."""
+    """Sending blink telegrams to remote servers."""
     pass
 
 

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_actiontable_commands.py

@@ -3,7 +3,6 @@
 import json
 from contextlib import suppress
 from pathlib import Path
-from typing import Any, Dict
 
 import click
 from click import Context
@@ -14,6 +13,7 @@ from xp.cli.utils.decorators import (
 )
 from xp.cli.utils.serial_number_type import SERIAL
 from xp.models.actiontable.actiontable import ActionTable
+from xp.models.actiontable.actiontable_type import ActionTableType
 from xp.models.config.conson_module_config import (
     ConsonModuleConfig,
     ConsonModuleListConfig,
@@ -43,7 +43,8 @@ class ActionTableError(Exception):
 @click.pass_context
 @connection_command()
 def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
-    """Download action table from XP module.
+    """
+    Download action table from XP module.
 
     Args:
         ctx: Click context object.
@@ -54,7 +55,8 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
     )
 
     def on_progress(progress: str) -> None:
-        """Handle progress updates during action table download.
+        """
+        Handle progress updates during action table download.
 
         Args:
             progress: Progress message string.
@@ -63,20 +65,18 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
 
     def on_actiontable_received(
         _actiontable: ActionTable,
-        actiontable_dict: Dict[str, Any],
         actiontable_short: list[str],
     ) -> None:
-        """Handle successful completion of action table download.
+        """
+        Handle successful completion of action table download.
 
         Args:
             _actiontable: a list of ActionTableEntries.
-            actiontable_dict: action table in a dictionary.
             actiontable_short: short representation of action table.
         """
         output = {
             "serial_number": serial_number,
             "actiontable_short": actiontable_short,
-            "actiontable": actiontable_dict,
         }
         click.echo(json.dumps(output, indent=2, default=str))
 
@@ -85,7 +85,8 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
         service.stop_reactor()
 
     def on_error(error: str) -> None:
-        """Handle errors during action table download.
+        """
+        Handle errors during action table download.
 
         Args:
             error: Error message string.
@@ -98,7 +99,10 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
         service.on_finish.connect(on_finish)
         service.on_actiontable_received.connect(on_actiontable_received)
         service.on_error.connect(on_error)
-        service.configure(serial_number=serial_number)
+        service.configure(
+            serial_number=serial_number,
+            actiontable_type=ActionTableType.ACTIONTABLE,
+        )
         service.start_reactor()
 
 
@@ -107,7 +111,8 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
 @click.pass_context
 @connection_command()
 def conbus_upload_actiontable(ctx: Context, serial_number: str) -> None:
-    """Upload action table from conson.yml to XP module.
+    """
+    Upload action table from conson.yml to XP module.
 
     Args:
         ctx: Click context object.
@@ -123,7 +128,8 @@ def conbus_upload_actiontable(ctx: Context, serial_number: str) -> None:
     entries_count = 0
 
     def progress_callback(progress: str) -> None:
-        """Handle progress updates during action table upload.
+        """
+        Handle progress updates during action table upload.
 
         Args:
             progress: Progress message string.
@@ -131,7 +137,8 @@ def conbus_upload_actiontable(ctx: Context, serial_number: str) -> None:
         click.echo(progress, nl=False)
 
     def on_finish(success: bool) -> None:
-        """Handle completion of action table upload.
+        """
+        Handle completion of action table upload.
 
         Args:
             success: True if upload succeeded.
@@ -143,7 +150,8 @@ def conbus_upload_actiontable(ctx: Context, serial_number: str) -> None:
         service.stop_reactor()
 
     def on_error(error: str) -> None:
-        """Handle errors during action table upload.
+        """
+        Handle errors during action table upload.
 
         Args:
             error: Error message string.
@@ -174,7 +182,8 @@ def conbus_upload_actiontable(ctx: Context, serial_number: str) -> None:
 @conbus_actiontable.command("list", short_help="List modules with ActionTable")
 @click.pass_context
 def conbus_list_actiontable(ctx: Context) -> None:
-    """List all modules with action table configurations from conson.yml.
+    """
+    List all modules with action table configurations from conson.yml.
 
     Args:
         ctx: Click context object.
@@ -184,7 +193,8 @@ def conbus_list_actiontable(ctx: Context) -> None:
     )
 
     def on_finish(module_list: dict) -> None:
-        """Handle successful completion of action table list.
+        """
+        Handle successful completion of action table list.
 
         Args:
             module_list: Dictionary containing modules and total count.
@@ -192,7 +202,8 @@ def conbus_list_actiontable(ctx: Context) -> None:
         click.echo(json.dumps(module_list, indent=2, default=str))
 
     def on_error(error: str) -> None:
-        """Handle errors during action table list.
+        """
+        Handle errors during action table list.
 
         Args:
             error: Error message string.
@@ -209,7 +220,8 @@ def conbus_list_actiontable(ctx: Context) -> None:
 @click.argument("serial_number", type=SERIAL)
 @click.pass_context
 def conbus_show_actiontable(ctx: Context, serial_number: str) -> None:
-    """Show action table configuration for a specific module from conson.yml.
+    """
+    Show action table configuration for a specific module from conson.yml.
 
     Args:
         ctx: Click context object.
@@ -220,7 +232,8 @@ def conbus_show_actiontable(ctx: Context, serial_number: str) -> None:
     )
 
     def on_finish(module: ConsonModuleConfig) -> None:
-        """Handle successful completion of action table show.
+        """
+        Handle successful completion of action table show.
 
         Args:
             module: Dictionary containing module configuration.
@@ -230,7 +243,8 @@ def conbus_show_actiontable(ctx: Context, serial_number: str) -> None:
         click.echo(json.dumps(module_data, indent=2, default=str))
 
     def error_callback(error: str) -> None:
-        """Handle errors during action table show.
+        """
+        Handle errors during action table show.
 
         Args:
             error: Error message string.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_autoreport_commands.py

@@ -23,7 +23,8 @@ from xp.services.telegram.telegram_datapoint_service import TelegramDatapointSer
 @connection_command()
 @click.pass_context
 def get_autoreport_command(ctx: Context, serial_number: str) -> None:
-    r"""Get the current auto report status for a specific module.
+    r"""
+    Get the current auto report status for a specific module.
 
     Args:
         ctx: Click context object.
@@ -42,7 +43,8 @@ def get_autoreport_command(ctx: Context, serial_number: str) -> None:
     )
 
     def on_finish(service_response: ConbusDatapointResponse) -> None:
-        """Handle successful completion of auto report status retrieval.
+        """
+        Handle successful completion of auto report status retrieval.
 
         Args:
             service_response: Auto report response object.
@@ -70,7 +72,8 @@ def get_autoreport_command(ctx: Context, serial_number: str) -> None:
 @connection_command()
 @click.pass_context
 def set_autoreport_command(ctx: Context, serial_number: str, status: str) -> None:
-    r"""Set the auto report status for a specific module.
+    r"""
+    Set the auto report status for a specific module.
 
     Args:
         ctx: Click context object.
@@ -90,7 +93,8 @@ def set_autoreport_command(ctx: Context, serial_number: str, status: str) -> Non
     )
 
     def on_finish(response: "ConbusWriteConfigResponse") -> None:
-        """Handle successful completion of light level on command.
+        """
+        Handle successful completion of light level on command.
 
         Args:
             response: Light level response object.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_blink_commands.py

@@ -23,7 +23,8 @@ from xp.services.telegram.telegram_blink_service import BlinkError
 @connection_command()
 @handle_service_errors(BlinkError)
 def send_blink_on_telegram(ctx: Context, serial_number: str) -> None:
-    r"""Send blink command to start blinking module LED.
+    r"""
+    Send blink command to start blinking module LED.
 
     Args:
         ctx: Click context object.
@@ -35,7 +36,8 @@ def send_blink_on_telegram(ctx: Context, serial_number: str) -> None:
     """
 
     def on_finish(service_response: ConbusBlinkResponse) -> None:
-        """Handle successful completion of blink on command.
+        """
+        Handle successful completion of blink on command.
 
         Args:
             service_response: Blink response object.
@@ -58,7 +60,8 @@ def send_blink_on_telegram(ctx: Context, serial_number: str) -> None:
 @connection_command()
 @handle_service_errors(BlinkError)
 def send_blink_off_telegram(ctx: Context, serial_number: str) -> None:
-    r"""Send blink command to stop blinking module LED.
+    r"""
+    Send blink command to stop blinking module LED.
 
     Args:
         ctx: Click context object.
@@ -70,7 +73,8 @@ def send_blink_off_telegram(ctx: Context, serial_number: str) -> None:
     """
 
     def on_finish(service_response: ConbusBlinkResponse) -> None:
-        """Handle successful completion of blink off command.
+        """
+        Handle successful completion of blink off command.
 
         Args:
             service_response: Blink response object.
@@ -98,7 +102,8 @@ def conbus_blink_all() -> None:
 @connection_command()
 @handle_service_errors(BlinkError)
 def blink_all_off(ctx: Context) -> None:
-    r"""Turn off blinking for all discovered devices.
+    r"""
+    Turn off blinking for all discovered devices.
 
     Args:
         ctx: Click context object.
@@ -109,7 +114,8 @@ def blink_all_off(ctx: Context) -> None:
     """
 
     def on_finish(discovered_devices: ConbusBlinkResponse) -> None:
-        """Handle successful completion of blink all off command.
+        """
+        Handle successful completion of blink all off command.
 
         Args:
             discovered_devices: Blink response with all devices.
@@ -118,7 +124,8 @@ def blink_all_off(ctx: Context) -> None:
         service.stop_reactor()
 
     def progress(message: str) -> None:
-        """Handle progress updates during blink all off operation.
+        """
+        Handle progress updates during blink all off operation.
 
         Args:
             message: Progress message string.
@@ -140,7 +147,8 @@ def blink_all_off(ctx: Context) -> None:
 @connection_command()
 @handle_service_errors(BlinkError)
 def blink_all_on(ctx: Context) -> None:
-    r"""Turn on blinking for all discovered devices.
+    r"""
+    Turn on blinking for all discovered devices.
 
     Args:
         ctx: Click context object.
@@ -151,7 +159,8 @@ def blink_all_on(ctx: Context) -> None:
     """
 
     def on_finish(discovered_devices: ConbusBlinkResponse) -> None:
-        """Handle successful completion of blink all on command.
+        """
+        Handle successful completion of blink all on command.
 
         Args:
             discovered_devices: Blink response with all devices.
@@ -160,7 +169,8 @@ def blink_all_on(ctx: Context) -> None:
         service.stop_reactor()
 
     def progress(message: str) -> None:
-        """Handle progress updates during blink all on operation.
+        """
+        Handle progress updates during blink all on operation.
 
         Args:
             message: Progress message string.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_config_commands.py

@@ -14,7 +14,8 @@ from xp.models import ConbusClientConfig
 @click.pass_context
 @handle_service_errors(Exception)
 def show_config(ctx: Context) -> None:
-    r"""Display current Conbus client configuration.
+    r"""
+    Display current Conbus client configuration.
 
     Args:
         ctx: Click context object.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_custom_commands.py

@@ -23,7 +23,8 @@ from xp.services.conbus.conbus_custom_service import ConbusCustomService
 def send_custom_telegram(
     ctx: Context, serial_number: str, function_code: str, datapoint_code: str
 ) -> None:
-    r"""Send custom telegram with specified function and data point codes.
+    r"""
+    Send custom telegram with specified function and data point codes.
 
     Args:
         ctx: Click context object.
@@ -41,7 +42,8 @@ def send_custom_telegram(
     )
 
     def on_finish(response: ConbusCustomResponse) -> None:
-        """Handle successful completion of custom telegram.
+        """
+        Handle successful completion of custom telegram.
 
         Args:
             response: Custom response object.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_datapoint_commands.py

@@ -30,7 +30,8 @@ from xp.services.conbus.conbus_datapoint_service import (
 @click.pass_context
 @connection_command()
 def query_datapoint(ctx: Context, serial_number: str, datapoint: DataPointType) -> None:
-    r"""Query a specific datapoint from Conbus server.
+    r"""
+    Query a specific datapoint from Conbus server.
 
     Args:
         ctx: Click context object.
@@ -50,7 +51,8 @@ def query_datapoint(ctx: Context, serial_number: str, datapoint: DataPointType)
     )
 
     def on_finish(service_response: ConbusDatapointResponse) -> None:
-        """Handle successful completion of datapoint query.
+        """
+        Handle successful completion of datapoint query.
 
         Args:
             service_response: Datapoint response object.
@@ -77,7 +79,8 @@ conbus_datapoint.add_command(query_datapoint)
 @click.pass_context
 @connection_command()
 def query_all_datapoints(ctx: Context, serial_number: str) -> None:
-    r"""Query all datapoints from a specific module.
+    r"""
+    Query all datapoints from a specific module.
 
     Args:
         ctx: Click context object.
@@ -92,7 +95,8 @@ def query_all_datapoints(ctx: Context, serial_number: str) -> None:
     )
 
     def on_finish(service_response: ConbusDatapointResponse) -> None:
-        """Handle successful completion of all datapoints query.
+        """
+        Handle successful completion of all datapoints query.
 
         Args:
             service_response: Datapoint response object with all datapoints.
@@ -101,7 +105,8 @@ def query_all_datapoints(ctx: Context, serial_number: str) -> None:
         service.stop_reactor()
 
     def on_progress(reply_telegram: ReplyTelegram) -> None:
-        """Handle progress updates during all datapoints query.
+        """
+        Handle progress updates during all datapoints query.
 
         Args:
             reply_telegram: Reply telegram object with progress data.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_discover_commands.py

@@ -19,7 +19,8 @@ from xp.services.conbus.conbus_discover_service import (
 @click.pass_context
 @connection_command()
 def send_discover_telegram(ctx: click.Context) -> None:
-    r"""Send discover telegram to Conbus server.
+    r"""
+    Send discover telegram to Conbus server.
 
     Args:
         ctx: Click context object.
@@ -30,7 +31,8 @@ def send_discover_telegram(ctx: click.Context) -> None:
     """
 
     def on_finish(discovered_devices: ConbusDiscoverResponse) -> None:
-        """Handle successful completion of device discovery.
+        """
+        Handle successful completion of device discovery.
 
         Args:
             discovered_devices: Discover response with all found devices.
@@ -39,7 +41,8 @@ def send_discover_telegram(ctx: click.Context) -> None:
         service.stop_reactor()
 
     def on_device_discovered(discovered_device: DiscoveredDevice) -> None:
-        """Handle discovery of sa single module.
+        """
+        Handle discovery of sa single module.
 
         Args:
             discovered_device: Discover device.
@@ -47,7 +50,8 @@ def send_discover_telegram(ctx: click.Context) -> None:
         click.echo(json.dumps(discovered_device, indent=2))
 
     def progress(_serial_number: str) -> None:
-        """Handle progress updates during device discovery.
+        """
+        Handle progress updates during device discovery.
 
         Args:
             _serial_number: Serial number of discovered device (unused).

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_event_commands.py

@@ -15,7 +15,8 @@ from xp.services.conbus.conbus_event_raw_service import ConbusEventRawService
 @conbus_event.command("list")
 @click.pass_context
 def list_events(ctx: click.Context) -> None:
-    r"""List configured event telegrams from module action tables.
+    r"""
+    List configured event telegrams from module action tables.
 
     Reads conson.yml configuration, parses action tables, and groups
     modules by their event keys to show which modules are assigned to
@@ -50,7 +51,8 @@ def send_event_raw(
     input_number: int,
     time_ms: int,
 ) -> None:
-    r"""Send raw event telegrams to simulate button presses.
+    r"""
+    Send raw event telegrams to simulate button presses.
 
     Args:
         ctx: Click context object.
@@ -66,7 +68,8 @@ def send_event_raw(
     """
 
     def on_finish(response: ConbusEventRawResponse) -> None:
-        """Handle successful completion of event raw operation.
+        """
+        Handle successful completion of event raw operation.
 
         Args:
             response: Event raw response with sent and received telegrams.
@@ -74,7 +77,8 @@ def send_event_raw(
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     def on_progress(telegram: str) -> None:
-        """Handle progress updates during event operation.
+        """
+        Handle progress updates during event operation.
 
         Args:
             telegram: Received telegram.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_export_commands.py

@@ -15,7 +15,8 @@ from xp.services.conbus.conbus_export_service import ConbusExportService
 @click.pass_context
 @connection_command()
 def export_conbus_config(ctx: click.Context) -> None:
-    r"""Export Conbus device metadata to YAML file.
+    r"""
+    Export Conbus device metadata to YAML file.
 
     Discovers all devices on the Conbus network and queries their configuration
     datapoints to generate a complete export.yml file in conson.yml format.
@@ -31,7 +32,8 @@ def export_conbus_config(ctx: click.Context) -> None:
     """
 
     def on_progress(serial_number: str, current: int, total: int) -> None:
-        """Handle progress updates during export.
+        """
+        Handle progress updates during export.
 
         Args:
             serial_number: Serial number of discovered device.
@@ -41,7 +43,8 @@ def export_conbus_config(ctx: click.Context) -> None:
         click.echo(f"Querying device {current}/{total}: {serial_number}...")
 
     def on_device_exported(module: ConsonModuleConfig) -> None:
-        """Handle device export completion.
+        """
+        Handle device export completion.
 
         Args:
             module: Exported module configuration.
@@ -58,7 +61,8 @@ def export_conbus_config(ctx: click.Context) -> None:
             click.echo(f"  ✓ Software version: {module.sw_version}")
 
     def on_finish(result: ConbusExportResponse) -> None:
-        """Handle export completion.
+        """
+        Handle export completion.
 
         Args:
             result: Export result.

{conson_xp-1.46.0 → conson_xp-1.48.0}/src/xp/cli/commands/conbus/conbus_lightlevel_commands.py

@@ -26,7 +26,8 @@ from xp.services.telegram.telegram_datapoint_service import TelegramDatapointSer
 def xp_lightlevel_set(
     ctx: click.Context, serial_number: str, output_number: int, level: int
 ) -> None:
-    r"""Set light level for output_number on XP module serial_number.
+    r"""
+    Set light level for output_number on XP module serial_number.
 
     Args:
         ctx: Click context object.
@@ -44,7 +45,8 @@ def xp_lightlevel_set(
     )
 
     def on_finish(response: "ConbusWriteConfigResponse") -> None:
-        """Handle successful completion of light level on command.
+        """
+        Handle successful completion of light level on command.
 
         Args:
             response: Light level response object.
@@ -73,7 +75,8 @@ def xp_lightlevel_set(
 def xp_lightlevel_off(
     ctx: click.Context, serial_number: str, output_number: int
 ) -> None:
-    r"""Turn off light for output_number on XP module serial_number (set level to 0).
+    r"""
+    Turn off light for output_number on XP module serial_number (set level to 0).
 
     Args:
         ctx: Click context object.
@@ -90,7 +93,8 @@ def xp_lightlevel_off(
     )
 
     def on_finish(response: "ConbusWriteConfigResponse") -> None:
-        """Handle successful completion of light level on command.
+        """
+        Handle successful completion of light level on command.
 
         Args:
             response: Light level response object.
@@ -120,7 +124,8 @@ def xp_lightlevel_off(
 def xp_lightlevel_on(
     ctx: click.Context, serial_number: str, output_number: int
 ) -> None:
-    r"""Turn on light for output_number on XP module serial_number (set level to 80%).
+    r"""
+    Turn on light for output_number on XP module serial_number (set level to 80%).
 
     Args:
         ctx: Click context object.
@@ -137,7 +142,8 @@ def xp_lightlevel_on(
     )
 
     def on_finish(response: "ConbusWriteConfigResponse") -> None:
-        """Handle successful completion of light level on command.
+        """
+        Handle successful completion of light level on command.
 
         Args:
             response: Light level response object.
@@ -167,7 +173,8 @@ def xp_lightlevel_on(
 def xp_lightlevel_get(
     ctx: click.Context, serial_number: str, output_number: int
 ) -> None:
-    r"""Get current light level for output_number on XP module serial_number.
+    r"""
+    Get current light level for output_number on XP module serial_number.
 
     Args:
         ctx: Click context object.
@@ -188,7 +195,8 @@ def xp_lightlevel_get(
     )
 
     def on_finish(service_response: "ConbusDatapointResponse") -> None:
-        """Handle successful completion of light level get command.
+        """
+        Handle successful completion of light level get command.
 
         Args:
             service_response: Light level response object.