WIP Rework mne bids path match

[waldie11]

PR Description

The workflow of using pathlib.Path.rglob and subsequently filtering i.e. by each path starting with root/sub-* is rather non-performant, especially on polluted storage trees.

For starters, by using glob.glob recursively directly, it is possible to apply this filter equivalent immediately.

In an extension, I am suggesting to introduce the option of include_match to get_entity_vals.

Open to suggestions, or stripping this down.

Remark: I failed to join the CI as my email adress is considered work mail for some reason by MS.

Merge checklist

Maintainer, please confirm the following before merging.
If applicable:

• All comments are resolved
• This is not your own PR
• All CIs are happy
• PR title starts with [MRG]
• whats_new.rst is updated
• New contributors have been added to CITATION.cff
• PR description includes phrase "closes <#issue-number>"

[welcome]

Hello! 👋 Thanks for opening your first pull request here!
Please read the contributor guide, and please follow the steps outlined in the "Instructions for first-time contributors" section therein. ❤️ We will try to get back to you soon. 🚴🏽‍♂️

[hoechenberger]

it's part of the standard library and doesn't need to be listed here

[waldie11]

thx, this comes up though 🤔

/home/circleci/project/mne_bids/path.py:docstring of mne_bids.BIDSPath.root:1: WARNING: py:class reference target not found: pathlib._local.Path [ref.class]

[drammock]

See #1358 (comment) . #1353 includes a work around for this but hasn't been merged yet

[codecov]

Codecov Report

Attention: Patch coverage is 75.00000% with 5 lines in your changes missing coverage. Please review.

Project coverage is 97.37%. Comparing base (8334fc6) to head (0d4eba5).

Files with missing lines	Patch %	Lines
mne_bids/path.py	75.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1355      +/-   ##
==========================================
- Coverage   97.40%   97.37%   -0.04%     
==========================================
  Files          40       40              
  Lines        8915     8924       +9     
==========================================
+ Hits         8684     8690       +6     
- Misses        231      234       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sappelhoff]

thanks @waldie11! we have a bit of a backlog right now so please don't worry if we take a bit longer to get back to you.

[waldie11]

@sappelhoff happy new year!
no worries, as i had seen some of the api changes in python-mne bringing down the test suite, i already expected priorities to be elsewhere.