Improve figure size and show argument in viz functions

pycrostates/_typing.py

@@ -11,25 +11,25 @@
 from numpy.typing import NDArray
 
 
-class CHData(ABC):
+class CHData(ABC):  # noqa: B024
     """Typing for CHData."""
 
     pass
 
 
-class CHInfo(ABC):
+class CHInfo(ABC):  # noqa: B024
     """Typing for CHInfo."""
 
     pass
 
 
-class Cluster(ABC):
+class Cluster(ABC):  # noqa: B024
     """Typing for a clustering class."""
 
     pass
 
 
-class Segmentation(ABC):
+class Segmentation(ABC):  # noqa: B024
     """Typing for a clustering class."""
 
     pass

pycrostates/cluster/_base.py

@@ -518,13 +518,14 @@ def plot(
         self,
         axes: Optional[Union[Axes, NDArray[Axes]]] = None,
         show_gradient: Optional[bool] = False,
-        gradient_kwargs: dict[str, Any] = {
+        gradient_kwargs: dict[str, Any] = {  # noqa: B006
             "color": "black",
             "linestyle": "-",
             "marker": "P",
         },
         *,
         block: bool = False,
+        show: Optional[bool] = None,
         verbose: Optional[str] = None,
         **kwargs,
     ):
@@ -541,6 +542,7 @@ def plot(
             Additional keyword arguments passed to :meth:`matplotlib.axes.Axes.plot` to
             plot gradient line.
         %(block)s
+        %(show)s
         %(verbose)s
         **kwargs
             Additional keyword arguments are passed to :func:`mne.viz.plot_topomap`.
@@ -561,6 +563,7 @@ def plot(
             show_gradient=show_gradient,
             gradient_kwargs=gradient_kwargs,
             block=block,
+            show=show,
             verbose=verbose,
             **kwargs,
         )

pycrostates/cluster/_base.pyi

@@ -199,6 +199,7 @@ class _BaseCluster(Cluster, ChannelsMixin, ContainsMixin, MontageMixin):
         },
         *,
         block: bool = False,
+        show: Optional[bool] = None,
         verbose: Optional[str] = None,
         **kwargs,
     ):
@@ -219,6 +220,9 @@ class _BaseCluster(Cluster, ChannelsMixin, ContainsMixin, MontageMixin):
             plot gradient line.
         block : bool
             Whether to halt program execution until the figure is closed.
+        show : bool | None
+            If True, the figure is shown. If None, the figure is shown if the matplotlib backend
+            is interactive.
         verbose : int | str | bool | None
             Sets the verbosity level. The verbosity increases gradually between ``"CRITICAL"``,
             ``"ERROR"``, ``"WARNING"``, ``"INFO"`` and ``"DEBUG"``. If None is provided, the

pycrostates/cluster/tests/test_aahc.py

@@ -480,15 +480,15 @@ def test_properties(caplog):
         normalize_input=False,
     )
 
-    aahCluster_.cluster_centers_  # pylint: disable=pointless-statement
+    aahCluster_.cluster_centers_  # noqa: B018
     assert "Clustering algorithm has not been fitted." in caplog.text
     caplog.clear()
 
-    aahCluster_.info  # pylint: disable=pointless-statement
+    aahCluster_.info  # noqa: B018
     assert "Clustering algorithm has not been fitted." in caplog.text
     caplog.clear()
 
-    aahCluster_.fitted_data  # pylint: disable=pointless-statement
+    aahCluster_.fitted_data  # noqa: B018
     assert "Clustering algorithm has not been fitted." in caplog.text
     caplog.clear()
 

pycrostates/cluster/tests/test_kmeans.py

@@ -392,30 +392,30 @@ def test_properties(caplog):
         random_state=1,
     )
 
-    ModK_.cluster_centers_  # pylint: disable=pointless-statement
+    ModK_.cluster_centers_  # noqa: B018
     assert "Clustering algorithm has not been fitted." in caplog.text
     caplog.clear()
 
-    ModK_.info  # pylint: disable=pointless-statement
+    ModK_.info  # noqa: B018
     assert "Clustering algorithm has not been fitted." in caplog.text
     caplog.clear()
 
-    ModK_.fitted_data  # pylint: disable=pointless-statement
+    ModK_.fitted_data  # noqa: B018
     assert "Clustering algorithm has not been fitted." in caplog.text
     caplog.clear()
 
     # Fitted
     ModK_ = ModK.copy()
 
-    ModK_.cluster_centers_
+    ModK_.cluster_centers_  # noqa: B018
     assert "Clustering algorithm has not been fitted." not in caplog.text
     caplog.clear()
 
-    ModK_.info
+    ModK_.info  # noqa: B018
     assert "Clustering algorithm has not been fitted." not in caplog.text
     caplog.clear()
 
-    ModK_.fitted_data
+    ModK_.fitted_data  # noqa: B018
     assert "Clustering algorithm has not been fitted." not in caplog.text
     caplog.clear()
 
@@ -1100,15 +1100,15 @@ def test_contains_mixin():
     with pytest.raises(
         ValueError, match="Instance 'ModKMeans' attribute 'info' is None."
     ):
-        "eeg" in ModK_
+        "eeg" in ModK_  # noqa: B015
     with pytest.raises(
         ValueError, match="Instance 'ModKMeans' attribute 'info' is None."
     ):
         ModK_.get_channel_types()
     with pytest.raises(
         ValueError, match="Instance 'ModKMeans' attribute 'info' is None."
     ):
-        ModK_.compensation_grade
+        ModK_.compensation_grade  # noqa: B018
 
 
 def test_montage_mixin():

pycrostates/io/tests/test_meas_info.py

@@ -60,7 +60,7 @@ def test_create_from_info():
     info.set_montage("standard_1020")
     chinfo = ChInfo(info=info)
     assert chinfo["ch_names"] == ["Fp1", "Fp2", "Fpz"]
-    for k, ch in enumerate(info["chs"]):
+    for ch in info["chs"]:
         assert ch["coord_frame"] == FIFF.FIFFV_COORD_HEAD
         assert not all(np.isnan(elt) for elt in ch["loc"])
     assert chinfo["dig"] is not None
@@ -228,7 +228,7 @@ def test_montage():
     info.set_montage("standard_1020")
     chinfo = ChInfo(info=info)
     assert chinfo["ch_names"] == ["Fp1", "Fp2", "Fpz"]
-    for k, ch in enumerate(info["chs"]):
+    for ch in info["chs"]:
         assert ch["coord_frame"] == FIFF.FIFFV_COORD_HEAD
         assert not all(np.isnan(elt) for elt in ch["loc"])
     assert chinfo["dig"] is not None
@@ -261,7 +261,7 @@ def test_montage():
         elif isinstance(montage.get_positions()[key], np.ndarray):
             assert_allclose(montage.get_positions()[key], montage2.get_positions()[key])
         elif isinstance(montage.get_positions()[key], OrderedDict):
-            for k, v in montage.get_positions()[key].items():
+            for k in montage.get_positions()[key]:
                 assert_allclose(
                     montage.get_positions()[key][k],
                     montage2.get_positions()[key][k],

pycrostates/segmentation/_base.py

@@ -304,14 +304,17 @@ def entropy(
     def plot_cluster_centers(
         self,
         axes: Optional[Union[Axes, NDArray[Axes]]] = None,
+        *,
         block: bool = False,
+        show: Optional[bool] = None,
     ):
         """Plot cluster centers as topographic maps.
 
         Parameters
         ----------
         %(axes_topo)s
         %(block)s
+        %(show)s
 
         Returns
         -------
@@ -324,6 +327,7 @@ def plot_cluster_centers(
             self._cluster_names,
             axes,
             block=block,
+            show=show,
         )
 
     # --------------------------------------------------------------------

pycrostates/segmentation/_base.pyi

@@ -195,7 +195,11 @@ class _BaseSegmentation(Segmentation):
         """
 
     def plot_cluster_centers(
-        self, axes: Optional[Union[Axes, NDArray[Axes]]] = None, block: bool = False
+        self,
+        axes: Optional[Union[Axes, NDArray[Axes]]] = None,
+        *,
+        block: bool = False,
+        show: Optional[bool] = None,
     ):
         """Plot cluster centers as topographic maps.
 
@@ -207,6 +211,9 @@ class _BaseSegmentation(Segmentation):
             ``≥ 1``, an array of axes of size ``n_clusters`` should be provided.
         block : bool
             Whether to halt program execution until the figure is closed.
+        show : bool | None
+            If True, the figure is shown. If None, the figure is shown if the matplotlib backend
+            is interactive.
 
         Returns
         -------

pycrostates/segmentation/segmentation.py

@@ -53,6 +53,7 @@ def plot(
         cbar_axes: Optional[Axes] = None,
         *,
         block: bool = False,
+        show: Optional[bool] = None,
         verbose: Optional[str] = None,
     ):
         """Plot the segmentation.
@@ -65,6 +66,7 @@ def plot(
         %(axes_seg)s
         %(axes_cbar)s
         %(block)s
+        %(show)s
         %(verbose)s
 
         Returns
@@ -84,6 +86,7 @@ def plot(
             axes=axes,
             cbar_axes=cbar_axes,
             block=block,
+            show=show,
             verbose=verbose,
         )
 
@@ -138,6 +141,7 @@ def plot(
         cbar_axes: Optional[Axes] = None,
         *,
         block: bool = False,
+        show: Optional[bool] = None,
         verbose=None,
     ):
         """Plot segmentation.
@@ -148,6 +152,7 @@ def plot(
         %(axes_seg)s
         %(axes_cbar)s
         %(block)s
+        %(show)s
         %(verbose)s
 
         Returns
@@ -165,6 +170,7 @@ def plot(
             axes=axes,
             cbar_axes=cbar_axes,
             block=block,
+            show=show,
             verbose=verbose,
         )
 

pycrostates/segmentation/segmentation.pyi

@@ -39,6 +39,7 @@ class RawSegmentation(_BaseSegmentation):
         cbar_axes: Optional[Axes] = None,
         *,
         block: bool = False,
+        show: Optional[bool] = None,
         verbose: Optional[str] = None,
     ):
         """Plot the segmentation.
@@ -59,6 +60,9 @@ class RawSegmentation(_BaseSegmentation):
             axes.
         block : bool
             Whether to halt program execution until the figure is closed.
+        show : bool | None
+            If True, the figure is shown. If None, the figure is shown if the matplotlib backend
+            is interactive.
         verbose : int | str | bool | None
             Sets the verbosity level. The verbosity increases gradually between ``"CRITICAL"``,
             ``"ERROR"``, ``"WARNING"``, ``"INFO"`` and ``"DEBUG"``. If None is provided, the
@@ -100,6 +104,7 @@ class EpochsSegmentation(_BaseSegmentation):
         cbar_axes: Optional[Axes] = None,
         *,
         block: bool = False,
+        show: Optional[bool] = None,
         verbose: Incomplete | None = None,
     ):
         """Plot segmentation.
@@ -116,6 +121,9 @@ class EpochsSegmentation(_BaseSegmentation):
             axes.
         block : bool
             Whether to halt program execution until the figure is closed.
+        show : bool | None
+            If True, the figure is shown. If None, the figure is shown if the matplotlib backend
+            is interactive.
         verbose : int | str | bool | None
             Sets the verbosity level. The verbosity increases gradually between ``"CRITICAL"``,
             ``"ERROR"``, ``"WARNING"``, ``"INFO"`` and ``"DEBUG"``. If None is provided, the

pycrostates/utils/_checks.py

@@ -9,6 +9,7 @@
 from typing import Any
 
 import numpy as np
+from matplotlib import pyplot as plt
 from matplotlib.axes import Axes
 from mne import pick_info
 from mne.utils import check_random_state
@@ -337,3 +338,10 @@ def _check_verbose(verbose: Any) -> int:
             )
 
     return verbose
+
+
+def _ensure_valid_show(show: Any) -> bool:
+    """Check show parameter."""
+    _check_type(show, (bool, None), "show")
+    show = plt.isinteractive() if show is None else show
+    return show

pycrostates/utils/_docs.py

@@ -143,6 +143,11 @@
 segmentation : RawSegmentation | EpochsSegmentation
     Segmentation object containing the microstate symbolic sequence."""
 
+docdict["show"] = """
+show : bool | None
+    If True, the figure is shown. If None, the figure is shown if the matplotlib backend
+    is interactive."""
+
 docdict["stat_expected_transitions"] = """
 stat : str
     Aggregate statistic to compute transitions. Can be: