add 'self' option to _get_layouts_in_scope

Author: tyarkoni

bids/layout/layout.py

@@ -364,6 +364,9 @@ def _in_scope(self, scope):
     def _get_layouts_in_scope(self, scope):
         ''' Return all layouts in the passed scope. '''
 
+        if scope == 'self':
+            return [self]
+
         def collect_layouts(layout):
             ''' Recursively build a list of layouts '''
             children = list(layout.derivatives.values())
@@ -623,6 +626,7 @@ def get(self, return_type='object', target=None, scope='all',
                     'all' (default): search all available directories.
                     'derivatives': search all derivatives directories
                     'raw': search only BIDS-Raw directories
+                    'self': search only the directly called BIDSLayout
                     <PipelineName>: the name of a BIDS-Derivatives pipeline
             regex_search (bool or None): Whether to require exact matching
                 (False) or regex search (True) when comparing the query string
@@ -844,8 +848,9 @@ def get_metadata(self, path, include_entities=False, scope='all'):
                 from the filename (rather than JSON sidecars) are included in
                 the returned metadata dictionary.
             scope (str, list): The scope of the search space. Each element must
-                be one of 'all', 'raw', 'derivatives', or a BIDS-Derivatives
-                pipeline name. Defaults to searching all available datasets.
+                be one of 'all', 'raw', 'self', 'derivatives', or a
+                BIDS-Derivatives pipeline name. Defaults to searching all
+                available datasets.
 
         Returns: A dictionary of key/value pairs extracted from all of the
             target file's associated JSON sidecars.
@@ -872,7 +877,6 @@ def get_metadata(self, path, include_entities=False, scope='all'):
 
         return {}
 
-
     def get_nearest(self, path, return_type='filename', strict=True,
                     all_=False, ignore_strict_entities='extension',
                     full_search=False, **filters):

bids/layout/tests/test_layout.py

@@ -490,6 +490,9 @@ def test_get_layouts_in_scope(layout_ds005_multi_derivs):
     assert len(l._get_layouts_in_scope(['events', 'dummy'])) == 2
     assert len(l._get_layouts_in_scope(['derivatives'])) == 2
     assert len(l._get_layouts_in_scope('raw')) == 1
+    self_scope = l._get_layouts_in_scope('self')
+    assert len(self_scope) == 1
+    assert self_scope == [l]
 
 
 def test_indexed_file_associations(layout_7t_trt):