ENH: allow registering several suffixes for path adapters in a single call

Author: gdementen

larray_editor/arrayadapter.py

@@ -142,35 +142,38 @@ def decorate_callable(adapter_creator):
 PATH_SUFFIX_ADAPTERS = {}
 
 
-def register_path_adapter(suffix, adapter_creator, required_module=None):
+def register_path_adapter(suffixes, adapter_creator, required_module=None):
     """Register an adapter to display a file type (extension)
 
     Parameters
     ----------
-    suffix : str
-        File type for which the adapter should be used.
+    suffixes : str | list[str]
+        File extension(s) for which the adapter should be used.
     adapter_creator : callable
         Callable which will return an Adapter instance.
     required_module : str
         Name of module required to handle this file type.
     """
-    if suffix in PATH_SUFFIX_ADAPTERS:
-        logger.warning(f"Replacing path adapter for {suffix}")
-    PATH_SUFFIX_ADAPTERS[suffix] = (adapter_creator, required_module)
+    if isinstance(suffixes, str):
+        suffixes = [suffixes]
+    for suffix in suffixes:
+        if suffix in PATH_SUFFIX_ADAPTERS:
+            logger.warning(f"Replacing path adapter for {suffix}")
+        PATH_SUFFIX_ADAPTERS[suffix] = (adapter_creator, required_module)
 
 
-def path_adapter_for(suffix, required_module=None):
+def path_adapter_for(suffixes, required_module=None):
     """Class/function decorator to register new file-type adapters
 
     Parameters
     ----------
-    suffix : str
-        File type associated with adapter class.
-    required_module : str
+    suffixes : str | list[str]
+        File extension(s) associated with adapter class.
+    required_module : str, optional
         Name of module required to handle this file type.
     """
     def decorate_callable(adapter_creator):
-        register_path_adapter(suffix, adapter_creator, required_module)
+        register_path_adapter(suffixes, adapter_creator, required_module)
         return adapter_creator
     return decorate_callable
 
@@ -1674,8 +1677,7 @@ def cell_activated(self, row_idx, column_idx):
         return self.data[row_idx]
 
 
-@path_adapter_for('.xlsx', 'xlwings')
-@path_adapter_for('.xls', 'xlwings')
+@path_adapter_for(('.xlsx', '.xls'), 'xlwings')
 class XlsxPathAdapter(WorkbookAdapter):
     @classmethod
     def open(cls, fpath):
@@ -1972,9 +1974,7 @@ def get_values(self, h_start, v_start, h_stop, v_stop):
 # Contrary to other Path adapters, this one is both a File *and* Path adapter
 # because it is more efficient to NOT keep the file open (because the pyarrow
 # API only allows limiting which columns are read when opening the file)
-@path_adapter_for('.feather', 'pyarrow.ipc')
-@path_adapter_for('.ipc', 'pyarrow.ipc')
-@path_adapter_for('.arrow', 'pyarrow.ipc')
+@path_adapter_for(('.feather', '.ipc', '.arrow'), 'pyarrow.ipc')
 @adapter_for('pyarrow.RecordBatchFileReader')
 class FeatherFileAdapter(AbstractColumnarAdapter):
     def __init__(self, data, attributes):
@@ -2646,8 +2646,7 @@ def get_values(self, h_start, v_start, h_stop, v_stop):
         return np.array(res, dtype=object)
 
 
-@path_adapter_for('.av', 'iode')
-@path_adapter_for('.var', 'iode')
+@path_adapter_for(('.av', '.var'), 'iode')
 class IodeVariablesPathAdapter(IodeVariablesAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2656,8 +2655,7 @@ def open(cls, fpath):
         return iode.variables
 
 
-@path_adapter_for('.as', 'iode')
-@path_adapter_for('.scl', 'iode')
+@path_adapter_for(('.as', 'scl'), 'iode')
 class IodeScalarsPathAdapter(IodeScalarsAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2666,8 +2664,7 @@ def open(cls, fpath):
         return iode.scalars
 
 
-@path_adapter_for('.ac', 'iode')
-@path_adapter_for('.cmt', 'iode')
+@path_adapter_for(('.ac', '.cmt'), 'iode')
 class IodeCommentsPathAdapter(IodeCommentsAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2676,8 +2673,7 @@ def open(cls, fpath):
         return iode.comments
 
 
-@path_adapter_for('.at', 'iode')
-@path_adapter_for('.tbl', 'iode')
+@path_adapter_for(('.at', '.tbl'), 'iode')
 class IodeTablesPathAdapter(IodeTablesAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2686,8 +2682,7 @@ def open(cls, fpath):
         return iode.tables
 
 
-@path_adapter_for('.ae', 'iode')
-@path_adapter_for('.eqs', 'iode')
+@path_adapter_for(('.ae', '.eqs'), 'iode')
 class IodeEquationsPathAdapter(IodeEquationsAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2696,8 +2691,7 @@ def open(cls, fpath):
         return iode.equations
 
 
-@path_adapter_for('.ai', 'iode')
-@path_adapter_for('.idt', 'iode')
+@path_adapter_for(('.ai', '.idt'), 'iode')
 class IodeIdentitiesPathAdapter(IodeIdentitiesAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2706,8 +2700,7 @@ def open(cls, fpath):
         return iode.identities
 
 
-@path_adapter_for('.al', 'iode')
-@path_adapter_for('.lst', 'iode')
+@path_adapter_for(('.al', '.lst'), 'iode')
 class IodeListsPathAdapter(IodeListsAdapter):
     @classmethod
     def open(cls, fpath):
@@ -2984,8 +2977,7 @@ def get_values(self, h_start, v_start, h_stop, v_stop):
             raise NotImplementedError('>2d not implemented yet')
 
 
-@path_adapter_for('.h5', 'tables')
-@path_adapter_for('.hdf', 'tables')
+@path_adapter_for(('.h5', '.hdf'), 'tables')
 class H5PathAdapter(PyTablesFileAdapter):
     @classmethod
     def open(cls, fpath):
@@ -3375,28 +3367,33 @@ def get_values(self, h_start, v_start, h_stop, v_stop):
         return [[line] for line in self._get_lines(v_start, v_stop)]
 
 
-@path_adapter_for('.bat')
-@path_adapter_for('.c')
-@path_adapter_for('.cfg')
-@path_adapter_for('.cpp')
-@path_adapter_for('.h')
-@path_adapter_for('.htm')   # web
-@path_adapter_for('.html')  # web
-@path_adapter_for('.ini')
-@path_adapter_for('.log')
-@path_adapter_for('.md')
-@path_adapter_for('.py')
-@path_adapter_for('.pyx')  # cython
-@path_adapter_for('.pxd')  # cython
-@path_adapter_for('.rep')
-@path_adapter_for('.rst')
-@path_adapter_for('.sh')
-@path_adapter_for('.sql')
-@path_adapter_for('.toml')
-@path_adapter_for('.txt')
-@path_adapter_for('.wsgi')
-@path_adapter_for('.yaml')
-@path_adapter_for('.yml')
+TEXT_FILE_SUFFIXES = (
+    '.bat',
+    '.c',
+    '.cfg',
+    '.cpp',
+    '.h',
+    '.htm',   # web
+    '.html',  # web
+    '.ini',
+    '.log',
+    '.md',
+    '.py',
+    '.pyx',  # cython
+    '.pxd',  # cython
+    '.rep',
+    '.rst',
+    '.sh',
+    '.sql',
+    '.toml',
+    '.txt',
+    '.wsgi',
+    '.yaml',
+    '.yml',
+)
+
+
+@path_adapter_for(TEXT_FILE_SUFFIXES)
 class TextPathAdapter(TextFileAdapter):
     @classmethod
     def open(cls, fpath):