ocx-model-validator 0.4.0__py3-none-any.whl

ocx_model_validator/__init__.py

@@ -0,0 +1,38 @@
+"""ocx_model_validator — parse and validate OCX .3docx ship model files.
+
+Public API
+----------
+OcxParser       — parse a .3docx file into an OCX root dataclass
+get_builder     — return the correct IR builder for a schema version
+IrVessel        — root IR dataclass (schema-neutral)
+
+Exceptions
+----------
+XmlParserError, SourceError, DynamicLoaderError, ConverterError
+"""
+from ocx_model_validator.builders.factory import get_builder
+from ocx_model_validator.exeptions import (
+    ConverterError,
+    ConverterWarning,
+    DynamicLoaderError,
+    SourceError,
+    XmlParserError,
+)
+from ocx_model_validator.model.ir import IrVessel
+from ocx_model_validator.parsers.dynamic_loader import DeclarationOfOcxImport, DynamicLoader
+from ocx_model_validator.parsers.parser import OcxParser
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "OcxParser",
+    "get_builder",
+    "IrVessel",
+    "DeclarationOfOcxImport",
+    "DynamicLoader",
+    "XmlParserError",
+    "SourceError",
+    "DynamicLoaderError",
+    "ConverterError",
+    "ConverterWarning",
+]

ocx_model_validator/builders/__init__.py

@@ -0,0 +1,12 @@
+"""Builder package — translates versioned OCX dataclasses into IR types."""
+from .base import IOcxBuilder, UnsupportedSchemaVersionError
+from .factory import get_builder
+from .v3_builder import OcxV3Builder
+
+__all__ = [
+    "IOcxBuilder",
+    "UnsupportedSchemaVersionError",
+    "get_builder",
+    "OcxV3Builder",
+]
+

ocx_model_validator/builders/base.py

@@ -0,0 +1,27 @@
+"""Abstract base for OCX IR builders."""
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+
+from ocx_model_validator.model.ir import IrVessel
+from ocx_model_validator.utils import MetaData  # noqa: F401 – re-exported for back-compat
+
+
+class UnsupportedSchemaVersionError(Exception):
+    """Raised when no builder is registered for the given schema version."""
+
+
+class IOcxBuilder(ABC):
+    """Translate a parsed OCX root dataclass into a schema-neutral ``IrVessel``.
+
+    Implement one concrete subclass per OCX schema version family (e.g. v3.x).
+    """
+
+    @abstractmethod
+    def build(self, root) -> IrVessel:
+        """Build and return a fully-populated ``IrVessel`` from the raw root."""
+
+    @abstractmethod
+    def supported_versions(self) -> list[tuple[int, int]]:
+        """Return the (major, minor) version tuples this builder handles."""
+

ocx_model_validator/builders/factory.py

@@ -0,0 +1,54 @@
+"""Builder factory — maps a schema version string to the correct IOcxBuilder."""
+from __future__ import annotations
+
+from loguru import logger
+
+from .base import IOcxBuilder, UnsupportedSchemaVersionError
+from .v3_builder import OcxV3Builder
+
+# Registry: (major, minor) → builder class.
+# Add entries here as new schema families are supported.
+_BUILDER_REGISTRY: dict[tuple[int, int], type[IOcxBuilder]] = {
+    (3, 0): OcxV3Builder,
+    (3, 1): OcxV3Builder,
+    (3, 2): OcxV3Builder,
+}
+
+# Fallback: major-only registry for unknown minor versions within a known family.
+_MAJOR_FALLBACK: dict[int, type[IOcxBuilder]] = {
+    3: OcxV3Builder,
+}
+
+
+def get_builder(schema_version: str) -> IOcxBuilder:
+    """Return an ``IOcxBuilder`` instance for the given schema version string.
+
+    Args:
+        schema_version: Version string such as ``"3.0.0"`` or ``"3.1.0"``.
+
+    Returns:
+        A ready-to-use builder instance.
+
+    Raises:
+        UnsupportedSchemaVersionError: If no builder exists for the version.
+    """
+    try:
+        parts = [int(p) for p in schema_version.split(".") if p.isdigit()]
+        major = parts[0] if parts else -1
+        minor = parts[1] if len(parts) > 1 else 0
+    except (ValueError, IndexError):
+        major, minor = -1, 0
+
+    cls = _BUILDER_REGISTRY.get((major, minor)) or _MAJOR_FALLBACK.get(major)
+
+    if cls is None:
+        raise UnsupportedSchemaVersionError(
+            f"No builder registered for OCX schema version {schema_version!r}. "
+            f"Registered versions: {sorted(_BUILDER_REGISTRY.keys())}"
+        )
+
+    logger.debug(
+        f"Schema version {schema_version!r} → {cls.__name__}"
+    )
+    return cls()
+