CLI: Add debug argument

Author: effigies

fmriprep/cli/parser.py

@@ -533,9 +533,16 @@ def _bids_filter(value):
         "improve FMRIPREP and provides an indicator of real "
         "world usage crucial for obtaining funding.",
     )
+    g_other.add_argument(
+        "--debug",
+        action="store",
+        nargs="+",
+        choices=config.DEBUG_MODES + ("all",),
+        help="Debug mode(s) to enable. 'all' is alias for all available modes.",
+    )
+
     g_other.add_argument(
         "--sloppy",
-        dest="debug",
         action="store_true",
         default=False,
         help="Use low-quality tools for speed - TESTING ONLY",

fmriprep/config.py

@@ -187,6 +187,11 @@
     pass
 
 
+# Debug modes are names that influence the exposure of internal details to
+# the user, either through additional derivatives or increased verbosity
+DEBUG_MODES = ("compcor",)
+
+
 class _Config:
     """An abstract class forbidding instantiation."""
 
@@ -359,8 +364,10 @@ class execution(_Config):
     """A dictionary of BIDS selection filters."""
     boilerplate_only = False
     """Only generate a boilerplate."""
-    debug = False
+    sloppy = False
     """Run in sloppy mode (meaning, suboptimal parameters that minimize run-time)."""
+    debug = []
+    """Debug mode(s)."""
     echo_idx = None
     """Select a particular echo for multi-echo EPI datasets."""
     fs_license_file = _fs_license
@@ -456,6 +463,9 @@ def init(cls):
                     for k, v in filters.items()
                 }
 
+        if "all" in cls.debug:
+            cls.debug = list(DEBUG_MODES)
+
 
 # These variables are not necessary anymore
 del _fs_license