detquantlib 5.9.0__tar.gz → 5.9.1__tar.gz

{detquantlib-5.9.0 → detquantlib-5.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detquantlib
-Version: 5.9.0
+Version: 5.9.1
 Summary: An internal library containing functions and classes that can be used across Quant models.
 License-File: LICENSE.txt
 Author: Dynamic Energy Trading

{detquantlib-5.9.0 → detquantlib-5.9.1}/detquantlib/snapshot_testing/README.md

@@ -54,7 +54,9 @@ A run goes through the following steps (see `run_snapshot_case()` in `pytest_plu
 3. In replay and update modes, the network is blocked and the local `.env` file is ignored, so
    that local runs behave exactly like CI (which has no credentials).
 4. The model runs through its real entry point, with the time frozen if the test case says so,
-   and with its logging isolated from the rest of the pytest process.
+   and with its logging isolated from the rest of the pytest process. The test only prints the
+   name and description of the test case: everything the model prints or logs to the console is
+   written to `tests/snapshot/.actual/CaseXX/console.txt` instead.
 5. The outputs are compared with the snapshot (replay mode), or replace it (update and record
    modes).
 
@@ -114,6 +116,10 @@ created by that run, which are also detached afterwards. The exception hooks rep
 `detquantlib.utils.setup_logger` are restored as well. The working directory and the
 `INPUT_DIR` / `OUTPUT_DIR` environment variables are restored after each test.
 
+The model's console output (stdout, stderr, and console log handlers created by the model) is
+muted and written to `tests/snapshot/.actual/CaseXX/console.txt`, also when the model crashes.
+The run log written to the outputs folder is not affected.
+
 ### Output Comparison
 
 Each file of the outputs folder is compared with its snapshot according to its type:
@@ -324,20 +330,6 @@ ignore = ["plots/*.png"]
 | `atol`        | `config.atol`    | Absolute tolerance of numerical comparisons                        |
 | `ignore`      | `[]`             | Additional output files not compared (glob patterns)               |
 
-### Creating a Test Case
-
-`create_case(inputs_dir, cases_root)` creates the folder of a new test case, with the lowest free
-case number. It copies the given inputs folder (typically the project's default `Inputs` folder)
-and writes a `case.toml` file to complete, which freezes the time at the moment of creation. Then
-record the new test case:
-
-```cmd
-pytest tests/snapshot --snapshot-record -k Case02
-```
-
-Test cases can also be created manually: create the folder with a `case.toml` file and an `Inputs`
-folder, then record it. Freeze the time _before_ recording if the model uses the current date.
-
 `print_cases(cases_root)` lists the test cases and their descriptions:
 
 ```
@@ -348,6 +340,23 @@ folder, then record it. Freeze the time _before_ recording if the model uses the
   This is another description
 ```
 
+### Creating a Test Case
+
+Step 1: Execute `create_case(inputs_dir, cases_root)`. The function handles the following actions:
+- Creates the folder of a new test case, with the lowest free case number.
+- Copies the given inputs folder (typically the project's default `Inputs` folder).
+- Writes a `case.toml` file to complete, which freezes the time at the moment of creation.
+
+Alternatively, test cases can also be created manually: create the folder with a `case.toml`
+file and an `Inputs` folder. Freeze the time (_before_ recording) if the model uses the current
+date.
+
+Step 2: Record the new test case with the following command:
+
+```cmd
+pytest tests/snapshot --snapshot-record -k Case02
+```
+
 ## Day-to-Day Usage
 
 ```cmd
@@ -364,7 +373,7 @@ pytest tests/snapshot --snapshot-record -k Case01      # re-record a single test
   `--snapshot-record` locally, with database access. Review the changes to `db_cache` (queries,
   data) and `ExpectedOutputs`.
 - **A test fails in CI**: download the `snapshot-actual-outputs` artifact of the workflow run to
-  inspect the produced outputs.
+  inspect the produced outputs and the model's console output (`console.txt`).
 
 ## The DB Cache
 

{detquantlib-5.9.0 → detquantlib-5.9.1}/detquantlib/snapshot_testing/isolation.py

@@ -12,6 +12,7 @@ import logging
 import socket
 import sys
 import threading
+from pathlib import Path
 from typing import Any
 
 # Internal modules
@@ -118,6 +119,25 @@ def frozen_time(moment: Any):
         traveller.stop()
 
 
+@contextlib.contextmanager
+def muted_console(console_path: Path):
+    """
+    Mutes everything the model prints or logs to the console: stdout and stderr (including the
+    console handlers created by the model's logging setup) are written to a file instead, kept
+    for inspection.
+
+    Args:
+        console_path: File receiving the console output of the run
+
+    Yields:
+        Nothing; the model runs inside the context
+    """
+    console_path.parent.mkdir(parents=True, exist_ok=True)
+    with open(console_path, "w", encoding="utf-8") as f:
+        with contextlib.redirect_stdout(f), contextlib.redirect_stderr(f):
+            yield
+
+
 @contextlib.contextmanager
 def isolated_logging(monkeypatch):
     """

{detquantlib-5.9.0 → detquantlib-5.9.1}/detquantlib/snapshot_testing/pytest_plugin.py

@@ -31,11 +31,17 @@ import pytest
 from detquantlib.snapshot_testing.cases import SnapshotCase
 from detquantlib.snapshot_testing.comparison import compare_dirs, write_snapshot
 from detquantlib.snapshot_testing.config import SnapshotConfig
-from detquantlib.snapshot_testing.isolation import block_network, frozen_time, isolated_logging
+from detquantlib.snapshot_testing.isolation import (
+    block_network,
+    frozen_time,
+    isolated_logging,
+    muted_console,
+)
 from detquantlib.snapshot_testing.recording import DbRecorder, install_db_patches
 
 MODES = ("replay", "update", "record")
 OUTPUTS_DIRNAME = "Outputs"
+CONSOLE_FILENAME = "console.txt"
 
 
 def pytest_addoption(parser: pytest.Parser):
@@ -133,6 +139,9 @@ def run_snapshot_case(
     if mode not in MODES:
         raise ValueError(f"Unknown snapshot mode '{mode}'. Accepted values: {', '.join(MODES)}.")
     print(f"\nRunning snapshot test case '{case.name}' ({mode} mode) ...")
+    print("Case description:")
+    for line in (case.description or "(no description)").splitlines():
+        print(f"  {line}".rstrip())
     record = mode == "record"
     update = mode in ("record", "update")
     ignore = [*config.ignore_patterns, *case.ignore]
@@ -158,7 +167,14 @@ def run_snapshot_case(
         monkeypatch.delenv(var, raising=False)
 
     # 4. Run the model through its real entry point
-    with frozen_time(case.frozen_time) as real_time, isolated_logging(monkeypatch):
+    #    Everything the model prints or logs to the console goes to .actual/CaseXX/console.txt.
+    #    Exit order matters: the run's log handlers are flushed before the console file closes.
+    console_path = config.actual_dir / case.name / CONSOLE_FILENAME
+    with (
+        muted_console(console_path),
+        frozen_time(case.frozen_time) as real_time,
+        isolated_logging(monkeypatch),
+    ):
         recorder.real_time = real_time  # live DB calls (record mode) see the real clock
         entry_point.run(input_dir=case.inputs_dir, output_dir=output_dir)
 

{detquantlib-5.9.0 → detquantlib-5.9.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "detquantlib"
-version = "5.9.0"
+version = "5.9.1"
 description = "An internal library containing functions and classes that can be used across Quant models."
 authors = ["Dynamic Energy Trading"]
 readme = "README.md"