Merge pull request #345 from nschloe/tikzpicture-parameters

nschloe · web-flow · commit 6ff42d45750a · 2019-10-27T20:56:09.000+01:00
Tikzpicture parameters
diff --git a/tikzplotlib/__init__.py b/tikzplotlib/__init__.py
@@ -1,14 +1,14 @@
 """Script to convert Matplotlib generated figures into TikZ/PGFPlots figures.
 """
-from tikzplotlib.__about__ import (
+from .__about__ import (
     __author__,
     __copyright__,
     __email__,
     __license__,
     __status__,
     __version__,
 )
-from tikzplotlib.save import get_tikz_code, save
+from ._save import get_tikz_code, save
 
 __all__ = [
     "__author__",
diff --git a/tikzplotlib/_axes.py b/tikzplotlib/_axes.py
@@ -4,7 +4,7 @@
     common_texification as mpl_common_texification,
 )
 
-from . import color
+from . import _color
 
 
 def _common_texification(string):
@@ -129,14 +129,14 @@ def __init__(self, data, obj):  # noqa: C901
         # axis line styles
         # Assume that the bottom edge color is the color of the entire box.
         axcol = obj.spines["bottom"].get_edgecolor()
-        data, col, _ = color.mpl_color2xcolor(data, axcol)
+        data, col, _ = _color.mpl_color2xcolor(data, axcol)
         if col != "black":
             self.axis_options.append("axis line style={{{}}}".format(col))
 
         # background color
         bgcolor = obj.get_facecolor()
 
-        data, col, _ = color.mpl_color2xcolor(data, bgcolor)
+        data, col, _ = _color.mpl_color2xcolor(data, bgcolor)
         if col != "white":
             self.axis_options.append("axis background/.style={{fill={}}}".format(col))
 
@@ -228,7 +228,7 @@ def _ticks(self, data, obj):
             pass
         else:
             c0 = l0.get_color()
-            data, xtickcolor, _ = color.mpl_color2xcolor(data, c0)
+            data, xtickcolor, _ = _color.mpl_color2xcolor(data, c0)
             self.axis_options.append("xtick style={{color={}}}".format(xtickcolor))
 
         try:
@@ -237,7 +237,7 @@ def _ticks(self, data, obj):
             pass
         else:
             c0 = l0.get_color()
-            data, ytickcolor, _ = color.mpl_color2xcolor(data, c0)
+            data, ytickcolor, _ = _color.mpl_color2xcolor(data, c0)
             self.axis_options.append("ytick style={{color={}}}".format(ytickcolor))
 
         # Find tick direction
@@ -305,7 +305,7 @@ def _grid(self, obj, data):
         xlines = obj.get_xgridlines()
         if xlines:
             xgridcolor = xlines[0].get_color()
-            data, col, _ = color.mpl_color2xcolor(data, xgridcolor)
+            data, col, _ = _color.mpl_color2xcolor(data, xgridcolor)
             if col != "black":
                 self.axis_options.append("x grid style={{{}}}".format(col))
 
@@ -317,7 +317,7 @@ def _grid(self, obj, data):
         ylines = obj.get_ygridlines()
         if ylines:
             ygridcolor = ylines[0].get_color()
-            data, col, _ = color.mpl_color2xcolor(data, ygridcolor)
+            data, col, _ = _color.mpl_color2xcolor(data, ygridcolor)
             if col != "black":
                 self.axis_options.append("y grid style={{{}}}".format(col))
 
diff --git a/tikzplotlib/_color.py b/tikzplotlib/_color.py
diff --git a/tikzplotlib/_files.py b/tikzplotlib/_files.py
diff --git a/tikzplotlib/_image.py b/tikzplotlib/_image.py
@@ -2,15 +2,15 @@
 import numpy
 import PIL
 
-from . import files
+from . import _files
 
 
 def draw_image(data, obj):
     """Returns the PGFPlots code for an image environment.
     """
     content = []
 
-    filename, rel_filepath = files.new_filename(data, "img", ".png")
+    filename, rel_filepath = _files.new_filename(data, "img", ".png")
 
     # store the image as in a file
     img_array = obj.get_array()
diff --git a/tikzplotlib/_legend.py b/tikzplotlib/_legend.py
@@ -2,7 +2,7 @@
 
 import numpy
 
-from . import color as mycol
+from . import _color as mycol
 
 
 def draw_legend(data, obj):
diff --git a/tikzplotlib/_line2d.py b/tikzplotlib/_line2d.py
@@ -3,11 +3,11 @@
 import numpy
 from matplotlib.dates import num2date
 
-from . import color as mycol
-from . import files
-from . import path as mypath
-from .util import get_legend_text, has_legend, transform_to_data_coordinates
+from . import _color as mycol
+from . import _files
+from . import _path as mypath
 from ._markers import _mpl_marker2pgfp_marker
+from ._util import get_legend_text, has_legend, transform_to_data_coordinates
 
 
 def draw_line2d(data, obj):
@@ -291,7 +291,7 @@ def _table(obj, data):  # noqa: C901
             )
 
     if data["externalize tables"]:
-        filename, rel_filepath = files.new_filename(data, "table", ".tsv")
+        filename, rel_filepath = _files.new_filename(data, "table", ".tsv")
         with open(filename, "w") as f:
             # No encoding handling required: plot_table is only ASCII
             f.write("".join(plot_table))
diff --git a/tikzplotlib/_patch.py b/tikzplotlib/_patch.py
@@ -1,6 +1,6 @@
 import matplotlib as mpl
 
-from . import path as mypath
+from . import _path as mypath
 
 
 def draw_patch(data, obj):
diff --git a/tikzplotlib/_path.py b/tikzplotlib/_path.py
@@ -2,10 +2,10 @@
 import numpy
 from matplotlib.markers import MarkerStyle
 
-from . import color
-from .axes import _mpl_cmap2pgf_cmap
-from .util import get_legend_text, has_legend
+from . import _color
+from ._axes import _mpl_cmap2pgf_cmap
 from ._markers import _mpl_marker2pgfp_marker
+from ._util import get_legend_text, has_legend
 
 
 def draw_path(data, path, draw_options=None, simplify=None):
@@ -239,13 +239,13 @@ def get_draw_options(data, obj, ec, fc, style, width):
     draw_options = []
 
     if ec is not None:
-        data, col, ec_rgba = color.mpl_color2xcolor(data, ec)
+        data, col, ec_rgba = _color.mpl_color2xcolor(data, ec)
         if ec_rgba[3] != 0.0:
             # Don't draw if it's invisible anyways.
             draw_options.append("draw={}".format(col))
 
     if fc is not None:
-        data, col, fc_rgba = color.mpl_color2xcolor(data, fc)
+        data, col, fc_rgba = _color.mpl_color2xcolor(data, fc)
         if fc_rgba[3] != 0.0:
             # Don't draw if it's invisible anyways.
             draw_options.append("fill={}".format(col))
diff --git a/tikzplotlib/_quadmesh.py b/tikzplotlib/_quadmesh.py
@@ -1,6 +1,6 @@
 from PIL import Image
 
-from . import files
+from . import _files
 
 
 def draw_quadmesh(data, obj):
@@ -10,7 +10,7 @@ def draw_quadmesh(data, obj):
     content = []
 
     # Generate file name for current object
-    filename, rel_filepath = files.new_filename(data, "img", ".png")
+    filename, rel_filepath = _files.new_filename(data, "img", ".png")
 
     # Get the dpi for rendering and store the original dpi of the figure
     dpi = data["dpi"]
diff --git a/tikzplotlib/_save.py b/tikzplotlib/_save.py
@@ -6,11 +6,11 @@
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 
-from . import axes
-from . import image as img
-from . import legend, line2d, patch, path
-from . import quadmesh as qmsh
-from . import text
+from . import _axes
+from . import _image as img
+from . import _legend, _line2d, _patch, _path
+from . import _quadmesh as qmsh
+from . import _text
 from .__about__ import __version__
 
 
@@ -105,9 +105,7 @@ def get_tikz_code(
 
     :param extra_tikzpicture_parameters: Extra tikzpicture options to be passed
                                          (as a set) to pgfplots.
-
-    :type extra_tikzpicture_parameters: a set of strings for the pfgplots
-                                        tikzpicture.
+    :type extra_tikzpicture_parameters: a set of strings for the pfgplots tikzpicture.
 
     :param dpi: The resolution in dots per inch of the rendered image in case
                 of QuadMesh plots. If ``None`` it will default to the value
@@ -166,7 +164,6 @@ def get_tikz_code(
     data["font size"] = textsize
     data["custom colors"] = {}
     data["legend colors"] = []
-    data["extra tikzpicture parameters"] = extra_tikzpicture_parameters
     data["add axis environment"] = add_axis_environment
     data["show_info"] = show_info
     # rectangle_legends is used to keep track of which rectangles have already
@@ -210,10 +207,10 @@ def get_tikz_code(
 
     # write the contents
     if wrap and add_axis_environment:
-        code += "\\begin{tikzpicture}\n\n"
+        code += "\\begin{tikzpicture}"
         if extra_tikzpicture_parameters:
-            code += ",\n".join(data["extra tikzpicture parameters"])
-            code += "\n"
+            code += "[\n" + ",\n".join(extra_tikzpicture_parameters) + "\n]"
+        code += "\n\n"
 
     coldefs = _get_color_definitions(data)
     if coldefs:
@@ -333,7 +330,7 @@ def _recurse(data, obj):
             continue
 
         if isinstance(child, mpl.axes.Axes):
-            ax = axes.Axes(data, child)
+            ax = _axes.Axes(data, child)
 
             if ax.is_colorbar:
                 continue
@@ -362,34 +359,34 @@ def _recurse(data, obj):
                     print("".join(ax.get_begin_code()[1:]))
                     print("=========================================================")
         elif isinstance(child, mpl.lines.Line2D):
-            data, cont = line2d.draw_line2d(data, child)
+            data, cont = _line2d.draw_line2d(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, mpl.image.AxesImage):
             data, cont = img.draw_image(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, mpl.patches.Patch):
-            data, cont = patch.draw_patch(data, child)
+            data, cont = _patch.draw_patch(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(
             child, (mpl.collections.PatchCollection, mpl.collections.PolyCollection)
         ):
-            data, cont = patch.draw_patchcollection(data, child)
+            data, cont = _patch.draw_patchcollection(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, mpl.collections.PathCollection):
-            data, cont = path.draw_pathcollection(data, child)
+            data, cont = _path.draw_pathcollection(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, mpl.collections.LineCollection):
-            data, cont = line2d.draw_linecollection(data, child)
+            data, cont = _line2d.draw_linecollection(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, mpl.collections.QuadMesh):
             data, cont = qmsh.draw_quadmesh(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, mpl.legend.Legend):
-            data = legend.draw_legend(data, child)
+            data = _legend.draw_legend(data, child)
             if data["legend colors"]:
                 content.extend(data["legend colors"], 0)
         elif isinstance(child, (mpl.text.Text, mpl.text.Annotation)):
-            data, cont = text.draw_text(data, child)
+            data, cont = _text.draw_text(data, child)
             content.extend(cont, child.get_zorder())
         elif isinstance(child, (mpl.axis.XAxis, mpl.axis.YAxis)):
             pass
diff --git a/tikzplotlib/_text.py b/tikzplotlib/_text.py
@@ -1,6 +1,6 @@
 import matplotlib as mpl
 
-from . import color
+from . import _color
 
 
 def draw_text(data, obj):
@@ -47,7 +47,7 @@ def draw_text(data, obj):
     anchor = _transform_positioning(ha, va)
     if anchor is not None:
         properties.append(anchor)
-    data, col, _ = color.mpl_color2xcolor(data, converter.to_rgb(obj.get_color()))
+    data, col, _ = _color.mpl_color2xcolor(data, converter.to_rgb(obj.get_color()))
     properties.append("text={}".format(col))
     properties.append("rotate={:.1f}".format(obj.get_rotation()))
 
@@ -170,7 +170,7 @@ def _annotation(obj, data, content):
             if obj.arrowprops["arrowstyle"] is not None:
                 if obj.arrowprops["arrowstyle"] in arrow_translate:
                     arrow_style += arrow_translate[obj.arrowprops["arrowstyle"]]
-                    data, col, _ = color.mpl_color2xcolor(
+                    data, col, _ = _color.mpl_color2xcolor(
                         data, obj.arrow_patch.get_ec()
                     )
                     arrow_style.append(col)
@@ -197,10 +197,10 @@ def _annotation(obj, data, content):
 def _bbox(bbox, data, properties, scaling):
     bbox_style = bbox.get_boxstyle()
     if bbox.get_fill():
-        data, fc, _ = color.mpl_color2xcolor(data, bbox.get_facecolor())
+        data, fc, _ = _color.mpl_color2xcolor(data, bbox.get_facecolor())
         if fc:
             properties.append("fill={}".format(fc))
-    data, ec, _ = color.mpl_color2xcolor(data, bbox.get_edgecolor())
+    data, ec, _ = _color.mpl_color2xcolor(data, bbox.get_edgecolor())
     if ec:
         properties.append("draw={}".format(ec))
     # XXX: This is ugly, too
diff --git a/tikzplotlib/_util.py b/tikzplotlib/_util.py
