hpcflow-new2 0.2.0a189__py3-none-any.whl → 0.2.0a199__py3-none-any.whl

hpcflow/sdk/core/validation.py

@@ -2,12 +2,88 @@
 Schema management.
 """
 
-from importlib import resources
+from __future__ import annotations
+from collections.abc import Mapping, Sequence
+from typing import Any, Generic, Protocol, TypeVar
+from valida import Schema as ValidaSchema  # type: ignore
+from hpcflow.sdk.core.utils import open_text_resource
 
-from valida import Schema
+T = TypeVar("T")
 
 
-def get_schema(filename):
+class ValidatedData(Protocol, Generic[T]):
+    """
+    Typed profile of ``valida.ValidatedData``.
+    """
+
+    @property
+    def is_valid(self) -> bool:
+        ...
+
+    def get_failures_string(self) -> str:
+        ...
+
+    cast_data: T
+
+
+class PreparedConditionCallable(Protocol):
+    """
+    Typed profile of ``valida.PreparedConditionCallable``.
+    """
+
+    @property
+    def name(self) -> str:
+        ...
+
+    @property
+    def args(self) -> tuple[str, ...]:
+        ...
+
+
+class Condition(Protocol):
+    """
+    Typed profile of ``valida.Condition``.
+    """
+
+    @property
+    def callable(self) -> PreparedConditionCallable:
+        ...
+
+
+class Rule(Protocol):
+    """
+    Typed profile of ``valida.Rule``.
+    """
+
+    @property
+    def condition(self) -> Condition:
+        ...
+
+    @property
+    def path(self) -> object:
+        ...
+
+
+class Schema(Protocol):
+    """
+    Typed profile of ``valida.Schema``.
+    """
+
+    def validate(self, data: T) -> ValidatedData[T]:
+        ...
+
+    @property
+    def rules(self) -> Sequence[Rule]:
+        ...
+
+    def add_schema(self, schema: Schema, root_path: Any = None) -> None:
+        ...
+
+    def to_tree(self, **kwargs) -> Sequence[Mapping[str, str]]:
+        ...
+
+
+def get_schema(filename) -> Schema:
     """
     Get a valida `Schema` object from the embedded data directory.
 
@@ -17,9 +93,6 @@ def get_schema(filename):
         The name of the schema file within the resources package
         (:py:mod:`hpcflow.sdk.data`).
     """
-    package = "hpcflow.sdk.data"
-    fh = resources.files(package).joinpath(filename).open("rt")
-    schema_dat = fh.read()
-    fh.close()
-    schema = Schema.from_yaml(schema_dat)
-    return schema
+    with open_text_resource("hpcflow.sdk.data", filename) as fh:
+        schema_dat = fh.read()
+    return ValidaSchema.from_yaml(schema_dat)