Merge pull request #101 from templateflow/enh/access-to-pybids-goodies

ENH: Allow access to PyBIDS' magic ``get_*``

Author: oesteban

templateflow/api.py

@@ -1,7 +1,8 @@
 """TemplateFlow's Python Client."""
+import sys
+from importlib import import_module
 from json import loads
 from pathlib import Path
-import sys
 from bids.layout import Query
 
 from .conf import TF_LAYOUT, TF_S3_ROOT, TF_USE_DATALAD, requires_layout
@@ -249,6 +250,16 @@ def get_citations(template, bibtex=False):
     return [_to_bibtex(ref, template, idx).rstrip() for idx, ref in enumerate(refs, 1)]
 
 
+@requires_layout
+def __getattr__(key: str):
+    key = key.replace("ls_", "get_")
+    if key.startswith("get_") and key not in ("get_metadata", "get_citations"):
+        return TF_LAYOUT.__getattr__(key)
+
+    # Spit out default message if we get this far
+    raise AttributeError(f"module '{__name__}' has no attribute '{key}'")
+
+
 def _datalad_get(filepath):
     if not filepath:
         return

templateflow/tests/test_api.py

@@ -97,3 +97,14 @@ def test_citations(tmp_path, template, urls, fbib, lbib):
     else:
         # no citations currently
         assert False
+
+
+def test_pybids_magic_get():
+    """Check automatic entity expansion of the layout."""
+    assert sorted(api.ls_atlases()) == sorted(api.TF_LAYOUT.get_atlases())
+    assert sorted(api.ls_atlases(template="MNI152NLin6ASym")) == sorted(
+        api.TF_LAYOUT.get_atlases(template="MNI152NLin6ASym")
+    )
+
+    with pytest.raises(TypeError):
+        api.ls_atlases("MNI152NLin6ASym")