Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

fix(app): serialize slotted capability contracts

dajiaohuang5406f5c3b0dd
diff --git a/deeptutor/app/facade.py b/deeptutor/app/facade.py
index d9e5998d0..ef69bc9e3 100644
--- a/deeptutor/app/facade.py
+++ b/deeptutor/app/facade.py
@@ -2,7 +2,7 @@
from __future__ import annotations
-from dataclasses import dataclass
+from dataclasses import asdict, dataclass
from functools import wraps
import importlib.util
import inspect
@@ -97,7 +97,7 @@ class DeepTutorApp:
contracts.append(
{
**manifest,
- "availability": self.get_capability_availability(manifest["name"]).__dict__,
+ "availability": asdict(self.get_capability_availability(manifest["name"])),
}
)
return contracts
@@ -108,7 +108,7 @@ class DeepTutorApp:
if manifest["name"] == resolved:
return {
**manifest,
- "availability": self.get_capability_availability(resolved).__dict__,
+ "availability": asdict(self.get_capability_availability(resolved)),
}
raise ValueError(f"Capability not found: {resolved}")
diff --git a/tests/app/test_capability_contracts.py b/tests/app/test_capability_contracts.py
new file mode 100644
index 000000000..9c1dc0826
--- /dev/null
+++ b/tests/app/test_capability_contracts.py
@@ -0,0 +1,45 @@
+"""The public SDK returns JSON-compatible capability availability contracts."""
+
+import importlib.util
+import json
+
+import pytest
+
+from deeptutor.app import DeepTutorApp
+
+
+def test_single_capability_contract_serializes_availability() -> None:
+ contract = DeepTutorApp().get_capability_contract("chat")
+
+ assert contract["name"] == "chat"
+ assert contract["availability"] == {
+ "name": "chat",
+ "available": True,
+ "install_hint": "",
+ }
+ assert json.loads(json.dumps(contract))["availability"] == contract["availability"]
+
+
[email protected]("manim_available", [False, True])
+def test_capability_list_preserves_optional_install_hint(
+ monkeypatch: pytest.MonkeyPatch, manim_available: bool
+) -> None:
+ original_find_spec = importlib.util.find_spec
+
+ def find_spec(name: str, package: str | None = None) -> object | None:
+ if name == "manim":
+ return object() if manim_available else None
+ return original_find_spec(name, package)
+
+ monkeypatch.setattr(importlib.util, "find_spec", find_spec)
+ contracts = DeepTutorApp().get_capability_contracts()
+ by_name = {contract["name"]: contract for contract in json.loads(json.dumps(contracts))}
+
+ assert by_name["chat"]["availability"]["available"] is True
+ availability = by_name["math_animator"]["availability"]
+ assert availability["name"] == "math_animator"
+ assert availability["available"] is manim_available
+ if manim_available:
+ assert availability["install_hint"] == ""
+ else:
+ assert "math-animator" in availability["install_hint"]