feat: modify define_function_handling_dict_from_class to inject function to module directly

Author: alejoe91

src/spikeinterface/core/core_tools.py

@@ -56,7 +56,8 @@ def source_class_or_dict_of_sources_classes(*args, **kwargs):
     source_class_or_dict_of_sources_classes.__doc__ = source_class.__doc__
     source_class_or_dict_of_sources_classes.__name__ = name
 
-    return source_class_or_dict_of_sources_classes
+    # This is a trick to make the function available in the global namespace of the caller module
+    sys._getframe(1).f_globals[name] = source_class_or_dict_of_sources_classes
 
 
 # Generic typing needed to help propagate typing
@@ -67,7 +68,7 @@ def source_class_or_dict_of_sources_classes(*args, **kwargs):
 
 
 def define_function_from_class(source_class: Callable[P, T], name: str) -> Callable[P, T]:
-    "Wrapper to change the name of a class"
+    "Wrapper to inject source_class into the caller's module namespace under name."
 
     return source_class
 

src/spikeinterface/core/segmentutils.py

@@ -83,7 +83,7 @@ def get_traces(self, *args, **kwargs):
         return self.parent_segment.get_traces(*args, **kwargs)
 
 
-append_recordings = define_function_from_class(source_class=AppendSegmentRecording, name="append_segment_recording")
+append_recordings = define_function_from_class(source_class=AppendSegmentRecording, name="append_recordings")
 
 
 class ConcatenateSegmentRecording(BaseRecording):

src/spikeinterface/extractors/neoextractors/mcsraw.py

@@ -60,4 +60,4 @@ def map_to_neo_kwargs(cls, file_path):
         return neo_kwargs
 
 
-read_mcsraw = define_function_from_class(source_class=MCSRawRecordingExtractor, name="read_maxwell_event")
+read_mcsraw = define_function_from_class(source_class=MCSRawRecordingExtractor, name="read_mcsraw")

src/spikeinterface/preprocessing/astype.py

@@ -78,4 +78,4 @@ def get_traces(self, start_frame, end_frame, channel_indices):
 
 
 # function for API
-astype = define_function_handling_dict_from_class(source_class=AstypeRecording, name="astype")
+define_function_handling_dict_from_class(source_class=AstypeRecording, name="astype")

src/spikeinterface/preprocessing/average_across_direction.py

@@ -137,7 +137,7 @@ def get_traces(self, start_frame, end_frame, channel_indices):
 
 
 # function for API
-average_across_direction = define_function_handling_dict_from_class(
+define_function_handling_dict_from_class(
     source_class=AverageAcrossDirectionRecording,
     name="average_across_direction",
 )

src/spikeinterface/preprocessing/clip.py

@@ -167,7 +167,5 @@ def get_traces(self, start_frame, end_frame, channel_indices):
         return traces
 
 
-clip = define_function_handling_dict_from_class(source_class=ClipRecording, name="clip")
-blank_saturation = define_function_handling_dict_from_class(
-    source_class=BlankSaturationRecording, name="blank_saturation"
-)
+define_function_handling_dict_from_class(source_class=ClipRecording, name="clip")
+define_function_handling_dict_from_class(source_class=BlankSaturationRecording, name="blank_saturation")

src/spikeinterface/preprocessing/common_reference.py

@@ -325,6 +325,4 @@ def slice_groups(self, channel_indices):
         return zip(group_indices, selected_channels, group_channels)
 
 
-common_reference = define_function_handling_dict_from_class(
-    source_class=CommonReferenceRecording, name="common_reference"
-)
+define_function_handling_dict_from_class(source_class=CommonReferenceRecording, name="common_reference")

src/spikeinterface/preprocessing/decimate.py

@@ -134,4 +134,4 @@ def get_traces(self, start_frame, end_frame, channel_indices):
         ].astype(self._dtype)
 
 
-decimate = define_function_handling_dict_from_class(source_class=DecimateRecording, name="decimate")
+define_function_handling_dict_from_class(source_class=DecimateRecording, name="decimate")

src/spikeinterface/preprocessing/deepinterpolation/deepinterpolation.py

@@ -191,6 +191,4 @@ def get_traces(self, start_frame, end_frame, channel_indices):
 
 
 # function for API
-deepinterpolate = define_function_handling_dict_from_class(
-    source_class=DeepInterpolatedRecording, name="deepinterpolate"
-)
+define_function_handling_dict_from_class(source_class=DeepInterpolatedRecording, name="deepinterpolate")

src/spikeinterface/preprocessing/depth_order.py

@@ -41,4 +41,4 @@ def __init__(self, parent_recording, channel_ids=None, dimensions=("x", "y"), fl
         )
 
 
-depth_order = define_function_handling_dict_from_class(source_class=DepthOrderRecording, name="depth_order")
+define_function_handling_dict_from_class(source_class=DepthOrderRecording, name="depth_order")