[ENH]: Improving DataGrabber patterns

[synchon]

Discussed in #307

^{Originally posted by synchon February 26, 2024}
With the introduction of template space definitions in #252 and #268, the use of PatternDataladDataGrabber via YAML is broken as of 9316bca due to space awareness. The space key is added in get_item method of the DataGrabber and not defined in the constructor. The space key is important for every other component downstream and not having that breaks the pipeline. The solution I propose is not backwards compatible as it re-defines the structure of the patterns parameter, but in my opinion the cleanest and leanest way:

Old:

Python:

patterns = {
    "BOLD": "...",
    "T1w": "...",
}

YAML:

patterns:
  BOLD: "..."
  T1w: "..."

New:

Python:

patterns = {
    "BOLD": {
        "pattern": "...",
        "space": "...",
    },
    "T1w": {
        "pattern": "...",
        "space": "...",
    },
}

YAML:

patterns:
  BOLD:
    pattern: "..."
    space: "..."
  T1w:
    pattern: "..."
    space: "..."

I'm happy to discuss alternatives and adapt my solution.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (407d189) to head (3e89413).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #308   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            1         1           
=========================================
  Hits             1         1           

Flag	Coverage Δ
docs	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[github-actions]

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-04-04 14:01 UTC

[LeSasse]

LGTM