timegym 1.1.0__py3-none-any.whl

timegym/__init__.py

@@ -0,0 +1,37 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../notebooks/12_package.ipynb.
+
+from .contracts import Forecast, ForecastTask, Reference, SimulationReference
+from .scenarios import Scenario, Case
+from .pipeline import Pipeline
+from .models import NaiveForecaster, GaussianAR1Forecaster
+from .reporting import (
+    TestReport,
+    DiagnosticStatus,
+    DiagnosticCategory,
+    DiagnosticResult,
+    CaseResult,
+)
+from .evaluation import ForecastRun, EvaluatedCase
+
+__all__ = [
+    "Case",
+    "Forecast",
+    "ForecastTask",
+    "Reference",
+    "SimulationReference",
+    "Scenario",
+    "Pipeline",
+    "NaiveForecaster",
+    "GaussianAR1Forecaster",
+    "TestReport",
+    "ForecastRun",
+    "EvaluatedCase",
+    "DiagnosticStatus",
+    "DiagnosticCategory",
+    "DiagnosticResult",
+    "CaseResult",
+]
+
+# %% ../notebooks/12_package.ipynb #12_package-05
+
+__version__ = "1.1.0"

timegym/_internal.py

@@ -0,0 +1,94 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../notebooks/12_package.ipynb.
+
+from dataclasses import fields, is_dataclass
+from enum import Enum
+import math
+import traceback
+from typing import Any
+import numpy as np
+
+__all__ = ["positive_int", "nonnegative_int"]
+
+# %% ../notebooks/12_package.ipynb #shared-integer-validation
+
+
+def _integer(value: Any, name: str, *, minimum: int) -> int:
+    if (
+        isinstance(value, (bool, np.bool_))
+        or not isinstance(value, (int, np.integer))
+        or value < minimum
+    ):
+        qualifier = "positive" if minimum else "nonnegative"
+        raise ValueError(f"{name} must be a {qualifier} integer")
+    return int(value)
+
+
+def positive_int(value: Any, name: str) -> int:
+    return _integer(value, name, minimum=1)
+
+
+def nonnegative_int(value: Any, name: str) -> int:
+    return _integer(value, name, minimum=0)
+
+
+# %% ../notebooks/12_package.ipynb #08_forecast_contract-07
+def _has_complex_values(array: np.ndarray) -> bool:
+    """Detect complex scalars even when an object array hides their dtype."""
+    return np.iscomplexobj(array) or (
+        array.dtype.kind == "O" and any(np.iscomplexobj(value) for value in array.flat)
+    )
+
+
+# %% ../notebooks/12_package.ipynb #08_forecast_contract-09
+def _real_array(value: Any, name: str) -> np.ndarray:
+    """Convert real numeric data without discarding an imaginary component."""
+    array = np.asarray(value)
+    if _has_complex_values(array):
+        raise ValueError(f"{name} must contain real-valued numbers")
+    return np.asarray(array, dtype=float)
+
+
+# %% ../notebooks/12_package.ipynb #10_reports_and_repla-09
+def _exception_evidence(exc: BaseException) -> dict:
+    """Format the supplied exception even outside its handling block."""
+    return {
+        "exception_type": type(exc).__name__,
+        "exception_message": str(exc),
+        "traceback": "".join(traceback.format_exception(exc)),
+    }
+
+
+def _json_safe(value):
+    """Canonicalize evidence to JSON values, rejecting nonfinite numbers."""
+    if isinstance(value, Enum):
+        return _json_safe(value.value)
+    if value is None:
+        return None
+    if isinstance(value, str):
+        return str(value)
+    if isinstance(value, (bool, np.bool_)):
+        return bool(value)
+    if isinstance(value, (int, np.integer)):
+        return int(value)
+    if isinstance(value, (float, np.floating)):
+        value = float(value)
+        if not math.isfinite(value):
+            raise ValueError("JSON evidence contains a nonfinite number")
+        return float(value)
+    if isinstance(value, np.generic):
+        return _json_safe(value.item())
+    if isinstance(value, np.ndarray):
+        return _json_safe(value.tolist())
+    if isinstance(value, BaseException):
+        return _exception_evidence(value)
+    if is_dataclass(value):
+        return {
+            item.name: _json_safe(getattr(value, item.name)) for item in fields(value)
+        }
+    if isinstance(value, dict):
+        return {str(key): _json_safe(item) for key, item in value.items()}
+    if isinstance(value, (tuple, list)):
+        return [_json_safe(item) for item in value]
+    if hasattr(value, "isoformat"):
+        return str(value.isoformat())
+    return repr(value)