Replace cbook.Bunch with types.SimpleNamespace.

QuLogic · QuLogic · commit 6ba17634fd76 · 2018-02-16T19:11:57.000-05:00
diff --git a/doc/api/next_api_changes/2018-02-15-ES.rst b/doc/api/next_api_changes/2018-02-15-ES.rst
@@ -0,0 +1,5 @@
+matplotlib.cbook.Bunch deprecated
+`````````````````````````````````
+The ``matplotlib.cbook.Bunch`` class has been deprecated. Instead, use
+`types.SimpleNamespace` from the standard library which provides the same
+functionality.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -10,6 +10,7 @@
 import warnings
 import math
 from operator import attrgetter
+import types
 
 import numpy as np
 
@@ -3954,7 +3955,7 @@ def start_pan(self, x, y, button):
             Intended to be overridden by new projection types.
 
         """
-        self._pan_start = cbook.Bunch(
+        self._pan_start = types.SimpleNamespace(
             lim=self.viewLim.frozen(),
             trans=self.transData.frozen(),
             trans_inverse=self.transData.inverted().frozen(),
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -17,6 +17,7 @@
 import struct
 import sys
 import time
+import types
 import warnings
 import zlib
 
@@ -28,7 +29,7 @@
     _Backend, FigureCanvasBase, FigureManagerBase, GraphicsContextBase,
     RendererBase)
 from matplotlib.backends.backend_mixed import MixedModeRenderer
-from matplotlib.cbook import (Bunch, get_realpath_and_stat,
+from matplotlib.cbook import (get_realpath_and_stat,
                               is_writable_file_like, maxdict)
 from matplotlib.figure import Figure
 from matplotlib.font_manager import findfont, is_opentype_cff_font, get_font
@@ -320,7 +321,8 @@ def pdfRepr(self):
     grestore=b'Q', textpos=b'Td', selectfont=b'Tf', textmatrix=b'Tm',
     show=b'Tj', showkern=b'TJ', setlinewidth=b'w', clip=b'W', shading=b'sh')
 
-Op = Bunch(**{name: Operator(value) for name, value in _pdfops.items()})
+Op = types.SimpleNamespace(**{name: Operator(value)
+                              for name, value in _pdfops.items()})
 
 
 def _paint_path(fill, stroke):
@@ -685,7 +687,7 @@ def dviFontName(self, dvifont):
         pdfname = Name('F%d' % self.nextFont)
         self.nextFont += 1
         _log.debug('Assigning font %s = %s (dvi)', pdfname, dvifont.texname)
-        self.dviFontInfo[dvifont.texname] = Bunch(
+        self.dviFontInfo[dvifont.texname] = types.SimpleNamespace(
             dvifont=dvifont,
             pdfname=pdfname,
             fontfile=psfont.filename,
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -488,7 +488,8 @@ def strip_math(s):
     return s
 
 
-class Bunch(object):
+@deprecated('3.0', alternative='types.SimpleNamespace')
+class Bunch(types.SimpleNamespace):
     """
     Often we want to just collect a bunch of stuff together, naming each
     item of the bunch; a dictionary's OK for that, but a small do- nothing
@@ -497,16 +498,8 @@ class is even handier, and prettier to use.  Whenever you want to
 
       >>> point = Bunch(datum=2, squared=4, coord=12)
       >>> point.datum
-
-      By: Alex Martelli
-      From: https://code.activestate.com/recipes/121294/
     """
-    def __init__(self, **kwds):
-        self.__dict__.update(kwds)
-
-    def __repr__(self):
-        return 'Bunch(%s)' % ', '.join(
-            '%s=%s' % kv for kv in six.iteritems(vars(self)))
+    pass
 
 
 @deprecated('2.1')
diff --git a/lib/matplotlib/mathtext.py b/lib/matplotlib/mathtext.py
@@ -22,6 +22,7 @@
 
 import os
 from math import ceil
+import types
 import unicodedata
 from warnings import warn
 from functools import lru_cache
@@ -37,7 +38,7 @@
 
 from matplotlib import _png, colors as mcolors, get_data_path, rcParams
 from matplotlib.afm import AFM
-from matplotlib.cbook import Bunch, get_realpath_and_stat
+from matplotlib.cbook import get_realpath_and_stat
 from matplotlib.ft2font import FT2Image, KERNING_DEFAULT, LOAD_NO_HINTING
 from matplotlib.font_manager import findfont, FontProperties, get_font
 from matplotlib._mathtext_data import (latex_to_bakoma, latex_to_standard,
@@ -312,8 +313,8 @@ def render_rect_filled(self, x1, y1, x2, y2):
 
     def get_results(self, box, used_characters):
         ship(0, 0, box)
-        svg_elements = Bunch(svg_glyphs = self.svg_glyphs,
-                             svg_rects = self.svg_rects)
+        svg_elements = types.SimpleNamespace(svg_glyphs=self.svg_glyphs,
+                                             svg_rects=self.svg_rects)
         return (self.width,
                 self.height + self.depth,
                 self.depth,
@@ -587,7 +588,7 @@ def _get_info(self, fontname, font_class, sym, fontsize, dpi, math=True):
 
         xmin, ymin, xmax, ymax = [val/64.0 for val in glyph.bbox]
         offset = self._get_offset(font, glyph, fontsize, dpi)
-        metrics = Bunch(
+        metrics = types.SimpleNamespace(
             advance = glyph.linearHoriAdvance/65536.0,
             height  = glyph.height/64.0,
             width   = glyph.width/64.0,
@@ -600,7 +601,7 @@ def _get_info(self, fontname, font_class, sym, fontsize, dpi, math=True):
             slanted = slanted
             )
 
-        result = self.glyphd[key] = Bunch(
+        result = self.glyphd[key] = types.SimpleNamespace(
             font            = font,
             fontsize        = fontsize,
             postscript_name = font.postscript_name,
@@ -1167,7 +1168,7 @@ def _get_info (self, fontname, font_class, sym, fontsize, dpi, math=True):
 
         xmin, ymin, xmax, ymax = [val * scale
                                   for val in font.get_bbox_char(glyph)]
-        metrics = Bunch(
+        metrics = types.SimpleNamespace(
             advance  = font.get_width_char(glyph) * scale,
             width    = font.get_width_char(glyph) * scale,
             height   = font.get_height_char(glyph) * scale,
@@ -1180,7 +1181,7 @@ def _get_info (self, fontname, font_class, sym, fontsize, dpi, math=True):
             slanted = slanted
             )
 
-        self.glyphd[key] = Bunch(
+        self.glyphd[key] = types.SimpleNamespace(
             font            = font,
             fontsize        = fontsize,
             postscript_name = font.get_fontname(),
@@ -2290,7 +2291,7 @@ class Parser(object):
     _right_delim = set(r") ] \} > \rfloor \rangle \rceil".split())
 
     def __init__(self):
-        p = Bunch()
+        p = types.SimpleNamespace()
         # All forward declarations are here
         p.accent           = Forward()
         p.ambi_delim       = Forward()
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -4,6 +4,7 @@
 import six
 
 from collections import OrderedDict
+import types
 
 import numpy as np
 
@@ -1362,7 +1363,7 @@ def start_pan(self, x, y, button):
         elif button == 3:
             mode = 'zoom'
 
-        self._pan_start = cbook.Bunch(
+        self._pan_start = types.SimpleNamespace(
             rmax=self.get_rmax(),
             trans=self.transData.frozen(),
             trans_inverse=self.transData.inverted().frozen(),
diff --git a/lib/matplotlib/sankey.py b/lib/matplotlib/sankey.py
@@ -6,10 +6,11 @@
 
 import six
 import logging
+from types import SimpleNamespace
 from six.moves import zip
 import numpy as np
 
-from matplotlib.cbook import iterable, Bunch
+from matplotlib.cbook import iterable
 from matplotlib.path import Path
 from matplotlib.patches import PathPatch
 from matplotlib.transforms import Affine2D
@@ -780,8 +781,9 @@ def _get_angle(a, r):
         # where either could determine the margins (e.g., arrow shoulders).
 
         # Add this diagram as a subdiagram.
-        self.diagrams.append(Bunch(patch=patch, flows=flows, angles=angles,
-                                   tips=tips, text=text, texts=texts))
+        self.diagrams.append(
+            SimpleNamespace(patch=patch, flows=flows, angles=angles, tips=tips,
+                            text=text, texts=texts))
 
         # Allow a daisy-chained call structure (see docstring for the class).
         return self
