BUG: updates for MPL 3.7 compatibility

[drammock]

closes #11332

So far this is just proof of concept that the new MPL RadioButtons API can do what we need it to do. Tested against this commit in this open MPL PR. The radio buttons look OK:

...but our current min version of MPL is 3.1 and MPL 3.7 isn't even out yet (probably end of January according to @tacaswell). So we should talk about how we want to handle this; presumably some combination/sequence of

• pin MPL<3.7 once it's released (in user-facing files, not just in the CI pre jobs)
• finish implementing this PR (and related changes to CheckButtons)
• remove the warning filter and CI version pin from:
  • MRG: Add support for a callable in the combine argument of TFR plots #11329
  • MAINT: Fix Circle #11497
• bump min version
• remove MPL pin from user-facing files

but I'm not sure on the timing of each step.

[tacaswell]

Pinning back won't help you because pip will just pick an older version of mne-python without the pinning.

[drammock]

Pinning back won't help you because pip will just pick an older version of mne-python without the pinning.

I think that's possible if a user already has MPL 3.7 and then pip installs mne (or requests both MPL and MNE in the same pip install line). But our default install instructions steer users to conda/mamba or a standalone executable installer that uses conda/mamba under the hood, so I think pinning in the environment.yml file it ought to work for those install routes anyway. Also in a fresh environment even the pip install route ought to pick up a pin from requirements.txt as long as they pip install mne and don't already have MPL in the env.

[drammock]

notes to self:

tutorials/preprocessing/50

Traceback (most recent call last):
  File "/home/circleci/project/tutorials/preprocessing/50_artifact_correction_ssp.py", line 183, in <module>
    fig = epochs.average().plot_topomap(times, proj='interactive')
  File "/home/circleci/project/mne/evoked.py", line 435, in plot_topomap
    return plot_evoked_topomap(
  File "/home/circleci/project/mne/viz/topomap.py", line 1826, in plot_evoked_topomap
    _draw_proj_checkbox(None, params)
  File "/home/circleci/project/mne/viz/utils.py", line 487, in _draw_proj_checkbox
    for rect in proj_checks.rectangles:
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 158, in __get__
    emit_warning()
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 193, in emit_warning
    warn_deprecated(
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 96, in warn_deprecated
    warn_external(warning, category=MatplotlibDeprecationWarning)
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/__init__.py", line 388, in warn_external
    warnings.warn(message, category, stacklevel)
matplotlib._api.deprecation.MatplotlibDeprecationWarning: The rectangles attribute was deprecated in Matplotlib 3.7 and will be removed two minor releases later. Any custom property styling may be lost.

tutorials/inverse/20

Traceback (most recent call last):
  File "/home/circleci/project/tutorials/inverse/20_dipole_fit.py", line 25, in <module>
    from nilearn.plotting import plot_anat
  File "/home/circleci/python_env/lib/python3.10/site-packages/nilearn/plotting/__init__.py", line 47, in <module>
    from . import cm
  File "/home/circleci/python_env/lib/python3.10/site-packages/nilearn/plotting/cm.py", line 226, in <module>
    _cm.register_cmap(name=k, cmap=v)
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 199, in wrapper
    emit_warning()
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 193, in emit_warning
    warn_deprecated(
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 96, in warn_deprecated
    warn_external(warning, category=MatplotlibDeprecationWarning)
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/__init__.py", line 388, in warn_external
    warnings.warn(message, category, stacklevel)
matplotlib._api.deprecation.MatplotlibDeprecationWarning: The register_cmap function was deprecated in Matplotlib 3.7 and will be removed two minor releases later. Use ``matplotlib.colormaps.register(name)`` instead.

tutorials/clinical/30

Traceback (most recent call last):
  File "/home/circleci/project/tutorials/clinical/30_ecog.py", line 150, in <module>
    rgba = cm.get_cmap("viridis")
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 199, in wrapper
    emit_warning()
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 193, in emit_warning
    warn_deprecated(
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/deprecation.py", line 96, in warn_deprecated
    warn_external(warning, category=MatplotlibDeprecationWarning)
  File "/home/circleci/python_env/lib/python3.10/site-packages/matplotlib/_api/__init__.py", line 388, in warn_external
    warnings.warn(message, category, stacklevel)
matplotlib._api.deprecation.MatplotlibDeprecationWarning: The get_cmap function was deprecated in Matplotlib 3.7 and will be removed two minor releases later. Use ``matplotlib.colormaps[name]`` or ``matplotlib.colormaps.get_cmap(obj)`` instead.

[larsoner]

@drammock usually I think we fix in main + backport to latest release (patch version numbers are easy enough to push out). If we can do it without it taking too much time I'd rather do that instead of all the pinning work.

[cbrnr]

Shouldn't we drop a hotfix release (v1.3.1) and pin Matplotlib < 3.7? The annotation window is currently broken.

[larsoner]

To me it's a matter of timing, if we can fix this in a day or two we should do it, backport, and release. If we can't, then we should go through the pinning stuff

[cbrnr]

Agreed. @drammock do you think this is doable within a day or two? Let me know if I can help.

[drammock]

I am off most of this week due to moving house. I can prioritize it for next Tuesday at the earliest.

…

-------- Original Message --------

On Feb 22, 2023, 10:02, Clemens Brunner wrote: Agreed. ***@***.***(https://github.com/drammock) do you think this is doable within a day or two? Let me know if I can help. — Reply to this email directly, [view it on GitHub](#11409 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AAN2AU33CVD6PGWR3O25N2DWYY2AHANCNFSM6AAAAAATTP6BCI). You are receiving this because you were mentioned.Message ID: ***@***.***>

[larsoner]

That timeline is okay with me

[larsoner]

Okay with my latest commit I get:

Code

import mne
raw = mne.io.read_raw_fif(mne.datasets.sample.data_path() / 'MEG' / 'sample' / 'sample_audvis_raw.fif')
raw.set_annotations(mne.Annotations([1], [2], ['test']))
with mne.viz.use_browser_backend('matplotlib'):
    raw.plot()
# Then do some manual clicking to make a new category + annotation

3.7	3.6

The spacing and stuff is perhaps not ideal and I had to use a private matplotlib object (argh) but it seems to work. @cbrnr can you try it? If so we can merge, backport, and cut a patch release

[tacaswell]

Can you open an issue that you need a way to get the colors as well? We only added API to set the colors assuming you were keeping track of that state someplace else anyway.

[larsoner]

Can you open an issue that you need a way to get the colors as well? We only added API to set the colors assuming you were keeping track of that state someplace else anyway.

Actually it looks like we are already doing that, so I can just use our internal list of colors!

[cbrnr]

@larsoner it's not quite there, I noticed two issues:

1. There are tick labels when there are no annotations:
   
   Also, the "show/hide" label should also be hidden in this case.
2. The left border of the checkboxes are missing:
   

Other issues that are not that urgent (so could be fixed later):

3. As you mentioned, the spacing is not ideal. It would be nice to make it look like the old version (e.g. radiobuttons should be left-aligned, the "show/hide" label should align with the checkboxes, etc.).
4. When entering a label which already exists, a gray bar on top appears with no text. I'm not sure if this was different in the old version. I expected a text like "Duplicate label" appear.

[larsoner]

I will probably just fix (1) here, leaving aesthetics (including 2) for later

[cbrnr]

Don't forget to turn on all tests that are expected to fail with MPL 3.7.

[larsoner]

Okay I think I fixed at least some of the bugs above, the bugs for CircleCI builds (I touched the failing examples here) and tested again on 3.7 and 3.6. I'll mark for merge when green and backport once it goes in!

[cbrnr]

Thanks a bunch @larsoner!