Add dvue entry point for SCHISM readers and refactor registration function

Author: dwr-psandhu

pyproject.toml

@@ -62,6 +62,9 @@ suxarray = [
 [project.scripts]
 schismviz = "schismviz.cli:main"
 
+[project.entry-points."dvue.plugins"]
+schismviz = "schismviz.readers:register_readers"
+
 [project.urls]
 Homepage = "https://github.com/cadwrdeltamodeling/schismviz"
 Documentation = "https://github.com/cadwrdeltamodeling/schismviz#readme"

schismviz/readers.py

@@ -7,8 +7,9 @@
     dvue ui --plugin schismviz.readers /path/to/study/param.nml
     dvue ui --plugin schismviz.readers /path/to/schism_studies.yaml
 
-The registration call at the bottom of this module fires at import time,
-so all three entry points work:
+The :func:`register_readers` function is used by setuptools entry points
+(``dvue.plugins`` group).  For backward compatibility, registration also
+fires at import time, so all three entry points work:
 
 1. ``dvue ui --plugin schismviz.readers`` (generic dvue combine UI)
 2. ``schismviz combine`` (SCHISM-specific combine UI via this package's CLI)
@@ -534,21 +535,33 @@ def is_irregular(self, r) -> bool:
 
 
 # ---------------------------------------------------------------------------
-# Registration — runs at import time
+# Registration
 # ---------------------------------------------------------------------------
 
-# Compound NML extensions (.nml.clinic, .nml.barotropic, .nml.tropic) are
-# identified by their *last* suffix via os.path.splitext in the registry;
-# scan() inspects the full suffix chain to confirm the .nml prefix.
-ReaderRegistry.register(
-    "schism_output",
-    SchismOutputReader,
-    extensions=[
-        ".nml",
-        ".clinic",
-        ".barotropic",
-        ".tropic",
-        ".yaml",
-        ".yml",
-    ],
-)
+
+def register_readers() -> None:
+    """Register SCHISM readers with dvue's :class:`ReaderRegistry`.
+
+    This is the callable referenced by the ``dvue.plugins`` entry point:
+
+    ``schismviz = \"schismviz.readers:register_readers\"``.
+    """
+
+    # Compound NML extensions (.nml.clinic, .nml.barotropic, .nml.tropic) are
+    # identified by their *last* suffix via os.path.splitext in the registry;
+    # scan() inspects the full suffix chain to confirm the .nml prefix.
+    ReaderRegistry.register(
+        "schism_output",
+        SchismOutputReader,
+        extensions=[
+            ".nml",
+            ".clinic",
+            ".barotropic",
+            ".tropic",
+            ".yaml",
+            ".yml",
+        ],
+    )
+
+# Backward compatibility: preserve import-time registration behavior.
+register_readers()

tests/test_readers.py

@@ -35,6 +35,20 @@ def test_registration_on_import():
     assert ReaderRegistry.can_handle("param.nml.tropic"), ".nml.tropic not registered"
 
 
+def test_register_readers_function_registers_plugin_mappings():
+    """register_readers() maps schism_output and supported extensions."""
+    from schismviz.readers import SchismOutputReader, register_readers
+
+    register_readers()
+
+    readers = ReaderRegistry.get_registered_readers()
+    extensions = ReaderRegistry.get_registered_extensions()
+
+    assert readers.get("schism_output") is SchismOutputReader
+    for ext in [".nml", ".clinic", ".barotropic", ".tropic", ".yaml", ".yml"]:
+        assert extensions.get(ext) is SchismOutputReader
+
+
 def test_ref_type():
     """SchismDataReference advertises ref_type='schism_output'."""
     from schismviz.readers import SchismDataReference