From 8a7d02890ea8843bad50c740112702adf4e87e25 Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Sat, 10 Oct 2020 13:12:51 +0200 Subject: [PATCH] _make_norm_from_scale fixes. - Fix the docstring regarding `__init__`, which was previously incorrect. It's very long, but I can't really think of a better wording... - Set `__signature__` on `__init__`, for better instrospection. --- lib/matplotlib/colors.py | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py index 32f675b6d8c5..17777a63642a 100644 --- a/lib/matplotlib/colors.py +++ b/lib/matplotlib/colors.py @@ -1262,16 +1262,27 @@ def _make_norm_from_scale(scale_cls, base_norm_cls=None, *, init=None): After :: @_make_norm_from_scale(scale_cls) - class base_norm_cls(Normalize): + class norm_cls(Normalize): ... - *base_norm_cls* is filled with methods so that normalization computations - are forwarded to *scale_cls* (i.e., *scale_cls* is the scale that would be - used for the colorbar of a mappable normalized with *base_norm_cls*). - - The constructor signature of *base_norm_cls* is derived from the - constructor signature of *scale_cls*, but can be overridden using *init* - (a callable which is *only* used for its signature). + *norm_cls* is filled with methods so that normalization computations are + forwarded to *scale_cls* (i.e., *scale_cls* is the scale that would be used + for the colorbar of a mappable normalized with *norm_cls*). + + If *init* is not passed, then the constructor signature of *norm_cls* + will be ``norm_cls(vmin=None, vmax=None, clip=False)``; these three + parameters will be forwarded to the base class (``Normalize.__init__``), + and a *scale_cls* object will be initialized with no arguments (other than + a dummy axis). + + If the *scale_cls* constructor takes additional parameters, then *init* + should be passed to `_make_norm_from_scale`. It is a callable which is + *only* used for its signature. First, this signature will become the + signature of *norm_cls*. Second, the *norm_cls* constructor will bind the + parameters passed to it using this signature, extract the bound *vmin*, + *vmax*, and *clip* values, pass those to ``Normalize.__init__``, and + forward the remaining bound values (including any defaults defined by the + signature) to the *scale_cls* constructor. """ if base_norm_cls is None: @@ -1279,12 +1290,12 @@ class base_norm_cls(Normalize): if init is None: def init(vmin=None, vmax=None, clip=False): pass - init_signature = inspect.signature(init) + bound_init_signature = inspect.signature(init) class Norm(base_norm_cls): def __init__(self, *args, **kwargs): - ba = init_signature.bind(*args, **kwargs) + ba = bound_init_signature.bind(*args, **kwargs) ba.apply_defaults() super().__init__( **{k: ba.arguments.pop(k) for k in ["vmin", "vmax", "clip"]}) @@ -1329,6 +1340,9 @@ def inverse(self, value): Norm.__name__ = base_norm_cls.__name__ Norm.__qualname__ = base_norm_cls.__qualname__ Norm.__module__ = base_norm_cls.__module__ + Norm.__init__.__signature__ = bound_init_signature.replace(parameters=[ + inspect.Parameter("self", inspect.Parameter.POSITIONAL_OR_KEYWORD), + *bound_init_signature.parameters.values()]) return Norm pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy