Skip to content

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

fix: preserve module entry points in source installs

Bingxi Zhao (Frank)7cb31af8077f
diff --git a/deeptutor/plugins/entry_points.py b/deeptutor/plugins/entry_points.py
index 659789370..cf9ee48c7 100644
--- a/deeptutor/plugins/entry_points.py
+++ b/deeptutor/plugins/entry_points.py
@@ -15,7 +15,7 @@ raises cannot stop the others from loading.
from __future__ import annotations
from collections.abc import Callable
-from importlib.metadata import entry_points
+from importlib.metadata import EntryPoint, entry_points
import logging
from typing import Any, TypeVar
@@ -24,6 +24,16 @@ logger = logging.getLogger(__name__)
T = TypeVar("T")
+def _module_entry_points(group: str) -> dict[tuple[str, str], bool]:
+ from deeptutor.modules.catalog import manifests, module_enabled
+
+ return {
+ (name, target): module_enabled(module)
+ for module, manifest in manifests().items()
+ for name, target in manifest.get("entry_points", {}).get(group, {}).items()
+ }
+
+
def load_entry_point_group(
group: str,
coerce: Callable[[str, Any], T | None],
@@ -45,9 +55,31 @@ def load_entry_point_group(
emit.warning("Failed to read %s entry points; no plugins loaded.", group, exc_info=True)
return out
+ from deeptutor.modules.catalog import source_checkout
+
+ official = _module_entry_points(group)
+ if source_checkout():
+ # Editable core installs do not own optional modules' wheel metadata.
+ # Add their declared entries without duplicating installed module wheels.
+ packaged = {(ep.name, getattr(ep, "value", None)) for ep in discovered}
+ discovered.extend(
+ EntryPoint(name=name, value=target, group=group)
+ for (name, target), enabled in official.items()
+ if enabled and (name, target) not in packaged
+ )
+
for ep in discovered:
name = getattr(ep, "name", str(ep))
try:
+ identity = (name, getattr(ep, "value", None))
+ if identity in official:
+ # Official code is governed by module selection, while external
+ # distributions retain the plugin approval/revocation checks.
+ if official[identity]:
+ value = coerce(name, ep.load())
+ if value is not None:
+ out.append(value)
+ continue
from deeptutor.plugins.runtime import entry_point_can_load, guard_entry_point_loaded
if not entry_point_can_load(ep, group):
diff --git a/tests/modules/test_entry_points.py b/tests/modules/test_entry_points.py
new file mode 100644
index 000000000..ca9f06b1e
--- /dev/null
+++ b/tests/modules/test_entry_points.py
@@ -0,0 +1,61 @@
+"""Official module entries work in source installs without bypassing plugin gates."""
+
+from types import SimpleNamespace
+
+import pytest
+
+from deeptutor.modules import catalog
+from deeptutor.plugins import entry_points
+from deeptutor.reading.extensions import ReadingExtensionRegistry
+from deeptutor.reading.read_aloud import ReadAloudExtension
+
+
[email protected](autouse=True)
+def isolated_modules(monkeypatch):
+ monkeypatch.setattr(catalog, "source_checkout", lambda: True)
+ monkeypatch.setattr(catalog, "selection", lambda: {})
+ monkeypatch.setattr(entry_points, "entry_points", lambda **_kwargs: [])
+
+
+def test_source_reading_extensions_do_not_need_installed_wheel_metadata():
+ assert {extension.manifest.id for extension in ReadingExtensionRegistry().all()} == {
+ "read_aloud",
+ "guided_learning",
+ "vocabulary",
+ "quiz",
+ "translation",
+ }
+
+
+def test_wheel_environment_does_not_invent_missing_entry_points(monkeypatch):
+ monkeypatch.setattr(catalog, "source_checkout", lambda: False)
+ monkeypatch.setattr(catalog, "module_enabled", lambda _name: True)
+ assert ReadingExtensionRegistry().all() == []
+
+
+def test_disabled_module_never_imports_its_packaged_extension(monkeypatch):
+ monkeypatch.setattr(catalog, "selection", lambda: {"reading": False})
+ ep = SimpleNamespace(
+ name="read_aloud",
+ value="deeptutor.reading.read_aloud:ReadAloudExtension",
+ load=lambda: pytest.fail("Disabled module extension was imported"),
+ )
+ monkeypatch.setattr(entry_points, "entry_points", lambda **_kwargs: [ep])
+ assert ReadingExtensionRegistry().all() == []
+
+
+def test_source_and_wheel_metadata_load_each_extension_once(monkeypatch):
+ calls = []
+
+ def load():
+ calls.append("read_aloud")
+ return ReadAloudExtension
+
+ ep = SimpleNamespace(
+ name="read_aloud",
+ value="deeptutor.reading.read_aloud:ReadAloudExtension",
+ load=load,
+ )
+ monkeypatch.setattr(entry_points, "entry_points", lambda **_kwargs: [ep])
+ assert len(ReadingExtensionRegistry().all()) == 5
+ assert calls == ["read_aloud"]
diff --git a/tests/plugins/test_registry_gating.py b/tests/plugins/test_registry_gating.py
index 0ff58ec4a..47f0286f4 100644
--- a/tests/plugins/test_registry_gating.py
+++ b/tests/plugins/test_registry_gating.py
@@ -174,6 +174,7 @@ def test_loop_entry_point_waits_for_approval(monkeypatch, tmp_path) -> None:
def test_reading_entry_point_waits_for_approval(monkeypatch, tmp_path) -> None:
+ monkeypatch.setattr(entry_points, "_module_entry_points", lambda _group: {})
registry = _plugin_registry(
tmp_path,
[{"type": "reading_extension", "id": "translation", "entry_point": "translation"}],
@@ -192,3 +193,28 @@ def test_reading_entry_point_waits_for_approval(monkeypatch, tmp_path) -> None:
registry.approve("org.author.gated")
allowed = ReadingExtensionRegistry()
assert allowed.get("translation") is not None
+
+
+def test_module_entries_do_not_bypass_external_reading_approval(monkeypatch, tmp_path):
+ class ExternalTranslation(TranslationExtension):
+ manifest = TranslationExtension.manifest.model_copy(update={"id": "external_translation"})
+
+ registry = _plugin_registry(
+ tmp_path,
+ [
+ {
+ "type": "reading_extension",
+ "id": "external_translation",
+ "entry_point": "external_translation",
+ }
+ ],
+ )
+ monkeypatch.setattr("deeptutor.plugins.registry.PluginRegistry", lambda: registry)
+ _patch_entry_points(
+ monkeypatch, "deeptutor.reading_extensions", "external_translation", ExternalTranslation
+ )
+ blocked = ReadingExtensionRegistry()
+ assert blocked.get("read_aloud") is not None
+ assert blocked.get("external_translation") is None
+ registry.approve("org.author.gated")
+ assert ReadingExtensionRegistry().get("external_translation") is not None
diff --git a/tests/reading/test_quiz.py b/tests/reading/test_quiz.py
index 2dcdca0a0..60d179de7 100644
--- a/tests/reading/test_quiz.py
+++ b/tests/reading/test_quiz.py
@@ -1,14 +1,13 @@
from __future__ import annotations
import json
-from pathlib import Path
-import tomllib
from fastapi import FastAPI
from fastapi.testclient import TestClient
import pytest
from deeptutor.api.routers import reading_extensions
+from deeptutor.modules.catalog import manifests
from deeptutor.reading import ReadingStore
from deeptutor.reading.extensions import ReadingContext, ReadingExtensionRegistry
from deeptutor.reading.quiz import ReadingQuizExtension
@@ -191,8 +190,7 @@ async def test_invalid_or_ungrounded_model_output_is_rejected(monkeypatch, respo
def test_quiz_is_registered_as_a_packaged_extension():
- project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
- group = project["project"]["entry-points"]["deeptutor.reading_extensions"]
+ group = manifests()["reading"]["entry_points"]["deeptutor.reading_extensions"]
assert group["quiz"] == "deeptutor.reading.quiz:ReadingQuizExtension"
diff --git a/tests/reading/test_read_aloud.py b/tests/reading/test_read_aloud.py
index d1c6c3dc7..35e519706 100644
--- a/tests/reading/test_read_aloud.py
+++ b/tests/reading/test_read_aloud.py
@@ -1,8 +1,6 @@
from __future__ import annotations
import io
-from pathlib import Path
-import tomllib
from typing import Any
import wave
@@ -11,6 +9,7 @@ from fastapi.testclient import TestClient
import pytest
from deeptutor.api.routers import reading_extensions
+from deeptutor.modules.catalog import manifests
from deeptutor.reading import ReadingStore
from deeptutor.reading.extensions import ReadingContext, ReadingExtensionRegistry
from deeptutor.reading.read_aloud import ReadAloudExtension
@@ -33,8 +32,7 @@ def test_read_aloud_returns_verified_visible_text_only():
def test_read_aloud_is_registered_as_a_packaged_extension():
- project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
- group = project["project"]["entry-points"]["deeptutor.reading_extensions"]
+ group = manifests()["reading"]["entry_points"]["deeptutor.reading_extensions"]
assert group["read_aloud"] == "deeptutor.reading.read_aloud:ReadAloudExtension"
diff --git a/tests/reading/test_study_guidance.py b/tests/reading/test_study_guidance.py
index ef29a57d2..ecc4dfca3 100644
--- a/tests/reading/test_study_guidance.py
+++ b/tests/reading/test_study_guidance.py
@@ -1,14 +1,13 @@
from __future__ import annotations
import json
-from pathlib import Path
-import tomllib
from fastapi import FastAPI
from fastapi.testclient import TestClient
import pytest
from deeptutor.api.routers import reading_extensions
+from deeptutor.modules.catalog import manifests
from deeptutor.reading import ReadingStore
from deeptutor.reading.extensions import ReadingContext, ReadingExtensionRegistry
from deeptutor.reading.study_guidance import StudyGuidanceExtension
@@ -171,8 +170,7 @@ async def test_invalid_or_overlong_model_output_is_rejected(monkeypatch, respons
def test_study_guidance_is_registered_as_a_packaged_extension():
- project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
- group = project["project"]["entry-points"]["deeptutor.reading_extensions"]
+ group = manifests()["reading"]["entry_points"]["deeptutor.reading_extensions"]
assert group["guided_learning"] == ("deeptutor.reading.study_guidance:StudyGuidanceExtension")
diff --git a/tests/reading/test_translation.py b/tests/reading/test_translation.py
index 30e3ac08b..b24c5fabf 100644
--- a/tests/reading/test_translation.py
+++ b/tests/reading/test_translation.py
@@ -1,14 +1,13 @@
from __future__ import annotations
import json
-from pathlib import Path
-import tomllib
from fastapi import FastAPI
from fastapi.testclient import TestClient
import pytest
from deeptutor.api.routers import reading_extensions
+from deeptutor.modules.catalog import manifests
from deeptutor.reading import ReadingStore
from deeptutor.reading.extensions import ReadingContext, ReadingExtensionRegistry
from deeptutor.reading.translation import TranslationExtension
@@ -174,8 +173,7 @@ async def test_invalid_or_wrong_language_model_output_is_rejected(monkeypatch, r
def test_translation_is_registered_as_a_packaged_extension():
- project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
- group = project["project"]["entry-points"]["deeptutor.reading_extensions"]
+ group = manifests()["reading"]["entry_points"]["deeptutor.reading_extensions"]
assert group["translation"] == "deeptutor.reading.translation:TranslationExtension"
diff --git a/tests/reading/test_vocabulary.py b/tests/reading/test_vocabulary.py
index 04f90e2db..e1c16de79 100644
--- a/tests/reading/test_vocabulary.py
+++ b/tests/reading/test_vocabulary.py
@@ -1,14 +1,13 @@
from __future__ import annotations
import json
-from pathlib import Path
-import tomllib
from fastapi import FastAPI
from fastapi.testclient import TestClient
import pytest
from deeptutor.api.routers import reading_extensions
+from deeptutor.modules.catalog import manifests
from deeptutor.reading import ReadingStore
from deeptutor.reading.extensions import ReadingContext, ReadingExtensionRegistry
from deeptutor.reading.vocabulary import VocabularyExtension
@@ -204,8 +203,7 @@ async def test_invalid_or_ungrounded_model_output_is_rejected(monkeypatch, respo
def test_vocabulary_is_registered_as_a_packaged_extension():
- project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
- group = project["project"]["entry-points"]["deeptutor.reading_extensions"]
+ group = manifests()["reading"]["entry_points"]["deeptutor.reading_extensions"]
assert group["vocabulary"] == "deeptutor.reading.vocabulary:VocabularyExtension"
diff --git a/tests/services/session/test_source_inventory.py b/tests/services/session/test_source_inventory.py
index f963c5d86..e41477d33 100644
--- a/tests/services/session/test_source_inventory.py
+++ b/tests/services/session/test_source_inventory.py
@@ -452,7 +452,7 @@ async def test_build_inventory_fresh_shadows_historical_on_same_sid() -> None:
async def test_build_inventory_adds_server_resolved_reading_units(
monkeypatch: pytest.MonkeyPatch,
) -> None:
- from deeptutor.services.session import source_inventory
+ from deeptutor.reading import references
seen: list[dict[str, Any]] = []
@@ -466,7 +466,7 @@ async def test_build_inventory_adds_server_resolved_reading_units(
)
]
- monkeypatch.setattr(source_inventory, "resolve_reading_sources", resolve)
+ monkeypatch.setattr(references, "resolve_reading_sources", resolve)
inv = await build_inventory(
FakeStore(),
session_id="s1",
@@ -493,10 +493,10 @@ async def test_build_inventory_adds_server_resolved_reading_units(
async def test_historical_reading_units_are_re_resolved_from_snapshot(
monkeypatch: pytest.MonkeyPatch,
) -> None:
- from deeptutor.services.session import source_inventory
+ from deeptutor.reading import references
monkeypatch.setattr(
- source_inventory,
+ references,
"resolve_reading_sources",
lambda refs: (
[