Enable ruff

Author: Carreau

.github/workflows/main.yml

@@ -48,3 +48,12 @@ jobs:
 
     - name: Test flake8
       run: flake8 matplotlib_inline --ignore=E501,W504,W503
+
+    - name: Install ruff
+      run: mamba install ruff
+
+    - name: Check code with ruff
+      run: ruff check matplotlib_inline
+
+    - name: Check formatting with ruff
+      run: ruff format matplotlib_inline --check

matplotlib_inline/backend_inline.py

@@ -43,10 +43,11 @@ def new_figure_manager_given_figure(num, figure):
     # https://github.com/ipython/ipython/issues/1612
     # https://github.com/matplotlib/matplotlib/issues/835
 
-    if not hasattr(figure, 'show'):
+    if not hasattr(figure, "show"):
         # Queue up `figure` for display
         figure.show = lambda *a: display(
-            figure, metadata=_fetch_figure_metadata(figure))
+            figure, metadata=_fetch_figure_metadata(figure)
+        )
 
     # If matplotlib was manually set to non-interactive mode, this function
     # should be a no-op (otherwise we'll generate duplicate plots, since a user
@@ -89,14 +90,14 @@ def show(close=None, block=None):
         for figure_manager in Gcf.get_all_fig_managers():
             display(
                 figure_manager.canvas.figure,
-                metadata=_fetch_figure_metadata(figure_manager.canvas.figure)
+                metadata=_fetch_figure_metadata(figure_manager.canvas.figure),
             )
     finally:
         show._to_draw = []
         # only call close('all') if any to close
         # close triggers gc.collect, which can be slow
         if close and Gcf.get_all_fig_managers():
-            matplotlib.pyplot.close('all')
+            matplotlib.pyplot.close("all")
 
 
 # This flag will be reset by draw_if_interactive when called
@@ -176,8 +177,8 @@ def configure_inline_support(shell, backend):
     if cfg not in shell.configurables:
         shell.configurables.append(cfg)
 
-    if backend in ('inline', 'module://matplotlib_inline.backend_inline'):
-        shell.events.register('post_execute', flush_figures)
+    if backend in ("inline", "module://matplotlib_inline.backend_inline"):
+        shell.events.register("post_execute", flush_figures)
 
         # Save rcParams that will be overwrittern
         shell._saved_rcParams = {}
@@ -188,10 +189,10 @@ def configure_inline_support(shell, backend):
         new_backend_name = "inline"
     else:
         try:
-            shell.events.unregister('post_execute', flush_figures)
+            shell.events.unregister("post_execute", flush_figures)
         except ValueError:
             pass
-        if hasattr(shell, '_saved_rcParams'):
+        if hasattr(shell, "_saved_rcParams"):
             matplotlib.rcParams.update(shell._saved_rcParams)
             del shell._saved_rcParams
         new_backend_name = "other"
@@ -211,13 +212,15 @@ def _enable_matplotlib_integration():
     ip = get_ipython()
 
     import matplotlib
+
     if matplotlib.__version_info__ >= (3, 10):
         backend = matplotlib.get_backend(auto_select=False)
     else:
         backend = matplotlib.rcParams._get("backend")
 
-    if ip and backend in ('inline', 'module://matplotlib_inline.backend_inline'):
+    if ip and backend in ("inline", "module://matplotlib_inline.backend_inline"):
         from IPython.core.pylabtools import activate_matplotlib
+
         try:
             activate_matplotlib(backend)
             configure_inline_support(ip, backend)
@@ -226,8 +229,9 @@ def _enable_matplotlib_integration():
             def configure_once(*args):
                 activate_matplotlib(backend)
                 configure_inline_support(ip, backend)
-                ip.events.unregister('post_run_cell', configure_once)
-            ip.events.register('post_run_cell', configure_once)
+                ip.events.unregister("post_run_cell", configure_once)
+
+            ip.events.register("post_run_cell", configure_once)
 
 
 _enable_matplotlib_integration()
@@ -238,13 +242,17 @@ def _fetch_figure_metadata(fig):
     # determine if a background is needed for legibility
     if _is_transparent(fig.get_facecolor()):
         # the background is transparent
-        ticksLight = _is_light([label.get_color()
-                                for axes in fig.axes
-                                for axis in (axes.xaxis, axes.yaxis)
-                                for label in axis.get_ticklabels()])
+        ticksLight = _is_light(
+            [
+                label.get_color()
+                for axes in fig.axes
+                for axis in (axes.xaxis, axes.yaxis)
+                for label in axis.get_ticklabels()
+            ]
+        )
         if ticksLight.size and (ticksLight == ticksLight[0]).all():
             # there are one or more tick labels, all with the same lightness
-            return {'needs_background': 'dark' if ticksLight[0] else 'light'}
+            return {"needs_background": "dark" if ticksLight[0] else "light"}
 
     return None
 
@@ -254,13 +262,13 @@ def _is_light(color):
     opposed to dark). Based on ITU BT.601 luminance formula (see
     https://stackoverflow.com/a/596241)."""
     rgbaArr = colors.to_rgba_array(color)
-    return rgbaArr[:, :3].dot((.299, .587, .114)) > .5
+    return rgbaArr[:, :3].dot((0.299, 0.587, 0.114)) > 0.5
 
 
 def _is_transparent(color):
     """Determine transparency from alpha."""
     rgba = colors.to_rgba(color)
-    return rgba[3] < .5
+    return rgba[3] < 0.5
 
 
 def set_matplotlib_formats(*formats, **kwargs):

matplotlib_inline/config.py

@@ -7,9 +7,7 @@
 # Distributed under the terms of the BSD 3-Clause License.
 
 from traitlets.config.configurable import SingletonConfigurable
-from traitlets import (
-    Dict, Instance, Set, Bool, TraitError, Unicode
-)
+from traitlets import Dict, Instance, Set, Bool, TraitError, Unicode
 
 
 # Configurable for inline backend options
@@ -18,6 +16,7 @@ def pil_available():
     out = False
     try:
         from PIL import Image  # noqa
+
         out = True
     except ImportError:
         pass
@@ -44,37 +43,44 @@ class InlineBackend(InlineBackendConfig):
         the box, but third-party tools may use it to manage rc data. To change
         personal defaults for matplotlib,  use matplotlib's configuration
         tools, or customize this class in your `ipython_config.py` file for
-        IPython/Jupyter-specific usage.""").tag(config=True)
+        IPython/Jupyter-specific usage.""",
+    ).tag(config=True)
 
     figure_formats = Set(
-        {'png'},
+        {"png"},
         help="""A set of figure formats to enable: 'png',
-                'retina', 'jpeg', 'svg', 'pdf'.""").tag(config=True)
+                'retina', 'jpeg', 'svg', 'pdf'.""",
+    ).tag(config=True)
 
     def _update_figure_formatters(self):
         if self.shell is not None:
             from IPython.core.pylabtools import select_figure_formats
-            select_figure_formats(self.shell, self.figure_formats, **self.print_figure_kwargs)
+
+            select_figure_formats(
+                self.shell, self.figure_formats, **self.print_figure_kwargs
+            )
 
     def _figure_formats_changed(self, name, old, new):
-        if 'jpg' in new or 'jpeg' in new:
+        if "jpg" in new or "jpeg" in new:
             if not pil_available():
                 raise TraitError("Requires PIL/Pillow for JPG figures")
         self._update_figure_formatters()
 
-    figure_format = Unicode(help="""The figure format to enable (deprecated
-                                         use `figure_formats` instead)""").tag(config=True)
+    figure_format = Unicode(
+        help="""The figure format to enable (deprecated
+                                         use `figure_formats` instead)"""
+    ).tag(config=True)
 
     def _figure_format_changed(self, name, old, new):
         if new:
             self.figure_formats = {new}
 
     print_figure_kwargs = Dict(
-        {'bbox_inches': 'tight'},
+        {"bbox_inches": "tight"},
         help="""Extra kwargs to be passed to fig.canvas.print_figure.
 
         Logical examples include: bbox_inches, quality (for jpeg figures), etc.
-        """
+        """,
     ).tag(config=True)
     _print_figure_kwargs_changed = _update_figure_formatters
 
@@ -94,7 +100,9 @@ def _figure_format_changed(self, name, old, new):
         iterative editing of figures, and behaves most consistently with
         other matplotlib backends, but figure barriers between cells must
         be explicit.
-        """).tag(config=True)
+        """,
+    ).tag(config=True)
 
-    shell = Instance('IPython.core.interactiveshell.InteractiveShellABC',
-                     allow_none=True)
+    shell = Instance(
+        "IPython.core.interactiveshell.InteractiveShellABC", allow_none=True
+    )

tests/notebooks/mpl_inline.ipynb

@@ -56,6 +56,7 @@
     "\n",
     "# Remove text to avoid tiny differences in rendered output.\n",
     "from matplotlib.testing.decorators import remove_ticks_and_titles\n",
+    "\n",
     "remove_ticks_and_titles(fig)"
    ]
   },

tests/test_import.py

@@ -1,3 +1,4 @@
 def test_import():
     from matplotlib_inline.backend_inline import show
+
     show()