lifx-emulator 2.4.0__py3-none-any.whl → 3.0.1__py3-none-any.whl

lifx_emulator/protocol/serializer.py

@@ -1,379 +0,0 @@
-"""Binary serialization for LIFX protocol packets.
-
-Handles packing and unpacking of protocol structures using struct module.
-All multi-byte values use little-endian byte order per LIFX specification.
-"""
-
-from __future__ import annotations
-
-import struct
-from typing import Any
-
-# Type format mapping for struct module (little-endian)
-TYPE_FORMATS: dict[str, str] = {
-    "uint8": "B",
-    "uint16": "H",
-    "uint32": "I",
-    "uint64": "Q",
-    "int8": "b",
-    "int16": "h",
-    "int32": "i",
-    "int64": "q",
-    "float32": "f",
-    "bool": "?",
-}
-
-# Type sizes in bytes
-TYPE_SIZES: dict[str, int] = {
-    "uint8": 1,
-    "uint16": 2,
-    "uint32": 4,
-    "uint64": 8,
-    "int8": 1,
-    "int16": 2,
-    "int32": 4,
-    "int64": 8,
-    "float32": 4,
-    "bool": 1,
-}
-
-# Pre-compiled struct.Struct objects for faster pack/unpack (optimization)
-_STRUCT_CACHE: dict[str, struct.Struct] = {
-    "uint8": struct.Struct("<B"),
-    "uint16": struct.Struct("<H"),
-    "uint32": struct.Struct("<I"),
-    "uint64": struct.Struct("<Q"),
-    "int8": struct.Struct("<b"),
-    "int16": struct.Struct("<h"),
-    "int32": struct.Struct("<i"),
-    "int64": struct.Struct("<q"),
-    "float32": struct.Struct("<f"),
-    "bool": struct.Struct("<?"),
-}
-
-
-def get_type_size(type_name: str) -> int:
-    """Get the size in bytes of a type.
-
-    Args:
-        type_name: Type name (e.g., 'uint16', 'float32')
-
-    Returns:
-        Size in bytes
-
-    Raises:
-        ValueError: If type is unknown
-    """
-    if type_name not in TYPE_SIZES:
-        raise ValueError(f"Unknown type: {type_name}")
-    return TYPE_SIZES[type_name]
-
-
-def pack_value(value: Any, type_name: str) -> bytes:
-    """Pack a single value into bytes.
-
-    Args:
-        value: Value to pack
-        type_name: Type name (e.g., 'uint16', 'float32')
-
-    Returns:
-        Packed bytes
-
-    Raises:
-        ValueError: If type is unknown
-        struct.error: If value doesn't match type
-    """
-    if type_name not in _STRUCT_CACHE:
-        raise ValueError(f"Unknown type: {type_name}")
-
-    return _STRUCT_CACHE[type_name].pack(value)
-
-
-def unpack_value(data: bytes, type_name: str, offset: int = 0) -> tuple[Any, int]:
-    """Unpack a single value from bytes.
-
-    Args:
-        data: Bytes to unpack from
-        type_name: Type name (e.g., 'uint16', 'float32')
-        offset: Offset in bytes to start unpacking
-
-    Returns:
-        Tuple of (unpacked_value, new_offset)
-
-    Raises:
-        ValueError: If type is unknown or data is too short
-        struct.error: If data format is invalid
-    """
-    if type_name not in _STRUCT_CACHE:
-        raise ValueError(f"Unknown type: {type_name}")
-
-    size = TYPE_SIZES[type_name]
-
-    if len(data) < offset + size:
-        raise ValueError(
-            f"Not enough data to unpack {type_name}: "
-            f"need {offset + size} bytes, got {len(data)}"
-        )
-
-    value = _STRUCT_CACHE[type_name].unpack_from(data, offset)[0]
-    return value, offset + size
-
-
-def pack_array(values: list[Any], element_type: str, count: int) -> bytes:
-    """Pack an array of values into bytes.
-
-    Args:
-        values: List of values to pack
-        element_type: Type of each element (e.g., 'uint8', 'uint16')
-        count: Expected number of elements
-
-    Returns:
-        Packed bytes
-
-    Raises:
-        ValueError: If values length doesn't match count or type is unknown
-    """
-    if len(values) != count:
-        raise ValueError(f"Expected {count} values, got {len(values)}")
-
-    # Optimization: Pack entire primitive array at once with single struct call
-    if element_type in TYPE_FORMATS:
-        format_str = f"<{count}{TYPE_FORMATS[element_type]}"
-        return struct.pack(format_str, *values)
-
-    # Fall back to element-by-element for complex types
-    result = b""
-    for value in values:
-        result += pack_value(value, element_type)
-    return result
-
-
-def unpack_array(
-    data: bytes, element_type: str, count: int, offset: int = 0
-) -> tuple[list[Any], int]:
-    """Unpack an array of values from bytes.
-
-    Args:
-        data: Bytes to unpack from
-        element_type: Type of each element
-        count: Number of elements to unpack
-        offset: Offset in bytes to start unpacking
-
-    Returns:
-        Tuple of (list_of_values, new_offset)
-    """
-    # Optimization: Unpack entire primitive array at once with single struct call
-    if element_type in TYPE_FORMATS:
-        format_str = f"<{count}{TYPE_FORMATS[element_type]}"
-        size = TYPE_SIZES[element_type] * count
-
-        if len(data) < offset + size:
-            raise ValueError(
-                f"Not enough data to unpack array: "
-                f"need {offset + size} bytes, got {len(data)}"
-            )
-
-        values = list(struct.unpack_from(format_str, data, offset))
-        return values, offset + size
-
-    # Fall back to element-by-element for complex types
-    values = []
-    current_offset = offset
-
-    for _ in range(count):
-        value, current_offset = unpack_value(data, element_type, current_offset)
-        values.append(value)
-
-    return values, current_offset
-
-
-def pack_string(value: str, length: int) -> bytes:
-    """Pack a string into fixed-length byte array.
-
-    Safely truncates at UTF-8 character boundaries to avoid creating
-    invalid UTF-8 sequences that could crash device firmware (VUL-002 mitigation).
-
-    Args:
-        value: String to pack
-        length: Fixed length in bytes
-
-    Returns:
-        Packed bytes (null-padded if necessary)
-    """
-    encoded = value.encode("utf-8")
-
-    # Safe truncation at character boundary
-    if len(encoded) > length:
-        # Decode and re-encode to find safe truncation point
-        truncated = encoded[:length]
-        # Find valid UTF-8 boundary by trying to decode
-        while truncated:
-            try:
-                truncated.decode("utf-8")
-                break
-            except UnicodeDecodeError:
-                # Remove last byte and try again
-                truncated = truncated[:-1]
-        encoded = truncated
-
-    return encoded.ljust(length, b"\x00")
-
-
-def unpack_string(data: bytes, length: int, offset: int = 0) -> tuple[str, int]:
-    """Unpack a fixed-length string from bytes.
-
-    Args:
-        data: Bytes to unpack from
-        length: Length in bytes to read
-        offset: Offset in bytes to start unpacking
-
-    Returns:
-        Tuple of (string, new_offset)
-    """
-    if len(data) < offset + length:
-        raise ValueError(
-            f"Not enough data to unpack string: "
-            f"need {offset + length} bytes, got {len(data)}"
-        )
-
-    raw_bytes = data[offset : offset + length]
-    # Strip null bytes and decode
-    string = raw_bytes.rstrip(b"\x00").decode("utf-8", errors="replace")
-    return string, offset + length
-
-
-def pack_reserved(size: int) -> bytes:
-    """Pack reserved (zero) bytes.
-
-    Args:
-        size: Number of bytes
-
-    Returns:
-        Zero bytes
-    """
-    return b"\x00" * size
-
-
-def pack_bytes(data: bytes, length: int) -> bytes:
-    """Pack bytes into fixed-length byte array.
-
-    Args:
-        data: Bytes to pack
-        length: Fixed length in bytes
-
-    Returns:
-        Packed bytes (null-padded or truncated if necessary)
-    """
-    if len(data) >= length:
-        return data[:length]
-    return data + b"\x00" * (length - len(data))
-
-
-def unpack_bytes(data: bytes, length: int, offset: int = 0) -> tuple[bytes, int]:
-    """Unpack fixed-length byte array from bytes.
-
-    Args:
-        data: Bytes to unpack from
-        length: Length in bytes to read
-        offset: Offset in bytes to start unpacking
-
-    Returns:
-        Tuple of (bytes, new_offset)
-
-    Raises:
-        ValueError: If data is too short
-    """
-    if len(data) < offset + length:
-        raise ValueError(
-            f"Not enough data to unpack bytes: "
-            f"need {offset + length} bytes, got {len(data)}"
-        )
-
-    raw_bytes = data[offset : offset + length]
-    return raw_bytes, offset + length
-
-
-class FieldSerializer:
-    """Serializer for structured fields with nested types."""
-
-    def __init__(self, field_definitions: dict[str, dict[str, str]]):
-        """Initialize serializer with field definitions.
-
-        Args:
-            field_definitions: Dict mapping field names to their structure definitions
-                (e.g., {"HSBK": {"hue": "uint16", "saturation": "uint16", ...}})
-        """
-        self.field_definitions = field_definitions
-
-    def pack_field(self, field_data: dict[str, Any], field_name: str) -> bytes:
-        """Pack a structured field.
-
-        Args:
-            field_data: Dictionary of field values
-            field_name: Name of the field structure (e.g., "HSBK")
-
-        Returns:
-            Packed bytes
-
-        Raises:
-            ValueError: If field_name is unknown
-        """
-        if field_name not in self.field_definitions:
-            raise ValueError(f"Unknown field: {field_name}")
-
-        field_def = self.field_definitions[field_name]
-        result = b""
-
-        for attr_name, attr_type in field_def.items():
-            if attr_name not in field_data:
-                raise ValueError(f"Missing attribute {attr_name} in {field_name}")
-            result += pack_value(field_data[attr_name], attr_type)
-
-        return result
-
-    def unpack_field(
-        self, data: bytes, field_name: str, offset: int = 0
-    ) -> tuple[dict[str, Any], int]:
-        """Unpack a structured field.
-
-        Args:
-            data: Bytes to unpack from
-            field_name: Name of the field structure
-            offset: Offset to start unpacking
-
-        Returns:
-            Tuple of (field_dict, new_offset)
-
-        Raises:
-            ValueError: If field_name is unknown
-        """
-        if field_name not in self.field_definitions:
-            raise ValueError(f"Unknown field: {field_name}")
-
-        field_def = self.field_definitions[field_name]
-        field_data: dict[str, Any] = {}
-        current_offset = offset
-
-        for attr_name, attr_type in field_def.items():
-            value, current_offset = unpack_value(data, attr_type, current_offset)
-            field_data[attr_name] = value
-
-        return field_data, current_offset
-
-    def get_field_size(self, field_name: str) -> int:
-        """Get the size in bytes of a field structure.
-
-        Args:
-            field_name: Name of the field structure
-
-        Returns:
-            Size in bytes
-
-        Raises:
-            ValueError: If field_name is unknown
-        """
-        if field_name not in self.field_definitions:
-            raise ValueError(f"Unknown field: {field_name}")
-
-        field_def = self.field_definitions[field_name]
-        return sum(TYPE_SIZES[attr_type] for attr_type in field_def.values())

lifx_emulator/repositories/__init__.py

@@ -1,22 +0,0 @@
-"""Repository interfaces and implementations for LIFX emulator.
-
-This module defines repository abstractions following the Repository Pattern
-and Dependency Inversion Principle. Repositories encapsulate data access logic
-and provide a clean separation between domain logic and data persistence.
-"""
-
-from lifx_emulator.repositories.device_repository import (
-    DeviceRepository,
-    IDeviceRepository,
-)
-from lifx_emulator.repositories.storage_backend import (
-    IDeviceStorageBackend,
-    IScenarioStorageBackend,
-)
-
-__all__ = [
-    "IDeviceRepository",
-    "DeviceRepository",
-    "IDeviceStorageBackend",
-    "IScenarioStorageBackend",
-]

lifx_emulator/repositories/device_repository.py

@@ -1,155 +0,0 @@
-"""Device repository interface and implementation.
-
-Provides abstraction for device storage and retrieval operations,
-following the Repository Pattern and Dependency Inversion Principle.
-"""
-
-from __future__ import annotations
-
-from typing import Protocol, runtime_checkable
-
-from lifx_emulator.devices import EmulatedLifxDevice
-
-
-@runtime_checkable
-class IDeviceRepository(Protocol):
-    """Interface for device repository operations.
-
-    This protocol defines the contract for managing device storage and retrieval.
-    Concrete implementations can use in-memory storage, databases, or other backends.
-    """
-
-    def add(self, device: EmulatedLifxDevice) -> bool:
-        """Add a device to the repository.
-
-        Args:
-            device: Device to add
-
-        Returns:
-            True if device was added, False if device with same serial already exists
-        """
-        ...
-
-    def remove(self, serial: str) -> bool:
-        """Remove a device from the repository.
-
-        Args:
-            serial: Serial number of device to remove
-
-        Returns:
-            True if device was removed, False if not found
-        """
-        ...
-
-    def get(self, serial: str) -> EmulatedLifxDevice | None:
-        """Get a device by serial number.
-
-        Args:
-            serial: Serial number to look up
-
-        Returns:
-            Device if found, None otherwise
-        """
-        ...
-
-    def get_all(self) -> list[EmulatedLifxDevice]:
-        """Get all devices.
-
-        Returns:
-            List of all devices in the repository
-        """
-        ...
-
-    def clear(self) -> int:
-        """Remove all devices from the repository.
-
-        Returns:
-            Number of devices removed
-        """
-        ...
-
-    def count(self) -> int:
-        """Get the number of devices in the repository.
-
-        Returns:
-            Number of devices
-        """
-        ...
-
-
-class DeviceRepository:
-    """In-memory device repository implementation.
-
-    Stores devices in a dictionary keyed by serial number.
-    This is the default implementation used by EmulatedLifxServer.
-    """
-
-    def __init__(self) -> None:
-        """Initialize empty device repository."""
-        self._devices: dict[str, EmulatedLifxDevice] = {}
-
-    def add(self, device: EmulatedLifxDevice) -> bool:
-        """Add a device to the repository.
-
-        Args:
-            device: Device to add
-
-        Returns:
-            True if device was added, False if device with same serial already exists
-        """
-        serial = device.state.serial
-        if serial in self._devices:
-            return False
-        self._devices[serial] = device
-        return True
-
-    def remove(self, serial: str) -> bool:
-        """Remove a device from the repository.
-
-        Args:
-            serial: Serial number of device to remove
-
-        Returns:
-            True if device was removed, False if not found
-        """
-        if serial in self._devices:
-            del self._devices[serial]
-            return True
-        return False
-
-    def get(self, serial: str) -> EmulatedLifxDevice | None:
-        """Get a device by serial number.
-
-        Args:
-            serial: Serial number to look up
-
-        Returns:
-            Device if found, None otherwise
-        """
-        return self._devices.get(serial)
-
-    def get_all(self) -> list[EmulatedLifxDevice]:
-        """Get all devices.
-
-        Returns:
-            List of all devices in the repository
-        """
-        return list(self._devices.values())
-
-    def clear(self) -> int:
-        """Remove all devices from the repository.
-
-        Returns:
-            Number of devices removed
-        """
-        count = len(self._devices)
-        self._devices.clear()
-        return count
-
-    def count(self) -> int:
-        """Get the number of devices in the repository.
-
-        Returns:
-            Number of devices
-        """
-        return len(self._devices)

lifx_emulator/repositories/storage_backend.py

@@ -1,107 +0,0 @@
-"""Storage backend interfaces for device and scenario persistence.
-
-Provides abstraction for persistent storage operations,
-following the Repository Pattern and Dependency Inversion Principle.
-"""
-
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable
-
-if TYPE_CHECKING:
-    from lifx_emulator.scenarios import HierarchicalScenarioManager
-
-
-@runtime_checkable
-class IDeviceStorageBackend(Protocol):
-    """Interface for device state persistence operations.
-
-    This protocol defines the contract for loading and saving device state.
-    Concrete implementations can use async file I/O, databases,
-    or other storage backends.
-    """
-
-    async def save_device_state(self, device_state: Any) -> None:
-        """Save device state to persistent storage (async).
-
-        Args:
-            device_state: DeviceState instance to persist
-        """
-        raise NotImplementedError
-
-    def load_device_state(self, serial: str) -> dict | None:
-        """Load device state from persistent storage (sync).
-
-        Args:
-            serial: Device serial number (12-character hex string)
-
-        Returns:
-            Dictionary with device state data, or None if not found
-        """
-        raise NotImplementedError
-
-    def delete_device_state(self, serial: str) -> bool:
-        """Delete device state from persistent storage.
-
-        Args:
-            serial: Device serial number
-
-        Returns:
-            True if state was deleted, False if not found
-        """
-        raise NotImplementedError
-
-    def list_devices(self) -> list[str]:
-        """List all device serials with saved state.
-
-        Returns:
-            List of serial numbers
-        """
-        raise NotImplementedError
-
-    def delete_all_device_states(self) -> int:
-        """Delete all device states from persistent storage.
-
-        Returns:
-            Number of device states deleted
-        """
-        raise NotImplementedError
-
-    async def shutdown(self) -> None:
-        """Gracefully shutdown storage backend, flushing pending writes."""
-        raise NotImplementedError
-
-
-@runtime_checkable
-class IScenarioStorageBackend(Protocol):
-    """Interface for scenario configuration persistence operations.
-
-    This protocol defines the contract for loading and saving scenario configurations.
-    Concrete implementations can use async file I/O, databases,
-    or other storage backends.
-    """
-
-    async def load(self) -> HierarchicalScenarioManager:
-        """Load scenario configuration from persistent storage (async).
-
-        Returns:
-            Scenario manager with loaded configuration, or default manager
-            if no saved data
-        """
-        raise NotImplementedError
-
-    async def save(self, manager: HierarchicalScenarioManager) -> None:
-        """Save scenario configuration to persistent storage (async).
-
-        Args:
-            manager: Scenario manager whose configuration should be saved
-        """
-        raise NotImplementedError
-
-    async def delete(self) -> bool:
-        """Delete scenario configuration from persistent storage (async).
-
-        Returns:
-            True if configuration was deleted, False if it didn't exist
-        """
-        raise NotImplementedError

lifx_emulator/scenarios/__init__.py

@@ -1,22 +0,0 @@
-"""Scenario management module for LIFX emulator.
-
-This module contains all scenario-related functionality including:
-- Scenario manager (HierarchicalScenarioManager)
-- Scenario models (ScenarioConfig)
-- Scenario persistence (async file storage)
-- Device type classification (get_device_type)
-"""
-
-from lifx_emulator.scenarios.manager import (
-    HierarchicalScenarioManager,
-    get_device_type,
-)
-from lifx_emulator.scenarios.models import ScenarioConfig
-from lifx_emulator.scenarios.persistence import ScenarioPersistenceAsyncFile
-
-__all__ = [
-    "HierarchicalScenarioManager",
-    "ScenarioConfig",
-    "ScenarioPersistenceAsyncFile",
-    "get_device_type",
-]