Merge pull request #13744 from timhoffm/restructure-boilerplate

jklymak · web-flow · commit 4adf436c0eb5 · 2019-03-25T08:10:23.000-07:00
Restructure boilerplate.py
diff --git a/tools/boilerplate.py b/tools/boilerplate.py
@@ -35,17 +35,17 @@
 # Autogenerated by boilerplate.py.  Do not edit as changes will be lost."""
 
 CMAPPABLE_TEMPLATE = AUTOGEN_MSG + """
-@docstring.copy(Axes.%(real_name)s)
-def %(func)s%(sig)s:
-    __ret = gca().%(real_name)s%(call)s
-%(mappable)s
+@docstring.copy(Axes.{called_name})
+def {name}{signature}:
+    __ret = gca().{called_name}{call}
+    {sci_command}
     return __ret
 """
 
 NON_CMAPPABLE_TEMPLATE = AUTOGEN_MSG + """
-@docstring.copy(Axes.%(real_name)s)
-def %(func)s%(sig)s:
-    return gca().%(real_name)s%(call)s
+@docstring.copy(Axes.{called_name})
+def {name}{signature}:
+    return gca().{called_name}{call}
 """
 
 # Used for colormap functions
@@ -61,11 +61,111 @@ def {name}():
 '''
 
 
+class value_formatter:
+    """
+    Format function default values as needed for inspect.formatargspec.
+    The interesting part is a hard-coded list of functions used
+    as defaults in pyplot methods.
+    """
+
+    def __init__(self, value):
+        if value is mlab.detrend_none:
+            self._repr = "mlab.detrend_none"
+        elif value is mlab.window_hanning:
+            self._repr = "mlab.window_hanning"
+        elif value is np.mean:
+            self._repr = "np.mean"
+        elif value is cbook.deprecation._deprecated_parameter:
+            self._repr = "cbook.deprecation._deprecated_parameter"
+        else:
+            self._repr = repr(value)
+
+    def __repr__(self):
+        return self._repr
+
+
+def generate_function(name, called_name, template, **kwargs):
+    """
+    Create a wrapper function *pyplot_name* calling *call_name*.
+
+    Parameters
+    ----------
+    name : str
+        The function to be created.
+    called_name : str
+        The function to be wrapped.
+    template : str
+        The template to be used. The template must contain {}-style format
+        placeholders. The following placeholders are filled in:
+
+        - name: The function name.
+        - signature: The function signature (including parentheses).
+        - called_name: The name of the called function.
+        - call: Parameters passed to *called_name* (including parentheses).
+
+    **kwargs
+        Additional parameters are passed to ``template.format()``.
+    """
+    text_wrapper = textwrap.TextWrapper(
+        break_long_words=False, width=70,
+        initial_indent=' ' * 8, subsequent_indent=' ' * 8)
+
+    # Get signature of wrapped function.
+    signature = inspect.signature(getattr(Axes, called_name))
+    # Replace self argument.
+    params = list(signature.parameters.values())[1:]
+    signature = str(signature.replace(parameters=[
+        param.replace(default=value_formatter(param.default))
+        if param.default is not param.empty else param
+        for param in params]))
+    if len('def ' + name + signature) >= 80:
+        # Move opening parenthesis before newline.
+        signature = '(\n' + text_wrapper.fill(signature).replace('(', '', 1)
+    # How to call the wrapped function.
+    call = '(' + ', '.join((
+           # Pass "intended-as-positional" parameters positionally to avoid
+           # forcing third-party subclasses to reproduce the parameter names.
+           '{0}'
+           if param.kind in [
+               Parameter.POSITIONAL_OR_KEYWORD]
+              and param.default is Parameter.empty else
+           # Only pass the data kwarg if it is actually set, to avoid forcing
+           # third-party subclasses to support it.
+           '**({{"data": data}} if data is not None else {{}})'
+           if param.name == "data" else
+           '{0}={0}'
+           if param.kind in [
+               Parameter.POSITIONAL_OR_KEYWORD,
+               Parameter.KEYWORD_ONLY] else
+           '*{0}'
+           if param.kind is Parameter.VAR_POSITIONAL else
+           '**{0}'
+           if param.kind is Parameter.VAR_KEYWORD else
+           # Intentionally crash for Parameter.POSITIONAL_ONLY.
+           None).format(param.name)
+       for param in params) + ')'
+    MAX_CALL_PREFIX = 18  # len('    __ret = gca().')
+    if MAX_CALL_PREFIX + max(len(name), len(called_name)) + len(call) >= 80:
+        call = '(\n' + text_wrapper.fill(call[1:])
+    # Bail out in case of name collision.
+    for reserved in ('gca', 'gci', '__ret'):
+        if reserved in params:
+            raise ValueError(
+                f'Axes method {called_name} has kwarg named {reserved}')
+
+    return template.format(
+        name=name,
+        called_name=called_name,
+        signature=signature,
+        call=call,
+        **kwargs)
+
+
 def boilerplate_gen():
     """Generator of lines for the automated part of pyplot."""
 
     # These methods are all simple wrappers of Axes methods by the same name.
-    _commands = (
+    _axes_commands = (
         'acorr',
         'angle_spectrum',
         'annotate',
@@ -161,91 +261,16 @@ def boilerplate_gen():
         'tripcolor': 'sci(__ret)',
     }
 
-    class value_formatter:
-        """
-        Format function default values as needed for inspect.formatargspec.
-        The interesting part is a hard-coded list of functions used
-        as defaults in pyplot methods.
-        """
-
-        def __init__(self, value):
-            if value is mlab.detrend_none:
-                self._repr = "mlab.detrend_none"
-            elif value is mlab.window_hanning:
-                self._repr = "mlab.window_hanning"
-            elif value is np.mean:
-                self._repr = "np.mean"
-            elif value is cbook.deprecation._deprecated_parameter:
-                self._repr = "cbook.deprecation._deprecated_parameter"
-            else:
-                self._repr = repr(value)
-
-        def __repr__(self):
-            return self._repr
-
-    text_wrapper = textwrap.TextWrapper(
-        break_long_words=False, width=70,
-        initial_indent=' ' * 8, subsequent_indent=' ' * 8)
-
-    for spec in _commands:
+    for spec in _axes_commands:
         if ':' in spec:
-            func, real_name = spec.split(':')
+            name, called_name = spec.split(':')
         else:
-            func = real_name = spec
+            name = called_name = spec
 
-        # For some commands, an additional line is needed to set the color map.
-        if func in cmappable:
-            fmt = CMAPPABLE_TEMPLATE
-            mappable = '    ' + cmappable[func]
-        else:
-            fmt = NON_CMAPPABLE_TEMPLATE
-
-        # Get signature of wrapped function.
-        sig = inspect.signature(getattr(Axes, real_name))
-
-        # Replace self argument.
-        params = list(sig.parameters.values())[1:]
-
-        sig = str(sig.replace(parameters=[
-            param.replace(default=value_formatter(param.default))
-            if param.default is not param.empty else param
-            for param in params]))
-        if len('def ' + func + sig) >= 80:
-            # Move opening parenthesis before newline.
-            sig = '(\n' + text_wrapper.fill(sig).replace('(', '', 1)
-
-        # How to call the wrapped function.
-        call = '(' + ', '.join((
-            # Pass "intended-as-positional" parameters positionally to avoid
-            # forcing third-party subclasses to reproduce the parameter names.
-            '{0}'
-            if param.kind in [Parameter.POSITIONAL_OR_KEYWORD]
-               and param.default is Parameter.empty else
-            # Only pass the data kwarg if it is actually set, to avoid forcing
-            # third-party subclasses to support it.
-            '**({{"data": data}} if data is not None else {{}})'
-            if param.name == "data" else
-            '{0}={0}'
-            if param.kind in [Parameter.POSITIONAL_OR_KEYWORD,
-                              Parameter.KEYWORD_ONLY] else
-            '*{0}'
-            if param.kind is Parameter.VAR_POSITIONAL else
-            '**{0}'
-            if param.kind is Parameter.VAR_KEYWORD else
-            # Intentionally crash for Parameter.POSITIONAL_ONLY.
-            None).format(param.name)
-            for param in params) + ')'
-        MAX_CALL_PREFIX = 18  # len('    __ret = gca().')
-        if MAX_CALL_PREFIX + max(len(func), len(real_name)) + len(call) >= 80:
-            call = '(\n' + text_wrapper.fill(call[1:])
-
-        # Bail out in case of name collision.
-        for reserved in ('gca', 'gci', '__ret'):
-            if reserved in params:
-                raise ValueError(
-                    'Axes method {} has kwarg named {}'.format(func, reserved))
-
-        yield fmt % locals()
+        template = (CMAPPABLE_TEMPLATE if name in cmappable else
+                    NON_CMAPPABLE_TEMPLATE)
+        yield generate_function(name, called_name, template,
+                                sci_command=cmappable.get(name))
 
     cmaps = (
         'autumn',
