oscura 0.5.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

oscura/{config → core/config}/schema.py

@@ -6,7 +6,7 @@ threshold configurations.
 
 
 Example:
-    >>> from oscura.config.schema import validate_against_schema
+    >>> from oscura.core.config.schema import validate_against_schema
     >>> config = {"name": "uart", "baud_rate": 115200}
     >>> validate_against_schema(config, "protocol")
     True
@@ -26,7 +26,7 @@ try:
     JSONSCHEMA_AVAILABLE = True
 except ImportError:
     JSONSCHEMA_AVAILABLE = False
-    JsonSchemaError = Exception  # type: ignore[ignore-without-code]
+    JsonSchemaError = Exception
 
 from oscura.core.exceptions import ConfigurationError
 from oscura.core.exceptions import ValidationError as OscuraValidationError
@@ -391,318 +391,472 @@ def _register_builtin_schemas(registry: SchemaRegistry) -> None:
     Args:
         registry: Registry to populate.
     """
-    # Protocol definition schema
+    _register_protocol_schema(registry)
+    _register_pipeline_schema(registry)
+    _register_logic_family_schema(registry)
+    _register_threshold_profile_schema(registry)
+    _register_preferences_schema(registry)
+
+
+def _register_protocol_schema(registry: SchemaRegistry) -> None:
+    """Register protocol definition schema.
+
+    Args:
+        registry: Schema registry to populate.
+    """
+    schema = _build_protocol_schema()
     registry.register(
         ConfigSchema(
             name="protocol",
             version="1.0.0",
             description="Protocol decoder configuration",
-            schema={
-                "$schema": "http://json-schema.org/draft-07/schema#",
-                "type": "object",
-                "required": ["name"],
-                "properties": {
-                    "name": {
-                        "type": "string",
-                        "description": "Protocol identifier",
-                        "pattern": "^[a-z][a-z0-9_]*$",
-                    },
-                    "version": {
-                        "type": "string",
-                        "description": "Protocol version (semver)",
-                        "pattern": "^\\d+\\.\\d+\\.\\d+$",
-                    },
-                    "description": {
-                        "type": "string",
-                    },
-                    "author": {
-                        "type": "string",
-                    },
-                    "timing": {
-                        "type": "object",
-                        "properties": {
-                            "baud_rates": {
-                                "type": "array",
-                                "items": {"type": "integer", "minimum": 1},
-                            },
-                            "data_bits": {
-                                "type": "array",
-                                "items": {
-                                    "type": "integer",
-                                    "minimum": 1,
-                                    "maximum": 32,
-                                },
-                            },
-                            "stop_bits": {
-                                "type": "array",
-                                "items": {
-                                    "type": "number",
-                                    "minimum": 0.5,
-                                    "maximum": 2,
-                                },
-                            },
-                            "parity": {
-                                "type": "array",
-                                "items": {
-                                    "type": "string",
-                                    "enum": ["none", "even", "odd", "mark", "space"],
-                                },
-                            },
-                        },
-                    },
-                    "voltage_levels": {
-                        "type": "object",
-                        "properties": {
-                            "logic_family": {"type": "string"},
-                            "idle_state": {"type": "string", "enum": ["high", "low"]},
-                            "mark_voltage": {"type": "number"},
-                            "space_voltage": {"type": "number"},
-                        },
-                    },
-                    "state_machine": {
-                        "type": "object",
-                        "properties": {
-                            "states": {
-                                "type": "array",
-                                "items": {"type": "string"},
-                            },
-                            "initial_state": {"type": "string"},
-                            "transitions": {
-                                "type": "array",
-                                "items": {
-                                    "type": "object",
-                                    "required": ["from", "to", "condition"],
-                                    "properties": {
-                                        "from": {"type": "string"},
-                                        "to": {"type": "string"},
-                                        "condition": {"type": "string"},
-                                    },
-                                },
-                            },
-                        },
+            schema=schema,
+        )
+    )
+
+
+def _build_protocol_schema() -> dict[str, Any]:
+    """Build protocol schema definition.
+
+    Returns:
+        JSON Schema dictionary for protocol configuration.
+    """
+    return {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "required": ["name"],
+        "properties": {
+            "name": _build_protocol_name_property(),
+            "version": _build_semver_property(),
+            "description": {"type": "string"},
+            "author": {"type": "string"},
+            "timing": _build_timing_property(),
+            "voltage_levels": _build_voltage_levels_property(),
+            "state_machine": _build_state_machine_property(),
+        },
+        "additionalProperties": True,
+    }
+
+
+def _build_protocol_name_property() -> dict[str, Any]:
+    """Build protocol name property definition.
+
+    Returns:
+        Property schema for protocol name.
+    """
+    return {
+        "type": "string",
+        "description": "Protocol identifier",
+        "pattern": "^[a-z][a-z0-9_]*$",
+    }
+
+
+def _build_semver_property() -> dict[str, Any]:
+    """Build semantic version property definition.
+
+    Returns:
+        Property schema for semver strings.
+    """
+    return {
+        "type": "string",
+        "description": "Protocol version (semver)",
+        "pattern": "^\\d+\\.\\d+\\.\\d+$",
+    }
+
+
+def _build_timing_property() -> dict[str, Any]:
+    """Build timing configuration property.
+
+    Returns:
+        Property schema for timing parameters.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "baud_rates": {
+                "type": "array",
+                "items": {"type": "integer", "minimum": 1},
+            },
+            "data_bits": {
+                "type": "array",
+                "items": {"type": "integer", "minimum": 1, "maximum": 32},
+            },
+            "stop_bits": {
+                "type": "array",
+                "items": {"type": "number", "minimum": 0.5, "maximum": 2},
+            },
+            "parity": {
+                "type": "array",
+                "items": {
+                    "type": "string",
+                    "enum": ["none", "even", "odd", "mark", "space"],
+                },
+            },
+        },
+    }
+
+
+def _build_voltage_levels_property() -> dict[str, Any]:
+    """Build voltage levels property.
+
+    Returns:
+        Property schema for voltage level specifications.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "logic_family": {"type": "string"},
+            "idle_state": {"type": "string", "enum": ["high", "low"]},
+            "mark_voltage": {"type": "number"},
+            "space_voltage": {"type": "number"},
+        },
+    }
+
+
+def _build_state_machine_property() -> dict[str, Any]:
+    """Build state machine property.
+
+    Returns:
+        Property schema for state machine definitions.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "states": {
+                "type": "array",
+                "items": {"type": "string"},
+            },
+            "initial_state": {"type": "string"},
+            "transitions": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "required": ["from", "to", "condition"],
+                    "properties": {
+                        "from": {"type": "string"},
+                        "to": {"type": "string"},
+                        "condition": {"type": "string"},
                     },
                 },
-                "additionalProperties": True,
             },
-        )
-    )
+        },
+    }
+
+
+def _register_pipeline_schema(registry: SchemaRegistry) -> None:
+    """Register pipeline definition schema.
 
-    # Pipeline definition schema
+    Args:
+        registry: Schema registry to populate.
+    """
+    schema = _build_pipeline_schema()
     registry.register(
         ConfigSchema(
             name="pipeline",
             version="1.0.0",
             description="Analysis pipeline configuration",
-            schema={
-                "$schema": "http://json-schema.org/draft-07/schema#",
-                "type": "object",
-                "required": ["name", "steps"],
-                "properties": {
-                    "name": {
-                        "type": "string",
-                        "description": "Pipeline identifier",
-                    },
-                    "version": {
-                        "type": "string",
-                        "pattern": "^\\d+\\.\\d+\\.\\d+$",
-                    },
-                    "description": {
-                        "type": "string",
-                    },
-                    "steps": {
-                        "type": "array",
-                        "minItems": 1,
-                        "items": {
-                            "type": "object",
-                            "required": ["name", "type"],
-                            "properties": {
-                                "name": {"type": "string"},
-                                "type": {"type": "string"},
-                                "params": {"type": "object"},
-                                "inputs": {"type": "object"},
-                                "outputs": {"type": "object"},
-                            },
-                        },
-                    },
-                    "parallel_groups": {
-                        "type": "array",
-                        "items": {
-                            "type": "array",
-                            "items": {"type": "string"},
-                        },
-                    },
-                },
-            },
+            schema=schema,
         )
     )
 
-    # Logic family schema
+
+def _build_pipeline_schema() -> dict[str, Any]:
+    """Build pipeline schema definition.
+
+    Returns:
+        JSON Schema dictionary for pipeline configuration.
+    """
+    return {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "required": ["name", "steps"],
+        "properties": {
+            "name": {"type": "string", "description": "Pipeline identifier"},
+            "version": _build_semver_property(),
+            "description": {"type": "string"},
+            "steps": _build_pipeline_steps_property(),
+            "parallel_groups": _build_parallel_groups_property(),
+        },
+    }
+
+
+def _build_pipeline_steps_property() -> dict[str, Any]:
+    """Build pipeline steps property.
+
+    Returns:
+        Property schema for pipeline step definitions.
+    """
+    return {
+        "type": "array",
+        "minItems": 1,
+        "items": {
+            "type": "object",
+            "required": ["name", "type"],
+            "properties": {
+                "name": {"type": "string"},
+                "type": {"type": "string"},
+                "params": {"type": "object"},
+                "inputs": {"type": "object"},
+                "outputs": {"type": "object"},
+            },
+        },
+    }
+
+
+def _build_parallel_groups_property() -> dict[str, Any]:
+    """Build parallel groups property.
+
+    Returns:
+        Property schema for parallel execution groups.
+    """
+    return {
+        "type": "array",
+        "items": {
+            "type": "array",
+            "items": {"type": "string"},
+        },
+    }
+
+
+def _register_logic_family_schema(registry: SchemaRegistry) -> None:
+    """Register logic family voltage threshold schema.
+
+    Args:
+        registry: Schema registry to populate.
+    """
+    schema = _build_logic_family_schema()
     registry.register(
         ConfigSchema(
             name="logic_family",
             version="1.0.0",
             description="Logic family voltage thresholds",
-            schema={
-                "$schema": "http://json-schema.org/draft-07/schema#",
-                "type": "object",
-                "required": ["name", "VIH", "VIL", "VOH", "VOL"],
-                "properties": {
-                    "name": {
-                        "type": "string",
-                        "description": "Logic family name",
-                    },
-                    "description": {
-                        "type": "string",
-                    },
-                    "VIH": {
-                        "type": "number",
-                        "description": "Input high voltage threshold (V)",
-                        "minimum": 0,
-                        "maximum": 10,
-                    },
-                    "VIL": {
-                        "type": "number",
-                        "description": "Input low voltage threshold (V)",
-                        "minimum": 0,
-                        "maximum": 10,
-                    },
-                    "VOH": {
-                        "type": "number",
-                        "description": "Output high voltage (V)",
-                        "minimum": 0,
-                        "maximum": 10,
-                    },
-                    "VOL": {
-                        "type": "number",
-                        "description": "Output low voltage (V)",
-                        "minimum": 0,
-                        "maximum": 10,
-                    },
-                    "VCC": {
-                        "type": "number",
-                        "description": "Supply voltage (V)",
-                        "minimum": 0,
-                        "maximum": 15,
-                    },
-                    "temperature_range": {
-                        "type": "object",
-                        "properties": {
-                            "min": {"type": "number"},
-                            "max": {"type": "number"},
-                        },
-                    },
-                    "noise_margin_high": {
-                        "type": "number",
-                        "description": "High state noise margin (V)",
-                    },
-                    "noise_margin_low": {
-                        "type": "number",
-                        "description": "Low state noise margin (V)",
-                    },
-                },
-            },
+            schema=schema,
         )
     )
 
-    # Threshold profile schema
+
+def _build_logic_family_schema() -> dict[str, Any]:
+    """Build logic family schema definition.
+
+    Returns:
+        JSON Schema dictionary for logic family voltage specifications.
+    """
+    return {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "required": ["name", "VIH", "VIL", "VOH", "VOL"],
+        "properties": {
+            "name": {"type": "string", "description": "Logic family name"},
+            "description": {"type": "string"},
+            "VIH": _build_voltage_property("Input high voltage threshold (V)"),
+            "VIL": _build_voltage_property("Input low voltage threshold (V)"),
+            "VOH": _build_voltage_property("Output high voltage (V)"),
+            "VOL": _build_voltage_property("Output low voltage (V)"),
+            "VCC": _build_supply_voltage_property(),
+            "temperature_range": _build_temperature_range_property(),
+            "noise_margin_high": {"type": "number", "description": "High state noise margin (V)"},
+            "noise_margin_low": {"type": "number", "description": "Low state noise margin (V)"},
+        },
+    }
+
+
+def _build_voltage_property(description: str) -> dict[str, Any]:
+    """Build standard voltage property with 0-10V range.
+
+    Args:
+        description: Property description.
+
+    Returns:
+        Property schema for voltage value.
+    """
+    return {"type": "number", "description": description, "minimum": 0, "maximum": 10}
+
+
+def _build_supply_voltage_property() -> dict[str, Any]:
+    """Build supply voltage property.
+
+    Returns:
+        Property schema for VCC with 0-15V range.
+    """
+    return {"type": "number", "description": "Supply voltage (V)", "minimum": 0, "maximum": 15}
+
+
+def _build_temperature_range_property() -> dict[str, Any]:
+    """Build temperature range property.
+
+    Returns:
+        Property schema for temperature range.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "min": {"type": "number"},
+            "max": {"type": "number"},
+        },
+    }
+
+
+def _register_threshold_profile_schema(registry: SchemaRegistry) -> None:
+    """Register threshold profile schema.
+
+    Args:
+        registry: Schema registry to populate.
+    """
+    schema = _build_threshold_profile_schema()
     registry.register(
         ConfigSchema(
             name="threshold_profile",
             version="1.0.0",
             description="Analysis threshold profile",
-            schema={
-                "$schema": "http://json-schema.org/draft-07/schema#",
-                "type": "object",
-                "required": ["name"],
-                "properties": {
-                    "name": {
-                        "type": "string",
-                    },
-                    "description": {
-                        "type": "string",
-                    },
-                    "base_family": {
-                        "type": "string",
-                        "description": "Base logic family to extend",
-                    },
-                    "overrides": {
-                        "type": "object",
-                        "additionalProperties": {"type": "number"},
-                    },
-                    "tolerance": {
-                        "type": "number",
-                        "description": "Tolerance percentage (0-100)",
-                        "minimum": 0,
-                        "maximum": 100,
-                        "default": 0,
-                    },
-                },
-            },
+            schema=schema,
         )
     )
 
-    # Preferences schema
+
+def _build_threshold_profile_schema() -> dict[str, Any]:
+    """Build threshold profile schema definition.
+
+    Returns:
+        JSON Schema dictionary for threshold profile configuration.
+    """
+    return {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "required": ["name"],
+        "properties": {
+            "name": {"type": "string"},
+            "description": {"type": "string"},
+            "base_family": {"type": "string", "description": "Base logic family to extend"},
+            "overrides": {"type": "object", "additionalProperties": {"type": "number"}},
+            "tolerance": _build_tolerance_property(),
+        },
+    }
+
+
+def _build_tolerance_property() -> dict[str, Any]:
+    """Build tolerance property.
+
+    Returns:
+        Property schema for tolerance percentage (0-100).
+    """
+    return {
+        "type": "number",
+        "description": "Tolerance percentage (0-100)",
+        "minimum": 0,
+        "maximum": 100,
+        "default": 0,
+    }
+
+
+def _register_preferences_schema(registry: SchemaRegistry) -> None:
+    """Register user preferences schema.
+
+    Args:
+        registry: Schema registry to populate.
+    """
+    schema = _build_preferences_schema()
     registry.register(
         ConfigSchema(
             name="preferences",
             version="1.0.0",
             description="User preferences",
-            schema={
-                "$schema": "http://json-schema.org/draft-07/schema#",
-                "type": "object",
-                "properties": {
-                    "defaults": {
-                        "type": "object",
-                        "properties": {
-                            "sample_rate": {"type": "number", "minimum": 0},
-                            "window_function": {"type": "string"},
-                            "fft_size": {"type": "integer", "minimum": 1},
-                        },
-                    },
-                    "visualization": {
-                        "type": "object",
-                        "properties": {
-                            "style": {"type": "string"},
-                            "figure_size": {
-                                "type": "array",
-                                "items": {"type": "number"},
-                                "minItems": 2,
-                                "maxItems": 2,
-                            },
-                            "dpi": {"type": "integer", "minimum": 50, "maximum": 600},
-                            "colormap": {"type": "string"},
-                        },
-                    },
-                    "export": {
-                        "type": "object",
-                        "properties": {
-                            "default_format": {
-                                "type": "string",
-                                "enum": ["csv", "hdf5", "npz", "json"],
-                            },
-                            "precision": {
-                                "type": "integer",
-                                "minimum": 1,
-                                "maximum": 15,
-                            },
-                        },
-                    },
-                    "logging": {
-                        "type": "object",
-                        "properties": {
-                            "level": {
-                                "type": "string",
-                                "enum": ["DEBUG", "INFO", "WARNING", "ERROR"],
-                            },
-                            "file": {"type": "string"},
-                        },
-                    },
-                },
-            },
+            schema=schema,
         )
     )
 
 
+def _build_preferences_schema() -> dict[str, Any]:
+    """Build preferences schema definition.
+
+    Returns:
+        JSON Schema dictionary for user preferences.
+    """
+    return {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+            "defaults": _build_defaults_property(),
+            "visualization": _build_visualization_property(),
+            "export": _build_export_property(),
+            "logging": _build_logging_property(),
+        },
+    }
+
+
+def _build_defaults_property() -> dict[str, Any]:
+    """Build defaults property for preferences.
+
+    Returns:
+        Property schema for default settings.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "sample_rate": {"type": "number", "minimum": 0},
+            "window_function": {"type": "string"},
+            "fft_size": {"type": "integer", "minimum": 1},
+        },
+    }
+
+
+def _build_visualization_property() -> dict[str, Any]:
+    """Build visualization property for preferences.
+
+    Returns:
+        Property schema for visualization settings.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "style": {"type": "string"},
+            "figure_size": {
+                "type": "array",
+                "items": {"type": "number"},
+                "minItems": 2,
+                "maxItems": 2,
+            },
+            "dpi": {"type": "integer", "minimum": 50, "maximum": 600},
+            "colormap": {"type": "string"},
+        },
+    }
+
+
+def _build_export_property() -> dict[str, Any]:
+    """Build export property for preferences.
+
+    Returns:
+        Property schema for export settings.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "default_format": {
+                "type": "string",
+                "enum": ["csv", "hdf5", "npz", "json"],
+            },
+            "precision": {"type": "integer", "minimum": 1, "maximum": 15},
+        },
+    }
+
+
+def _build_logging_property() -> dict[str, Any]:
+    """Build logging property for preferences.
+
+    Returns:
+        Property schema for logging settings.
+    """
+    return {
+        "type": "object",
+        "properties": {
+            "level": {
+                "type": "string",
+                "enum": ["DEBUG", "INFO", "WARNING", "ERROR"],
+            },
+            "file": {"type": "string"},
+        },
+    }
+
+
 __all__ = [
     "ConfigSchema",
     "SchemaRegistry",