xactflow 0.1.0__py3-none-any.whl

xactflow/SCR/__init__.py

@@ -0,0 +1,28 @@
+from . import (  # noqa: F401  (registers every Annex B rule as an import side effect)
+    scr_01,
+    scr_02,
+    scr_03,
+    scr_04,
+    scr_05,
+    scr_06,
+    scr_07,
+    scr_08,
+    scr_09,
+    scr_10,
+    scr_11,
+    scr_12,
+    scr_13,
+    scr_14,
+    scr_15,
+)
+from .registry import Rule, all_rules, rule, stub
+from .runner import run_post_config_checks, run_single_doc_checks
+
+__all__ = [
+    "Rule",
+    "all_rules",
+    "rule",
+    "stub",
+    "run_post_config_checks",
+    "run_single_doc_checks",
+]

xactflow/SCR/registry.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Callable, Iterator, List
+
+from ..diagnostics import Diagnostic
+
+
+@dataclass(frozen=True)
+class Rule:
+    """One IEEE 1685-2022 Annex B semantic consistency rule (SCR)."""
+
+    id: str
+    table: str
+    name: str
+    single_doc_check: bool
+    post_config: bool
+    description: str
+    check: Callable[[object], Iterator[Diagnostic]]
+    implemented: bool
+
+
+_REGISTRY: List[Rule] = []
+
+
+def rule(
+    *,
+    id: str,
+    table: str,
+    name: str,
+    single_doc_check: bool,
+    post_config: bool,
+    description: str,
+) -> Callable[[Callable[[object], Iterator[Diagnostic]]], Callable[[object], Iterator[Diagnostic]]]:
+    """Decorator registering a check function as one working Annex B SCR rule."""
+
+    def decorator(
+        check: Callable[[object], Iterator[Diagnostic]]
+    ) -> Callable[[object], Iterator[Diagnostic]]:
+        _REGISTRY.append(
+            Rule(
+                id=id,
+                table=table,
+                name=name,
+                single_doc_check=single_doc_check,
+                post_config=post_config,
+                description=description,
+                check=check,
+                implemented=True,
+            )
+        )
+        return check
+
+    return decorator
+
+
+def _not_yet_implemented(_subject: object) -> Iterator[Diagnostic]:
+    return []
+
+
+def stub(
+    *,
+    id: str,
+    table: str,
+    name: str,
+    single_doc_check: bool,
+    post_config: bool,
+    description: str,
+) -> None:
+    """Register an Annex B rule that is tracked (discoverable via all_rules()) but has no check
+    logic implemented yet. Its check always reports nothing; `implemented` is False so callers
+    can tell it apart from a working rule registered through @rule.
+    """
+    _REGISTRY.append(
+        Rule(
+            id=id,
+            table=table,
+            name=name,
+            single_doc_check=single_doc_check,
+            post_config=post_config,
+            description=description,
+            check=_not_yet_implemented,
+            implemented=False,
+        )
+    )
+
+
+def all_rules() -> List[Rule]:
+    return list(_REGISTRY)

xactflow/SCR/runner.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import List
+
+from ..diagnostics import Diagnostic
+from .registry import all_rules
+
+
+def run_single_doc_checks(document: object) -> List[Diagnostic]:
+    """Run every SCR rule checkable on one IP-XACT document alone (single_doc_check rules)."""
+    diagnostics: List[Diagnostic] = []
+    for r in all_rules():
+        if r.single_doc_check:
+            diagnostics.extend(r.check(document))
+    return diagnostics
+
+
+def run_post_config_checks(elaborated: object) -> List[Diagnostic]:
+    """Run every SCR rule that needs the relationships between documents.
+
+    Takes an elaborate.ElaboratedDesign (accepted as object here to avoid a circular import
+    between xactflow.SCR and xactflow.elaborate, since elaborate.resolver itself calls this).
+    """
+    diagnostics: List[Diagnostic] = []
+    for r in all_rules():
+        if not r.single_doc_check:
+            diagnostics.extend(r.check(elaborated))
+    return diagnostics