new black

Author: nschloe

test/helpers.py

@@ -9,8 +9,7 @@
 
 
 def print_tree(obj, indent=""):
-    """Recursively prints the tree structure of the matplotlib object.
-    """
+    """Recursively prints the tree structure of the matplotlib object."""
     if isinstance(obj, matplotlib.text.Text):
         print(indent, type(obj).__name__, f'("{obj.get_text()}")')
     else:

test/test_hatch.py

@@ -3,10 +3,10 @@
 
 def plot():
     """
-        Hatch demo code from
-        https://matplotlib.org/3.1.1/gallery/shapes_and_collections/hatch_demo.html
+    Hatch demo code from
+    https://matplotlib.org/3.1.1/gallery/shapes_and_collections/hatch_demo.html
 
-        Slightly modified to test more aspects of the hatch implementation
+    Slightly modified to test more aspects of the hatch implementation
     """
     import matplotlib.pyplot as plt
     from matplotlib.patches import Ellipse, Polygon

tikzplotlib/_axes.py

@@ -14,8 +14,7 @@ def _common_texification(string):
 
 class Axes:
     def __init__(self, data, obj):  # noqa: C901
-        """Returns the PGFPlots code for an axis environment.
-        """
+        """Returns the PGFPlots code for an axis environment."""
         self.content = []
 
         # Are we dealing with an axis that hosts a colorbar? Skip then, those are
@@ -270,14 +269,14 @@ def _ticks(self, data, obj):
                     self.axis_options.append("tick align=center")
 
         # Set each rotation for every label
-        x_tick_rotation_and_horizontal_alignment = self._get_label_rotation_and_horizontal_alignment(
-            obj, data, "x"
+        x_tick_rotation_and_horizontal_alignment = (
+            self._get_label_rotation_and_horizontal_alignment(obj, data, "x")
         )
         if x_tick_rotation_and_horizontal_alignment:
             self.axis_options.append(x_tick_rotation_and_horizontal_alignment)
 
-        y_tick_rotation_and_horizontal_alignment = self._get_label_rotation_and_horizontal_alignment(
-            obj, data, "y"
+        y_tick_rotation_and_horizontal_alignment = (
+            self._get_label_rotation_and_horizontal_alignment(obj, data, "y")
         )
         if y_tick_rotation_and_horizontal_alignment:
             self.axis_options.append(y_tick_rotation_and_horizontal_alignment)
@@ -600,8 +599,7 @@ def _get_ticks(data, xy, ticks, ticklabels):
 
 
 def _is_colorbar_heuristic(obj):
-    """Find out if the object is in fact a color bar.
-    """
+    """Find out if the object is in fact a color bar."""
     # TODO come up with something more accurate here
     # Might help:
     # TODO Are the colorbars exactly the l.collections.PolyCollection's?
@@ -781,8 +779,7 @@ def _handle_listed_color_map(cmap, data):
 
 
 def _scale_to_int(X, max_val):
-    """Scales the array X such that it contains only integers.
-    """
+    """Scales the array X such that it contains only integers."""
     # if max_val is None:
     #     X = X / _gcd_array(X)
     X = X / max(1 / max_val, _gcd_array(X))
@@ -816,8 +813,7 @@ def _gcd(a, b):
 
 
 def _linear_interpolation(x, X, Y):
-    """Given two data points [X,Y], linearly interpolate those at x.
-    """
+    """Given two data points [X,Y], linearly interpolate those at x."""
     return (Y[1] * (x - X[0]) + Y[0] * (X[1] - x)) / (X[1] - X[0])
 
 

tikzplotlib/_color.py

@@ -3,8 +3,7 @@
 
 
 def mpl_color2xcolor(data, matplotlib_color):
-    """Translates a matplotlib color specification into a proper LaTeX xcolor.
-    """
+    """Translates a matplotlib color specification into a proper LaTeX xcolor."""
     # Convert it to RGBA.
     my_col = numpy.array(mpl.colors.ColorConverter().to_rgba(matplotlib_color))
 

tikzplotlib/_hatches.py

@@ -35,27 +35,27 @@
 
 def add_custom_pattern(mpl_hatch, pattern_name, pattern_definition=None):
     """
-        The patterns of tikzpgf are quite simple, and cannot be customized but for the
-        color. A solution is to expose a function like this one to allow the user to
-        populate _MP_HATCH2PGF_PATTERN with custom (hatch, pattern) pairs. mpl does no
-        validation of the hatch string, it just ignores it if it does not recognize it,
-        so it is possible to have <any> string be a mpl_hatch.
-
-        If the pattern definition is passed, it could be added at the start of the code
-        in a similar fashion to
-        > data["custom colors"] = {}
-        in get_tikz_code(). tikzplotlib pattern definitions would mend the bad
-        correspondence between the mpl hatches and tikz patterns, with custom patterns
-        for the mpl hatches 'o' and 'O'
-
-        Want some opinions on this before I implement it..
-
-        From https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.patches.Patch.html:
-        > Letters can be combined, in which case all the specified hatchings are done.
-        > If same letter repeats, it increases the density of hatching of that pattern.
-        To achieve something like this, custom patterns must be created
-        https://tex.stackexchange.com/questions/29359/pgfplots-how-to-fill-the-area-
-        under-a-curve-with-oblique-lines-hatching-as-a/29367#29367
+    The patterns of tikzpgf are quite simple, and cannot be customized but for the
+    color. A solution is to expose a function like this one to allow the user to
+    populate _MP_HATCH2PGF_PATTERN with custom (hatch, pattern) pairs. mpl does no
+    validation of the hatch string, it just ignores it if it does not recognize it, so
+    it is possible to have <any> string be a mpl_hatch.
+
+    If the pattern definition is passed, it could be added at the start of the code in a
+    similar fashion to
+    > data["custom colors"] = {}
+    in get_tikz_code(). tikzplotlib pattern definitions would mend the bad
+    correspondence between the mpl hatches and tikz patterns, with custom patterns for
+    the mpl hatches 'o' and 'O'.
+
+    Want some opinions on this before I implement it..
+
+    From https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.patches.Patch.html:
+    > Letters can be combined, in which case all the specified hatchings are done.
+    > If same letter repeats, it increases the density of hatching of that pattern.
+    To achieve something like this, custom patterns must be created
+    https://tex.stackexchange.com/questions/29359/pgfplots-how-to-fill-the-area-
+    under-a-curve-with-oblique-lines-hatching-as-a/29367#29367
     """
 
 
@@ -80,14 +80,14 @@ def __validate_hatch(hatch):
 
 def _mpl_hatch2pgfp_pattern(data, hatch, color_name, color_rgba):
     r"""
-        Translates a hatch from matplotlib to the corresponding patten in PGFPlots.
-
-        Input:
-            hatch - str, like {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
-            color_name - str, xcolor or custom color name
-            color_rgba - np.array, the rgba value of the color
-        Output:
-            draw_options - list, empty or with a post action string
+    Translates a hatch from matplotlib to the corresponding patten in PGFPlots.
+
+    Input:
+        hatch - str, like {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
+        color_name - str, xcolor or custom color name
+        color_rgba - np.array, the rgba value of the color
+    Output:
+        draw_options - list, empty or with a post action string
     """
     hatch = __validate_hatch(hatch)
     try:

tikzplotlib/_image.py

@@ -6,8 +6,7 @@
 
 
 def draw_image(data, obj):
-    """Returns the PGFPlots code for an image environment.
-    """
+    """Returns the PGFPlots code for an image environment."""
     content = []
 
     filename, rel_filepath = _files.new_filename(data, "img", ".png")

tikzplotlib/_legend.py

@@ -6,8 +6,7 @@
 
 
 def draw_legend(data, obj):
-    """Adds legend code.
-    """
+    """Adds legend code."""
     texts = []
     children_alignment = []
     for text in obj.texts:

tikzplotlib/_line2d.py

@@ -11,8 +11,7 @@
 
 
 def draw_line2d(data, obj):
-    """Returns the PGFPlots code for an Line2D environment.
-    """
+    """Returns the PGFPlots code for an Line2D environment."""
     content = []
     addplot_options = []
 
@@ -101,8 +100,7 @@ def draw_line2d(data, obj):
 
 
 def draw_linecollection(data, obj):
-    """Returns Pgfplots code for a number of patch objects.
-    """
+    """Returns Pgfplots code for a number of patch objects."""
     content = []
 
     edgecolors = obj.get_edgecolors()

tikzplotlib/_patch.py

@@ -5,8 +5,7 @@
 
 
 def draw_patch(data, obj):
-    """Return the PGFPlots code for patches.
-    """
+    """Return the PGFPlots code for patches."""
     if isinstance(obj, mpl.patches.FancyArrowPatch):
         data, draw_options = mypath.get_draw_options(
             data,
@@ -70,8 +69,7 @@ def zip_modulo(*seqs):
 
 
 def draw_patchcollection(data, obj):
-    """Returns PGFPlots code for a number of patch objects.
-    """
+    """Returns PGFPlots code for a number of patch objects."""
     content = []
 
     # recompute the face colors
@@ -116,8 +114,7 @@ def _draw_polygon(data, obj, draw_options):
 
 
 def _draw_rectangle(data, obj, draw_options):
-    """Return the PGFPlots code for rectangles.
-    """
+    """Return the PGFPlots code for rectangles."""
     # Objects with labels are plot objects (from bar charts, etc).  Even those without
     # labels explicitly set have a label of "_nolegend_".  Everything else should be
     # skipped because they likely correspong to axis/legend objects which are handled by
@@ -156,8 +153,7 @@ def _draw_rectangle(data, obj, draw_options):
 
 
 def _draw_ellipse(data, obj, draw_options):
-    """Return the PGFPlots code for ellipses.
-    """
+    """Return the PGFPlots code for ellipses."""
     if isinstance(obj, mpl.patches.Circle):
         # circle specialization
         return _draw_circle(data, obj, draw_options)
@@ -180,8 +176,7 @@ def _draw_ellipse(data, obj, draw_options):
 
 
 def _draw_circle(data, obj, draw_options):
-    """Return the PGFPlots code for circles.
-    """
+    """Return the PGFPlots code for circles."""
     x, y = obj.center
     ff = data["float format"]
     do = ",".join(draw_options)

tikzplotlib/_path.py

@@ -11,8 +11,7 @@
 
 
 def draw_path(data, path, draw_options=None, simplify=None):
-    """Adds code for drawing an ordinary path in PGFPlots (TikZ).
-    """
+    """Adds code for drawing an ordinary path in PGFPlots (TikZ)."""
     # For some reasons, matplotlib sometimes adds void paths which consist of
     # only one point and have 0 fill opacity. To not let those clutter the
     # output TeX file, bail out here.
@@ -112,8 +111,7 @@ def draw_path(data, path, draw_options=None, simplify=None):
 
 
 def draw_pathcollection(data, obj):
-    """Returns PGFPlots code for a number of patch objects.
-    """
+    """Returns PGFPlots code for a number of patch objects."""
     content = []
     # gather data
     assert obj.get_offsets() is not None
@@ -203,9 +201,9 @@ def draw_pathcollection(data, obj):
             draw_options.extend(
                 [
                     "visualization depends on="
-                    "{\\thisrow{sizedata} \\as\\perpointmarksize}",
+                    + "{\\thisrow{sizedata} \\as\\perpointmarksize}",
                     "scatter/@pre marker code/.append style="
-                    "{/tikz/mark size=\\perpointmarksize}",
+                    + "{/tikz/mark size=\\perpointmarksize}",
                 ]
             )
 
@@ -230,18 +228,18 @@ def draw_pathcollection(data, obj):
 
 def get_draw_options(data, obj, ec, fc, ls, lw, hatch=None):
     """Get the draw options for a given (patch) object.
-        Get the draw options for a given (patch) object.
-        Input:
-            data -
-            obj -
-            ec - edge color
-            fc - face color
-            ls - linestyle
-            lw - linewidth
-            hatch=None - hatch, i.e., pattern within closed path
-        Output:
-            draw_options - list, to be ",".join(draw_options) to produce the
-                           draw options passed to PGF
+    Get the draw options for a given (patch) object.
+    Input:
+        data -
+        obj -
+        ec - edge color
+        fc - face color
+        ls - linestyle
+        lw - linewidth
+        hatch=None - hatch, i.e., pattern within closed path
+    Output:
+        draw_options - list, to be ",".join(draw_options) to produce the
+                       draw options passed to PGF
     """
     draw_options = []