misc: use doctest and type more

pixi.toml

@@ -30,7 +30,7 @@ pytest = ">=8.2.2,<9"
 syrupy = ">=4.6.1,<5"
 
 [feature.tests.tasks]
-tests = "pytest tests"
+tests = "pytest --doctest-modules"
 snapshot_update = "pytest --snapshot-update tests"
 
 [feature.lint.dependencies]

src/rattler_build_conda_compat/jinja.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, TypedDict
 
 import jinja2
 import yaml
@@ -9,7 +9,11 @@
 from rattler_build_conda_compat.loader import load_yaml
 
 
-class MissingUndefined(DebugUndefined):
+class RecipeWithContext(TypedDict, total=False):
+    context: dict[str, str]
+
+
+class _MissingUndefined(DebugUndefined):
     def __str__(self) -> str:
         """
         By default, `DebugUndefined` return values in the form `{{ value }}`.
@@ -29,7 +33,7 @@ def jinja_env() -> jinja2.Environment:
         trim_blocks=True,
         lstrip_blocks=True,
         autoescape=True,
-        undefined=MissingUndefined,
+        undefined=_MissingUndefined,
     )
 
 
@@ -48,21 +52,20 @@ def load_recipe_context(context: dict[str, str], jinja_env: jinja2.Environment)
     return context
 
 
-def eval_recipe_using_context(recipe_content: dict[str, Any]) -> dict[str, Any]:
+def eval_recipe_using_context(recipe_content: RecipeWithContext) -> dict[str, Any]:
     """
     Evaluate the recipe using known values from context section.
     Unknown values are not evaluated and are kept as it is.
-    Example:
-    ```yaml
-    context:
-      name: "my_value"
-    build:
-       string: ${{ name }}-${{ not_present_value }}
-    ```
-    will be rendered as:
-    ```yaml
-    build:
-       string: my_value-${{ not_present_value }}
+
+    Examples:
+    ---
+    ```python
+    >>> from pathlib import Path
+    >>> from rattler_build_conda_compat.loader import load_yaml
+    >>> recipe_content = load_yaml((Path().resolve() / "tests" / "data" / "eval_recipe_using_context.yaml").read_text())
+    >>> evaluated_context = eval_recipe_using_context(recipe_content)
+    >>> assert "my_value-${{ not_present_value }}" == evaluated_context["build"]["string"]
+    >>>
     ```
     """
     env = jinja_env()

tests/__snapshots__/test_jinja.ambr

@@ -1,17 +1,15 @@
 # serializer version: 1
 # name: test_render_context
-  dict({
-    'build': dict({
-      'string': '${{ blas_variant }}${{ hash }}_foo-bla',
-    }),
-    'context': dict({
-      'name': 'foo',
-      'name_version': 'foo-bla',
-      'version': 'bla',
-    }),
-    'package': dict({
-      'name': 'foo',
-      'version': 'bla',
-    }),
-  })
+  '''
+  build:
+    string: ${{ blas_variant }}${{ hash }}_foo-bla
+  context:
+    name: foo
+    name_version: foo-bla
+    version: bla
+  package:
+    name: foo
+    version: bla
+
+  '''
 # ---

tests/data/eval_recipe_using_context.yaml

@@ -0,0 +1,4 @@
+context:
+  name: "my_value"
+build:
+  string: ${{ name }}-${{ not_present_value }}

tests/test_jinja.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 
+import yaml
 from rattler_build_conda_compat.jinja import eval_recipe_using_context, load_yaml
 
 
@@ -9,4 +10,6 @@ def test_render_context(snapshot) -> None:
         recipe_yaml = load_yaml(f)
 
     rendered = eval_recipe_using_context(recipe_yaml)
-    assert rendered == snapshot
+    into_yaml = yaml.dump(rendered)
+
+    assert into_yaml == snapshot