Use dedicated types for AllComponent specs

Author: jl-wynen

src/ess/reduce/nexus/_nexus_loader.py

@@ -13,7 +13,14 @@
 import scippnexus as snx
 
 from ..logging import get_logger
-from .types import FilePath, NeXusEntryName, NeXusFile, NeXusGroup, NeXusLocationSpec
+from .types import (
+    FilePath,
+    NeXusAllLocationSpec,
+    NeXusEntryName,
+    NeXusFile,
+    NeXusGroup,
+    NeXusLocationSpec,
+)
 
 
 class NoNewDefinitionsType: ...
@@ -41,17 +48,12 @@ def load_component(
 
 
 def load_all_components(
-    location: NeXusLocationSpec,
+    location: NeXusAllLocationSpec,
     *,
     nx_class: type[snx.NXobject],
     definitions: Mapping | None | NoNewDefinitionsType = NoNewDefinitions,
 ) -> sc.DataGroup:
     """Load all components of a given class from NeXus."""
-    if location.component_name is not None:
-        raise ValueError(
-            "`location.component_name` must be None when loading all "
-            "components of a certain class."
-        )
     with _open_component_parent(
         location, nx_class=nx_class, definitions=definitions
     ) as parent:

src/ess/reduce/nexus/types.py

@@ -230,6 +230,24 @@ class NeXusComponentLocationSpec(NeXusLocationSpec, Generic[Component, RunType])
     """
 
 
+@dataclass
+class NeXusAllLocationSpec:
+    """
+    NeXus parameters to identify all components of a class to load.
+    """
+
+    filename: FilePath | NeXusFile | NeXusGroup
+    entry_name: NeXusEntryName | None = None
+    selection: snx.typing.ScippIndex | slice = ()
+
+
+@dataclass
+class NeXusAllComponentLocationSpec(NeXusAllLocationSpec, Generic[Component, RunType]):
+    """
+    NeXus parameters to identify all components of a class to load.
+    """
+
+
 @dataclass
 class NeXusDataLocationSpec(NeXusLocationSpec, Generic[Component, RunType]):
     """NeXus filename and parameters to identify (parts of) detector data to load."""

src/ess/reduce/nexus/workflow.py

@@ -32,6 +32,7 @@
     MonitorData,
     MonitorPositionOffset,
     MonitorType,
+    NeXusAllComponentLocationSpec,
     NeXusClass,
     NeXusComponent,
     NeXusComponentLocationSpec,
@@ -100,20 +101,11 @@ def component_spec_by_name(
     )
 
 
-def disk_chopper_component_spec(
+def all_component_spec(
     filename: NeXusFileSpec[RunType],
-) -> NeXusComponentLocationSpec[snx.NXdisk_chopper, RunType]:
-    """Create a location spec for a disk chopper group in a NeXus file."""
-    return NeXusComponentLocationSpec[snx.NXdisk_chopper, RunType](
-        filename=filename.value
-    )
-
-
-def crystal_component_spec(
-    filename: NeXusFileSpec[RunType],
-) -> NeXusComponentLocationSpec[snx.NXcrystal, RunType]:
-    """Create a location spec for a crystal / analyzer group in a NeXus file."""
-    return NeXusComponentLocationSpec[snx.NXcrystal, RunType](filename=filename.value)
+) -> NeXusAllComponentLocationSpec[Component, RunType]:
+    """Create a location spec for all components of a class in a NeXus file."""
+    return NeXusAllComponentLocationSpec[Component, RunType](filename=filename.value)
 
 
 def unique_component_spec(
@@ -235,7 +227,7 @@ def load_nexus_component(
 
 
 def load_all_nexus_components(
-    location: NeXusComponentLocationSpec[Component, RunType],
+    location: NeXusAllComponentLocationSpec[Component, RunType],
     nx_class: NeXusClass[Component],
 ) -> AllNeXusComponents[Component, RunType]:
     """
@@ -604,9 +596,8 @@ def _add_variances(da: sc.DataArray) -> sc.DataArray:
     file_path_to_file_spec,
     full_time_interval,
     component_spec_by_name,
-    disk_chopper_component_spec,
-    crystal_component_spec,
     unique_component_spec,  # after component_spec_by_name, partially overrides
+    all_component_spec,
     get_transformation_chain,
     to_transformation,
     compute_position,