conson-xp 1.1.0__tar.gz → 1.2.0__tar.gz

{conson_xp-1.1.0 → conson_xp-1.2.0}/PKG-INFO

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

{conson_xp-1.1.0 → conson_xp-1.2.0}/pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.1.0"
+version = "1.2.0"
 
 [project.license]
 file = "LICENSE"
@@ -41,6 +41,9 @@ dev = [
     "pytest-cov>=7.0",
     "black>=25.9",
     "flake8>=7.3",
+    "flake8-docstrings>=1.7.0",
+    "flake8-docstrings-complete>=1.3.0",
+    "interrogate>=1.7.0",
     "mypy>=1.18",
     "ruff>=0.13.0",
     "vulture>=2.14",
@@ -165,6 +168,8 @@ test-cov = "env PYTHONPATH=src python -m pytest tests/ --quiet --cov=src/xp --co
 lint = "ruff check --fix src/ tests/"
 format = "black src/ tests/"
 typecheck = "mypy src/ tests/"
+flake8 = "flake8 src/ tests/"
+interrogate = "interrogate -vv src/"
 vulture = "vulture src/ tests/"
 refurb = "refurb src/ tests/"
 isort = "isort src/ tests/"
@@ -189,6 +194,8 @@ composite = [
     "lint",
     "format",
     "typecheck",
+    "flake8",
+    "interrogate",
     "vulture",
     "refurb",
     "isort",
@@ -222,6 +229,23 @@ version-files = [
     "src/xp/__init__.py:__version__",
 ]
 
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = false
+fail-under = 95
+exclude = [
+    "tests",
+    "docs",
+    "build",
+    "dist",
+]
+verbose = 1
+quiet = false
+whitelist-regex = []
+color = true
+generate-badge = "."
+badge-format = "svg"
+
 [build-system]
 requires = [
     "pdm-backend",

conson_xp-1.2.0/src/xp/__init__.py

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

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/main.py

@@ -18,7 +18,11 @@ logger = logging.getLogger(__name__)
 
 
 def load_api_config() -> dict[str, Any]:
-    """Load API configuration from api.yml or environment variables."""
+    """Load API configuration from api.yml or environment variables.
+
+    Returns:
+        Dictionary containing API configuration settings.
+    """
     config = {
         "title": "XP Protocol API",
         "description": "REST API for XP Protocol Conbus operations",
@@ -63,6 +67,9 @@ def create_app(container: ServiceContainer) -> FastAPI:
 
     Args:
         container: Optional ServiceContainer instance. If not provided, a new one will be created.
+
+    Returns:
+        Configured FastAPI application instance.
     """
     config = load_api_config()
 
@@ -92,13 +99,21 @@ def create_app(container: ServiceContainer) -> FastAPI:
     # Health check endpoint
     @fastapi.get("/health")
     async def health_check() -> dict[str, str]:
-        """Health check endpoint."""
+        """Return health status of the API.
+
+        Returns:
+            Dictionary containing status and service information.
+        """
         return {"status": "healthy", "service": "xp-api"}
 
     # Root endpoint
     @fastapi.get("/")
     async def root() -> dict[str, str]:
-        """Root endpoint with API information."""
+        """Return API information and available endpoints.
+
+        Returns:
+            Dictionary containing API metadata and endpoint links.
+        """
         return {
             "message": "XP Protocol API",
             "version": config["version"],

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/models/api.py

@@ -6,7 +6,13 @@ from pydantic import BaseModel, Field
 
 
 class ApiResponse(BaseModel):
-    """Response model for successful Input operation."""
+    """Response model for successful Input operation.
+
+    Attributes:
+        success: Operation success status.
+        result: Result value.
+        description: Description of the result.
+    """
 
     success: bool = Field(default=True, description="Operation success status")
     result: Optional[str] = Field(default=None, description="Result")
@@ -14,7 +20,12 @@ class ApiResponse(BaseModel):
 
 
 class ApiErrorResponse(BaseModel):
-    """Response model for failed Input operation."""
+    """Response model for failed Input operation.
+
+    Attributes:
+        success: Operation success status (always False).
+        error: Error message describing what went wrong.
+    """
 
     success: bool = Field(default=False, description="Operation success status")
     error: str = Field(..., description="Error message")

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/models/discover.py

@@ -6,7 +6,12 @@ from pydantic import BaseModel, Field
 
 
 class DiscoverResponse(BaseModel):
-    """Response model for successful discover operation."""
+    """Response model for successful discover operation.
+
+    Attributes:
+        success: Operation success status.
+        devices: List of discovered device information strings.
+    """
 
     success: bool = Field(default=True, description="Operation success status")
     devices: List[str] = Field(
@@ -15,7 +20,12 @@ class DiscoverResponse(BaseModel):
 
 
 class DiscoverErrorResponse(BaseModel):
-    """Response model for failed discover operation."""
+    """Response model for failed discover operation.
+
+    Attributes:
+        success: Operation success status (always False).
+        error: Error message describing what went wrong.
+    """
 
     success: bool = Field(default=False, description="Operation success status")
     error: str = Field(..., description="Error message")

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/routers/conbus_blink.py

@@ -29,10 +29,16 @@ async def blink_on(
     request: Request,
     serial_number: str = "1702033007",
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate Input operation to find devices on the network.
+    """Turn on device blinking.
+
+    Sends a blink on telegram to make the device blink.
+
+    Args:
+        request: FastAPI request object.
+        serial_number: Serial number of the device.
 
-    Sends a broadcastInput telegram and collects responses from all connected devices.
+    Returns:
+        API response with blink result or error.
     """
     service = request.app.state.container.get_container().resolve(ConbusBlinkService)
 
@@ -74,10 +80,16 @@ async def blink_off(
     request: Request,
     serial_number: str = "1702033007",
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate Input operation to find devices on the network.
+    """Turn off device blinking.
+
+    Sends a blink off telegram to stop the device from blinking.
+
+    Args:
+        request: FastAPI request object.
+        serial_number: Serial number of the device.
 
-    Sends a broadcastInput telegram and collects responses from all connected devices.
+    Returns:
+        API response with blink result or error.
     """
     service = request.app.state.container.get_container().resolve(ConbusBlinkService)
 

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/routers/conbus_custom.py

@@ -30,10 +30,18 @@ async def custom_function(
     function_code: str = "02",
     data: str = "00",
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate a Datapoint operation to find devices on the network.
+    """Execute a custom function on a device.
+
+    Sends a custom telegram with specified function code and data.
+
+    Args:
+        request: FastAPI request object.
+        serial_number: Serial number of the device.
+        function_code: Function code to execute.
+        data: Data to send with the function.
 
-    Sends a broadcastDatapoint telegram and collects responses from all connected devices.
+    Returns:
+        API response with custom function result or error.
     """
     service = request.app.state.container.get_container().resolve(ConbusCustomService)
     # SendDatapoint telegram and receive responses

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/routers/conbus_datapoint.py

@@ -30,10 +30,17 @@ async def datapoint_devices(
     datapoint: DataPointType = DataPointType.SW_VERSION,
     serial_number: str = "1702033007",
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate a Datapoint operation to find devices on the network.
+    """Query a datapoint value from a device.
+
+    Sends a datapoint query telegram and retrieves the requested datapoint value.
+
+    Args:
+        request: FastAPI request object.
+        datapoint: Type of datapoint to query (default: SW_VERSION).
+        serial_number: Serial number of the device.
 
-    Sends a broadcastDatapoint telegram and collects responses from all connected devices.
+    Returns:
+        API response with datapoint value or error.
     """
     service = request.app.state.container.get_container().resolve(
         ConbusDatapointService

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/routers/conbus_output.py

@@ -32,10 +32,18 @@ async def input_action(
     serial: str = "1702033007",
     device_input: int = 0,
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate Input operation to find devices on the network.
+    """Initiate Input operation to find devices on the network.
+
+    Sends a broadcast Input telegram and collects responses from all connected devices.
+
+    Args:
+        request: FastAPI request object.
+        action: Action type to perform (default: OFF_PRESS).
+        serial: Serial number of the device.
+        device_input: Device input number.
 
-    Sends a broadcastInput telegram and collects responses from all connected devices.
+    Returns:
+        API response with operation result or error.
     """
     service = request.app.state.container.get_container().resolve(ConbusOutputService)
 
@@ -77,10 +85,16 @@ async def output_status(
     request: Request,
     serial_number: str,
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate Input operation to find devices on the network.
+    """Query output status from a device.
+
+    Sends a status query telegram and retrieves the output state.
 
-    Sends a broadcastInput telegram and collects responses from all connected devices.
+    Args:
+        request: FastAPI request object.
+        serial_number: Serial number of the device to query.
+
+    Returns:
+        API response with output status or error.
     """
     service = request.app.state.container.get_container().resolve(ConbusOutputService)
 
@@ -119,10 +133,16 @@ async def output_state(
     request: Request,
     serial_number: str,
 ) -> Union[ApiResponse, ApiErrorResponse, JSONResponse]:
-    """
-    Initiate Input operation to find devices on the network.
+    """Query module state from a device.
+
+    Sends a state query telegram and retrieves the module state.
+
+    Args:
+        request: FastAPI request object.
+        serial_number: Serial number of the device to query.
 
-    Sends a broadcastInput telegram and collects responses from all connected devices.
+    Returns:
+        API response with module state or error.
     """
     service = request.app.state.container.get_container().resolve(ConbusOutputService)
 

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/api/routers/errors.py

@@ -1,3 +1,5 @@
+"""Error handling utilities for API endpoints."""
+
 from starlette import status
 from starlette.responses import JSONResponse
 
@@ -7,15 +9,14 @@ from xp.api.models.discover import DiscoverErrorResponse
 def handle_service_error(
     error: str, default_status_code: int = status.HTTP_500_INTERNAL_SERVER_ERROR
 ) -> JSONResponse:
-    """
-    Handle service errors by creating a standardized JSON error response.
+    """Handle service errors by creating a standardized JSON error response.
 
     Args:
-        error: Service response object with success and error attributes
-        default_status_code: HTTP status code to use (defaults to 500)
+        error: Service response object with success and error attributes.
+        default_status_code: HTTP status code to use (defaults to 500).
 
     Returns:
-        JSONResponse with error details
+        JSONResponse with error details.
     """
     error_msg = error or "Unknown service error"
 

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/__init__.py

@@ -1,4 +1,4 @@
-"""CLI interface for XP tool"""
+"""CLI interface for XP tool."""
 
 from xp.cli.main import cli
 

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/commands/__init__.py

@@ -38,6 +38,7 @@ from xp.cli.commands.conbus.conbus_datapoint_commands import (
 )
 from xp.cli.commands.conbus.conbus_discover_commands import send_discover_telegram
 from xp.cli.commands.conbus.conbus_lightlevel_commands import (
+    xp_lightlevel_get,
     xp_lightlevel_off,
     xp_lightlevel_on,
     xp_lightlevel_set,

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/commands/api.py

@@ -8,9 +8,5 @@ from click_help_colors import HelpColorsGroup
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def api() -> None:
-    """
-    API server management commands.
-
-    Manage the FastAPI server for XP Protocol operations.
-    """
+    """Manage the FastAPI server for XP Protocol operations."""
     pass

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/commands/api_start_commands.py

@@ -58,31 +58,37 @@ def start_api_server(
     log_level: str,
     access_log: bool,
 ) -> None:
-    """
-    Start the FastAPI server.
+    r"""Start the FastAPI server.
 
     This command starts the XP Protocol FastAPI server using uvicorn.
     The server provides REST API endpoints for Conbus operations.
 
-    Examples:
+    Args:
+        context: Click context object.
+        host: Host to bind the server to.
+        port: Port to bind the server to.
+        reload: Enable auto-reload for development.
+        workers: Number of worker processes.
+        log_level: Log level for the server.
+        access_log: Enable/disable access log.
 
-    \b
+    Examples:
+        \b
         # Start server on default host and port
         xp api start
 
-    \b
+        \b
         # Start server on specific host and port
         xp api start --host 0.0.0.0 --port 8080
 
-    \b
+        \b
         # Start development server with auto-reload
         xp api start --reload
 
-    \b
+        \b
         # Start production server with multiple workers
         xp api start --host 0.0.0.0 --workers 4 --no-access-log
     """
-
     # Validate workers and reload options
     if reload and workers > 1:
         click.echo(

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/commands/conbus/conbus.py

@@ -8,9 +8,7 @@ from click_help_colors import HelpColorsGroup
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def conbus() -> None:
-    """
-    Conbus client operations for sending telegrams to remote servers
-    """
+    """Perform Conbus client operations for sending telegrams to remote servers."""
     pass
 
 
@@ -21,9 +19,7 @@ def conbus() -> None:
     help_options_color="green",
 )
 def conbus_blink() -> None:
-    """
-    Conbus client operations for sending blink telegrams to remote servers
-    """
+    """Perform Conbus client operations for sending blink telegrams to remote servers."""
     pass
 
 
@@ -34,9 +30,7 @@ def conbus_blink() -> None:
     help_options_color="green",
 )
 def conbus_output() -> None:
-    """
-    Conbus input operations to remote servers
-    """
+    """Perform Conbus input operations to remote servers."""
     pass
 
 
@@ -47,9 +41,7 @@ def conbus_output() -> None:
     help_options_color="green",
 )
 def conbus_datapoint() -> None:
-    """
-    Conbus datapoint operations for querying module datapoints
-    """
+    """Perform Conbus datapoint operations for querying module datapoints."""
     pass
 
 
@@ -61,11 +53,7 @@ def conbus_datapoint() -> None:
     short_help="Link number operations",
 )
 def conbus_linknumber() -> None:
-    """
-    Link number operations for modules.
-
-    Set or get the link number for specific modules.
-    """
+    """Set or get the link number for specific modules."""
     pass
 
 
@@ -77,11 +65,7 @@ def conbus_linknumber() -> None:
     short_help="Auto report status operations",
 )
 def conbus_autoreport() -> None:
-    """
-    Auto report status operations for modules.
-
-    Get or set the auto report status for specific modules.
-    """
+    """Get or set the auto report status for specific modules."""
     pass
 
 
@@ -93,11 +77,7 @@ def conbus_autoreport() -> None:
     short_help="Light level operations",
 )
 def conbus_lightlevel() -> None:
-    """
-    Light level operations for modules.
-
-    Control light level (dimming) of outputs on Conbus modules.
-    """
+    """Control light level (dimming) of outputs on Conbus modules."""
     pass
 
 
@@ -109,11 +89,7 @@ def conbus_lightlevel() -> None:
     short_help="MSActionTable operations",
 )
 def conbus_msactiontable() -> None:
-    """
-    msactiontable operations for modules.
-
-    Download msactiontable on Conbus modules.
-    """
+    """Download msactiontable on Conbus modules."""
     pass
 
 
@@ -125,11 +101,7 @@ def conbus_msactiontable() -> None:
     short_help="ActionTable operations",
 )
 def conbus_actiontable() -> None:
-    """
-    ActionTable operations for modules.
-
-    Download ActionTable from Conbus modules.
-    """
+    """Download ActionTable from Conbus modules."""
     pass
 
 

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/commands/conbus/conbus_actiontable_commands.py

@@ -22,13 +22,28 @@ from xp.services.conbus.actiontable.actiontable_service import (
 @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.
+        serial_number: 10-digit module serial number.
+    """
     service = ctx.obj.get("container").get_container().resolve(ActionTableService)
 
     def progress_callback(progress: str) -> None:
+        """Handle progress updates during action table download.
+
+        Args:
+            progress: Progress message string.
+        """
         click.echo(progress)
 
     def finish_callback(actiontable: ActionTable) -> None:
+        """Handle successful completion of action table download.
+
+        Args:
+            actiontable: Downloaded action table object.
+        """
         output = {
             "serial_number": serial_number,
             "actiontable": asdict(actiontable),
@@ -36,6 +51,11 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
         click.echo(json.dumps(output, indent=2, default=str))
 
     def error_callback(error: str) -> None:
+        """Handle errors during action table download.
+
+        Args:
+            error: Error message string.
+        """
         click.echo(error)
 
     with service:

{conson_xp-1.1.0 → conson_xp-1.2.0}/src/xp/cli/commands/conbus/conbus_autoreport_commands.py

@@ -22,14 +22,14 @@ from xp.services.conbus.conbus_autoreport_set_service import ConbusAutoreportSet
 @connection_command()
 @click.pass_context
 def get_autoreport_command(ctx: Context, serial_number: str) -> None:
-    """
-    Get the current auto report status for a specific module.
+    r"""Get the current auto report status for a specific module.
 
-    SERIAL_NUMBER: 10-digit module serial number
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
     Examples:
-
-    \b
+        \b
         xp conbus autoreport get 0123450001
     """
     # Get service from container
@@ -38,6 +38,11 @@ def get_autoreport_command(ctx: Context, serial_number: str) -> None:
     )
 
     def on_finish(service_response: ConbusAutoreportResponse) -> None:
+        """Handle successful completion of auto report status retrieval.
+
+        Args:
+            service_response: Auto report response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service:
@@ -53,15 +58,15 @@ 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:
-    """
-    Set the auto report status for a specific module.
+    r"""Set the auto report status for a specific module.
 
-    SERIAL_NUMBER: 10-digit module serial number
-    STATUS: Auto report status - either 'on' or 'off'
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        status: Auto report status - either 'on' or 'off'.
 
     Examples:
-
-    \b
+        \b
         xp conbus autoreport set 0123450001 on
         xp conbus autoreport set 0123450001 off
     """
@@ -72,6 +77,11 @@ def set_autoreport_command(ctx: Context, serial_number: str, status: str) -> Non
     status_bool = status.lower() == "on"
 
     def on_finish(service_response: ConbusAutoreportResponse) -> None:
+        """Handle successful completion of auto report status setting.
+
+        Args:
+            service_response: Auto report response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service: