FIX: review comments

jklymak · jklymak · commit ba1f41bf136e · 2023-04-11T14:06:21.000-07:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -380,7 +380,7 @@ def gallery_image_warning_filter(record):
 plot_formats = [formats[target] for target in ['html', 'latex']
                 if target in sys.argv] or list(formats.values())
 # make 2x images for srcset argument to <img>
-plot_srcset = '2x'
+plot_srcset = ['2x']
 
 # GitHub extension
 
diff --git a/doc/users/next_whats_new/plot_directive_srcset.rst b/doc/users/next_whats_new/plot_directive_srcset.rst
@@ -11,7 +11,7 @@ figures and add these to the the built html docs.  In ``conf.py``::
         'matplotlib.sphinxext.figmpl_directive',
     ...]
 
-    plot_srcset = '2x'
+    plot_srcset = ['2x']
 
 will make png files with double the resolution for hiDPI displays.  Resulting
 html files will have image entries like::
diff --git a/lib/matplotlib/_tight_bbox.py b/lib/matplotlib/_tight_bbox.py
@@ -4,6 +4,7 @@
 
 from matplotlib.transforms import Bbox, TransformedBbox, Affine2D
 
+import numpy as np
 
 def adjust_bbox(fig, bbox_inches, fixed_dpi=None):
     """
@@ -54,8 +55,12 @@ def restore_bbox():
     dpi_scale = fixed_dpi / fig.dpi
 
     fig.bbox_inches = Bbox.from_bounds(0, 0, *bbox_inches.size)
-    x0, y0 = tr.transform(bbox_inches.p0)
+    print(bbox_inches.p0)
+    x0 = np.floor(bbox_inches.p0[0]*fig.dpi * dpi_scale)
+    y0 = np.floor(bbox_inches.p0[1]*fig.dpi * dpi_scale)
+    # x0, y0 = tr.transform(bbox_inches.p0)
     w1, h1 = fig.bbox.size * dpi_scale
+    print('x0, y0, w1, h1', x0, y0, w1, h1, fig.bbox)
     fig.transFigure._boxout = Bbox.from_bounds(-x0, -y0, w1, h1)
     fig.transFigure.invalidate()
 
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -1277,7 +1277,10 @@ def _to_unmasked_float_array(x):
     if hasattr(x, 'mask'):
         return np.ma.asarray(x, float).filled(np.nan)
     else:
-        return np.asarray(x, float)
+        try:
+            return np.asarray(x, float)
+        except TypeError:
+            return np.asarray([float(xx) for xx in x])
 
 
 def _check_1d(x):
diff --git a/lib/matplotlib/sphinxext/figmpl_directive.py b/lib/matplotlib/sphinxext/figmpl_directive.py
@@ -31,8 +31,9 @@ class figmplnode(nodes.General, nodes.Element):
 
 class FigureMpl(Figure):
     """
-    Implements a directive to allow an optional hidpi image.  Meant to be
-    used with the *plot_srcset* configuration option in conf.py,
+    Implements a directive to allow an optional hidpi image.
+
+    Meant to be used with the *plot_srcset* configuration option in conf.py,
     and gets set in the TEMPLATE of plot_directive.py
 
     e.g.::
@@ -47,7 +48,7 @@ class FigureMpl(Figure):
 
         <img src="sphx_glr_bar_001_hidpi.png"
             srcset="_images/some_plot-1.png,
-                    _images/some_plots-1.2x.png 2.00 x",
+                    _images/some_plots-1.2x.png 2.00x",
             alt="bar"
             class="plot_directive" />
 
@@ -64,7 +65,7 @@ class FigureMpl(Figure):
 
         <img src="../_images/nestedpage-index-1.png"
             srcset="../_images/nestedpage-index-1.png,
-                    ../_images/_images/nestedpage-index-1.2x.png 2x",
+                    ../_images/_images/nestedpage-index-1.2x.png 2.00x",
             alt="bar"
             class="sphx-glr-single-img" />
 
@@ -101,7 +102,7 @@ def run(self):
 
         # we would like uri to be the highest dpi version so that
         # latex etc will use that.  But for now, lets just make
-        # imagenm
+        # imagenm... maybe pdf one day?
 
         image_node['uri'] = imagenm
         image_node['srcset'] = self.options.get('srcset', None)
@@ -186,23 +187,22 @@ def visit_figmpl_html(self, node):
     # ../../_images/ for dirhtml and ../_images/ for html
     imagerel = relpath(imagedir, os.path.dirname(dest))
     if self.builder.name == "dirhtml":
-        imagerel = '..' + imagerel + ''
-    else:  # html
-        imagerel = imagerel + ''
+        imagerel = f'..{imagerel}'
 
     # make uri also be relative...
     nm = PurePosixPath(node['uri'][1:]).name
-    uri = imagerel + '/' + rel + nm
+    uri = f'{imagerel}/{rel}{nm}'
 
     # make srcset str.  Need to change all the prefixes!
+    maxsrc = uri
+    srcsetst = ''
     if srcset:
-        srcsetst = ''
         maxmult = -1
         for mult in srcset:
             nm = PurePosixPath(srcset[mult][1:]).name
             # ../../_images/plot_1_2_0x.png
-            path = imagerel + '/' + rel + nm
-            srcsetst += f'{path}'
+            path = f'{imagerel}/{rel}{nm}'
+            srcsetst += path
             if mult == 0:
                 srcsetst += ', '
             else:
@@ -214,20 +214,23 @@ def visit_figmpl_html(self, node):
 
         # trim trailing comma and space...
         srcsetst = srcsetst[:-2]
-    else:
-        srcsetst = ''
-        maxsrc = uri
 
     alt = node['alt']
     if node['class'] is not None:
-        classst = ''
-        for cl in node['class']:
-            classst += cl + ' '
+        classst = ' '.join(node['class'])
         classst = f'class="{classst}"'
 
     else:
         classst = ''
 
+    stylers = ['width', 'height', 'scale']
+    stylest = ''
+    for style in stylers:
+        if node[style]:
+            stylest += f'{style}: {node[style]};'
+
+    figalign = node['align'] if node['align'] else 'center'
+
 # <figure class="align-default" id="id1">
 # <a class="reference internal image-reference" href="_images/index-1.2x.png">
 # <img alt="_images/index-1.2x.png" src="_images/index-1.2x.png" style="width: 53%;" />
@@ -237,15 +240,6 @@ def visit_figmpl_html(self, node):
 # <a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
 # </figcaption>
 # </figure>
-
-    stylers = ['width', 'height', 'scale']
-    stylest = ''
-    for style in stylers:
-        if node[style]:
-            stylest += f'{style}: {node[style]};'
-
-    figalign = node['align'] if node['align'] else 'center'
-
     img_block = (f'<img src="{uri}" style="{stylest}" srcset="{srcsetst}" ' +
                  f'alt="{alt}" {classst}/>')
     html_block = f'<figure class="align-{figalign}">\n'
@@ -265,9 +259,9 @@ def visit_figmpl_latex(self, node):
         imagedir, srcset = _copy_images_figmpl(self, node)
         maxmult = -1
         # choose the highest res version for latex:
-        for key in srcset.keys():
-            maxmult = max(maxmult, key)
-        node['uri'] = str(PurePosixPath(srcset[maxmult]).name)
+        # choose the highest res version for latex:
+        maxmult = max(srcset, default=-1)
+        node['uri'] = PurePosixPath(srcset[maxmult]).name
 
     self.visit_figure(node)
 
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -141,9 +141,9 @@
         Provide a customized template for preparing restructured text.
 
     plot_srcset
-        Allow the srcset image option for responsive image resolutions. Comma
-        separated string with the multiplicative factors followed by an "x".
-        e.g. "2.0x, 1.5x".  "2.0x" will create a png with the default "png"
+        Allow the srcset image option for responsive image resolutions. List of
+        strings with the multiplicative factors followed by an "x".
+        e.g. ["2.0x", "1.5x"].  "2.0x" will create a png with the default "png"
         resolution from plot_formats, multiplied by 2. If plot_src is
         specified, the plot directive uses the
         :doc:`/api/sphinxext_figmpl_directive_api` (instead of the usual figure
@@ -378,11 +378,9 @@ def _split_code_at_show(text, function_name):
    {%- endif -%}
    )
    {% endif %}
-
 """
 
 TEMPLATE_SRCSET = _SOURCECODE + """
-
    {% for img in images %}
    .. figure-mpl:: {{ build_dir }}/{{ img.basename }}.{{ default_fmt }}
       {% for option in options -%}
@@ -587,12 +585,10 @@ def get_plot_formats(config):
     return formats
 
 
-def _parse_srcset(st):
+def _parse_srcset(entries):
     """
     Parse srcset for multiples...
     """
-    entries = st.split(',')
-
     srcset = {}
     for entry in entries:
         entry = entry.strip()
@@ -729,7 +725,7 @@ def run(arguments, content, options, state_machine, state, lineno):
     config = document.settings.env.config
     nofigs = 'nofigs' in options
 
-    if (config.plot_srcset and setup.app.builder.name == 'singlehtml'):
+    if config.plot_srcset and setup.app.builder.name == 'singlehtml':
         raise ExtensionError(
             'plot_srcset option not compatible with single HTML writer')
 
@@ -911,8 +907,7 @@ def run(arguments, content, options, state_machine, state, lineno):
         else:
             src_name = None
         if config.plot_srcset:
-            srcset0 = _parse_srcset(config.plot_srcset)
-            srcset = [srcset0[sr] for sr in srcset0]
+            srcset = [*_parse_srcset(config.plot_srcset).values()]
             template = TEMPLATE_SRCSET
         else:
             srcset = None
diff --git a/lib/matplotlib/tests/test_sphinxext.py b/lib/matplotlib/tests/test_sphinxext.py
@@ -192,7 +192,7 @@ def test_srcset_version(tmp_path):
     doctree_dir = tmp_path / 'doctrees'
 
     build_sphinx_html(tmp_path, doctree_dir, html_dir, extra_args=[
-        '-D', 'plot_srcset=2x'])
+        '-c', f'{tmp_path}/confSrcset/'])
 
     def plot_file(num, suff=''):
         return img_dir / f'some_plots-{num}{suff}.png'
diff --git a/lib/matplotlib/tests/tinypages/confSrcset/conf.py b/lib/matplotlib/tests/tinypages/confSrcset/conf.py
@@ -0,0 +1,27 @@
+import sphinx
+from packaging.version import parse as parse_version
+
+# -- General configuration ------------------------------------------------
+
+extensions = ['matplotlib.sphinxext.plot_directive',
+              'matplotlib.sphinxext.figmpl_directive']
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+project = 'tinypages'
+copyright = '2014, Matplotlib developers'
+version = '0.1'
+release = '0.1'
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+
+if parse_version(sphinx.__version__) >= parse_version('1.3'):
+    html_theme = 'classic'
+else:
+    html_theme = 'default'
+
+# html_static_path = ['_static']
+
+plot_srcset = ['2x']
