Merge pull request #9 from boutproject/black

Black

Author: dschwoerer

.github/workflows/black-fix.yml

@@ -0,0 +1,35 @@
+name: black
+
+on: push
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+
+    - name: Installing black
+      run: |
+        sudo apt update -y
+        sudo apt -y install python3-pip python3-setuptools python3-wheel
+        pip3 install black[jupyter]
+
+    - name: Version
+      run: |
+        python3 --version
+        $HOME/.local/bin/black --version
+
+    - name: Run black
+      run: |
+        $HOME/.local/bin/black . $(grep '^#!.*/bin/.*python.*$' . -Ir|cut -d: -f1)
+
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: "Apply black changes"

.github/workflows/python_publish.yml

@@ -0,0 +1,27 @@
+name: Upload Python Package
+
+on:
+  # Only run when a release is created
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitignore

@@ -98,3 +98,9 @@ ENV/
 
 # vscode reST doc preview
 _build
+/animatplot/_version.py
+
+# temporary files
+*~
+\#*
+.\#*

animatplot/_version.py

@@ -29,6 +29,7 @@ class Animation:
     animation
         a matplotlib animation returned from FuncAnimation
     """
+
     def __init__(self, blocks, timeline=None, fig=None):
         self.fig = plt.gcf() if fig is None else fig
 
@@ -45,8 +46,9 @@ def _animate(self, blocks, timeline):
         _len_time = len(self.timeline)
         for block in blocks:
             if len(block) != _len_time:
-                raise ValueError("All blocks must animate for the same amount "
-                                 "of time")
+                raise ValueError(
+                    "All blocks must animate for the same amount " "of time"
+                )
 
         self.blocks = blocks
         self._has_slider = False
@@ -62,21 +64,25 @@ def update_all(i):
             self.timeline._update()
             return updates
 
-        return FuncAnimation(self.fig, update_all, frames=self.timeline._len,
-                             interval=1000 / self.timeline.fps)
+        return FuncAnimation(
+            self.fig,
+            update_all,
+            frames=self.timeline._len,
+            interval=1000 / self.timeline.fps,
+        )
 
     @property
     def _controls_gridspec(self):
         if self._controls_gridspec_object is None:
             # make the bottom of the subplots grid lower to fit the controls in
-            adjust_plot = {'bottom': 0.03}
+            adjust_plot = {"bottom": 0.03}
             plt.subplots_adjust(**adjust_plot)
 
             controls_height = 0.2
 
             fig_gridspecs = self.fig._gridspecs
             if len(fig_gridspecs) > 1:
-                raise ValueError('multiple gridspecs found in figure')
+                raise ValueError("multiple gridspecs found in figure")
             gs = fig_gridspecs[0]
             nrows, ncols = gs.get_geometry()
             height_ratios = gs.get_height_ratios()
@@ -85,17 +91,17 @@ def _controls_gridspec(self):
             if height_ratios is None:
                 # if height_ratios is None, all rows on the original gridspec
                 # are the same height
-                height_ratios = [(1.-controls_height)/nrows
-                                 for i in range(nrows)]
+                height_ratios = [(1.0 - controls_height) / nrows for i in range(nrows)]
             else:
-                height_ratios = [r*(1.-controls_height) for r in height_ratios]
+                height_ratios = [r * (1.0 - controls_height) for r in height_ratios]
             height_ratios.append(controls_height)
             gs._nrows += 1
             gs.set_height_ratios(height_ratios)
 
             # make a sub-grid in the bottom row
             self._controls_gridspec_object = gs[-1, :].subgridspec(
-                    1,3, width_ratios=[.07, .65, .28], wspace=0., hspace=0.)
+                1, 3, width_ratios=[0.07, 0.65, 0.28], wspace=0.0, hspace=0.0
+            )
             gs.update()
 
         return self._controls_gridspec_object
@@ -112,17 +118,24 @@ def toggle(self, ax=None):
             try:
                 button_subplotspec = self._controls_gridspec[0, 2]
                 button_gridspec = button_subplotspec.subgridspec(
-                        3, 3, width_ratios=[0.45, 0.45, 0.1],
-                        height_ratios=[.05, .5, .45], wspace=0., hspace=0.)
-                self.button_ax = self.fig.add_subplot(button_gridspec[1,1])
+                    3,
+                    3,
+                    width_ratios=[0.45, 0.45, 0.1],
+                    height_ratios=[0.05, 0.5, 0.45],
+                    wspace=0.0,
+                    hspace=0.0,
+                )
+                self.button_ax = self.fig.add_subplot(button_gridspec[1, 1])
             except:
                 # editing the gridspec did not work for some reason, fall back to
                 # subplots_adjust
-                print('warning: adding play/pause button to gridspec failed, '
-                      'adding in independent axes. tight_layout() will ignore '
-                      'the button.')
-                adjust_plot = {'bottom': .2}
-                left, bottom, width, height = (.78, .03, .1, .07)
+                print(
+                    "warning: adding play/pause button to gridspec failed, "
+                    "adding in independent axes. tight_layout() will ignore "
+                    "the button."
+                )
+                adjust_plot = {"bottom": 0.2}
+                left, bottom, width, height = (0.78, 0.03, 0.1, 0.07)
                 rect = (left, bottom, width, height)
 
                 plt.subplots_adjust(**adjust_plot)
@@ -132,10 +145,12 @@ def toggle(self, ax=None):
 
         self.button = Button(self.button_ax, "Pause")
         self.button.label2 = self.button_ax.text(
-            x=0.5, y=0.5, s='Play',
-            verticalalignment='center',
-            horizontalalignment='center',
-            transform=self.button_ax.transAxes
+            x=0.5,
+            y=0.5,
+            s="Play",
+            verticalalignment="center",
+            horizontalalignment="center",
+            transform=self.button_ax.transAxes,
         )
         self.button.label2.set_visible(False)
 
@@ -150,9 +165,10 @@ def pause(event):
                 self.button.label2.set_visible(True)
             self.fig.canvas.draw()
             self._pause ^= True
+
         self.button.on_clicked(pause)
 
-    def timeline_slider(self, text='Time', ax=None, valfmt=None, color=None):
+    def timeline_slider(self, text="Time", ax=None, valfmt=None, color=None):
         """Creates a timeline slider.
 
         Parameters
@@ -171,30 +187,33 @@ def timeline_slider(self, text='Time', ax=None, valfmt=None, color=None):
             try:
                 slider_subplotspec = self._controls_gridspec[0, 1]
                 slider_gridspec = slider_subplotspec.subgridspec(
-                        3, 1, height_ratios=[.2, .2, .6], wspace=0.,
-                        hspace=0.)
+                    3, 1, height_ratios=[0.2, 0.2, 0.6], wspace=0.0, hspace=0.0
+                )
                 self.slider_ax = self.fig.add_subplot(slider_gridspec[1, 0])
             except:
                 # editing the gridspec did not work for some reason, fall back to
                 # subplots_adjust
-                print('warning: adding timeline slider to gridspec failed, '
-                      'adding in independent axes. tight_layout() will ignore '
-                      'the slider.')
-                adjust_plot = {'bottom': .2}
-                rect = [.18, .05, .5, .03]
+                print(
+                    "warning: adding timeline slider to gridspec failed, "
+                    "adding in independent axes. tight_layout() will ignore "
+                    "the slider."
+                )
+                adjust_plot = {"bottom": 0.2}
+                rect = [0.18, 0.05, 0.5, 0.03]
                 plt.subplots_adjust(**adjust_plot)
                 self.slider_ax = plt.axes(rect)
         else:
             self.slider_ax = ax
 
         if valfmt is None:
-            if (np.issubdtype(self.timeline.t.dtype, np.datetime64)
-               or np.issubdtype(self.timeline.t.dtype, np.timedelta64)):
-                valfmt = '%s'
+            if np.issubdtype(self.timeline.t.dtype, np.datetime64) or np.issubdtype(
+                self.timeline.t.dtype, np.timedelta64
+            ):
+                valfmt = "%s"
             else:
-                valfmt = '%1.2f'
+                valfmt = "%1.2f"
         if self.timeline.log:
-            valfmt = '$10^{%s}$' % valfmt
+            valfmt = "$10^{%s}$" % valfmt
 
         if ax is None:
             # Try to intelligently decide slider width to avoid overlap
@@ -208,16 +227,18 @@ def text_width(txt):
                 extents = self.fig.transFigure.inverted().transform(bbox)
                 return extents[1][0] - extents[0][0]
 
-            text_val_width = max(text_width(valfmt % (self.timeline[i]))
-                                 for i in range(len(self.timeline)))
+            text_val_width = max(
+                text_width(valfmt % (self.timeline[i]))
+                for i in range(len(self.timeline))
+            )
             label_width = text_width(text)
 
             # Calculate width of slider
             default_button_width = 0.1
             width = 0.73 - text_val_width - label_width - default_button_width
 
-            adjust_plot = {'bottom': .2}
-            left, bottom, height = (.18, .05, .03)
+            adjust_plot = {"bottom": 0.2}
+            left, bottom, height = (0.18, 0.05, 0.03)
             rect = (left, bottom, width, height)
 
             plt.subplots_adjust(**adjust_plot)
@@ -226,18 +247,23 @@ def text_width(txt):
             self.slider_ax = ax
 
         self.slider = Slider(
-            self.slider_ax, label=text, valmin=0, valmax=self.timeline._len-1,
+            self.slider_ax,
+            label=text,
+            valmin=0,
+            valmax=self.timeline._len - 1,
             valinit=0,
-            valfmt=(valfmt+self.timeline.units),
-            valstep=1, color=color
+            valfmt=(valfmt + self.timeline.units),
+            valstep=1,
+            color=color,
         )
         self._has_slider = True
 
         def set_time(new_slider_val):
             # Update slider value and text on each step
             self.timeline.index = int(new_slider_val)
             self.slider.valtext.set_text(
-                self.slider.valfmt % (self.timeline[self.timeline.index]))
+                self.slider.valfmt % (self.timeline[self.timeline.index])
+            )
 
             if self._pause:
                 for block in self.blocks:
@@ -273,8 +299,9 @@ def save_gif(self, filename):
             the name of the file to be created without the file extension
         """
         self.timeline.index -= 1  # required for proper starting point for save
-        self.animation.save(filename+'.gif',
-                            writer=PillowWriter(fps=self.timeline.fps))
+        self.animation.save(
+            filename + ".gif", writer=PillowWriter(fps=self.timeline.fps)
+        )
 
     def save(self, *args, **kwargs):
         """Saves an animation
@@ -312,9 +339,11 @@ def add(self, new):
 
         for i, block in enumerate(new_blocks):
             if not isinstance(block, Block):
-                raise TypeError(f"Block number {i} passed is of type "
-                                f"{type(block)}, not of type "
-                                f"animatplot.blocks.Block (or a subclass)")
+                raise TypeError(
+                    f"Block number {i} passed is of type "
+                    f"{type(block)}, not of type "
+                    f"animatplot.blocks.Block (or a subclass)"
+                )
 
             self.blocks.append(block)
 

animatplot/animation.py

@@ -4,8 +4,9 @@
 import numpy as np
 
 
-def vector_plot(X, Y, U, V, t, skip=5, *, t_axis=0, units='', fps=10,
-                pcolor_kw={}, quiver_kw={}):
+def vector_plot(
+    X, Y, U, V, t, skip=5, *, t_axis=0, units="", fps=10, pcolor_kw={}, quiver_kw={}
+):
     """produces an animation of vector fields
 
     This takes 2D vector field, and plots the magnitude as a pcolomesh, and the
@@ -56,8 +57,9 @@ def vector_plot(X, Y, U, V, t, skip=5, *, t_axis=0, units='', fps=10,
         The timeline that was generated for the animation.
     """
     # plot the magnitude of the vectors as a pcolormesh
-    blocks = vector_comp(X, Y, U, V, skip, t_axis=t_axis,
-                         pcolor_kw=pcolor_kw, quiver_kw=quiver_kw)
+    blocks = vector_comp(
+        X, Y, U, V, skip, t_axis=t_axis, pcolor_kw=pcolor_kw, quiver_kw=quiver_kw
+    )
 
     # create the animation
     timeline = Timeline(t, units=units, fps=fps)

animatplot/animations/vectors.py

@@ -17,6 +17,7 @@ class Block:
     ax : matplotlib.axes.Axes
         The matplotlib axes that the block is attached to.
     """
+
     def __init__(self, ax=None, t_axis=None):
         self.ax = ax if ax is not None else plt.gca()
         self.t_axis = t_axis
@@ -44,6 +45,6 @@ def _make_slice(self, i, dim):
         """A helper function to slice arrays or lists"""
         if self._is_list:
             return i
-        Slice = [slice(None)]*dim
+        Slice = [slice(None)] * dim
         Slice[self.t_axis] = i
         return tuple(Slice)