U Fv f5@sdZddlZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z mZmZGdddZddZd d d d Zd dZddZddZdddZddZddZddZddZd ddZdS)!a+ Helper functions for managing the Matplotlib API. This documentation is only relevant for Matplotlib developers, not for users. .. warning:: This module and its submodules are for internal use only. Do not use them in your own code. We may change the API at any time with no warning. N) deprecatedwarn_deprecatedrename_parameterdelete_parametermake_keyword_onlydeprecate_method_overridedeprecate_privatize_attribute'suppress_matplotlib_deprecation_warningMatplotlibDeprecationWarningc@s.eZdZdZd ddZddZeddZdS) classpropertya$ Like `property`, but also triggers on access via the class, and it is the *class* that's passed as argument. Examples -------- :: class C: @classproperty def foo(cls): return cls.__name__ assert C.foo == "C" NcCs4||_|dk s|dk rtd||_||_||_dS)Nz#classproperty only implements fget.)_fget ValueErrorfsetfdel_doc)selffgetrrdocr>> _api.check_isinstance((SomeClass, None), arg=arg) Nc3s|]}|dkrn|VqdSrr).0tpZ none_typerr Psz#check_isinstance..cs.|kr dS|jdkr|jS|jd|jS)NNonebuiltins.)rr)r#r$rr type_nameRs z#check_isinstance..type_namer&z({!r} must be an instance of {}, not a {}r, z or r) type isinstancetupleitemsmapremoveappend TypeErrorformatlenjoin)_typeskwargstypesr)kvnamesrr$rcheck_isinstanceAs,        r=T)_print_supported_valuescKsb|s td|}|D]D\}}||kr|d|}|rT|ddtt|7}t|qdS)aC For each *key, value* pair in *kwargs*, check that *value* is in *_values*. Parameters ---------- _values : iterable Sequence of values to check on. _print_supported_values : bool, default: True Whether to print *_values* when raising ValueError. **kwargs : dict *key, value* pairs as keyword arguments to find in *_values*. Raises ------ ValueError If any *value* in *kwargs* is not found in *_values*. Examples -------- >>> _api.check_in_list(["foo", "bar"], arg=arg, other_arg=other_arg) zNo argument to check!z is not a valid value for z; supported values are r*N)r3r/r6r0reprr)Z_valuesr>r8valueskeyvalmsgrrr check_in_listesrDc s|}|D]\}}|j}t|t|ksBtddt||Dr ttdddtDd fdd|D}t|dkr|d7}t |d t|d |d |jd q d S)a For each *key, value* pair in *kwargs*, check that *value* has the shape *_shape*, if not, raise an appropriate ValueError. *None* in the shape is treated as a "free" size that can have any length. e.g. (None, 2) -> (N, 2) The values checked must be numpy arrays. Examples -------- To check for (N, 2) shaped arrays >>> _api.check_shape((None, 2), arg=arg, other_arg=other_arg) css|]\}}||dfkVqdSrr)r"tsrrrr%szcheck_shape..ZMNLIJKLHcss|]}d|VqdS)DNr)r"irrrr%sr*c3s&|]}|dk rt|ntVqdSr)strnext)r"nZ dim_labelsrrr%s r,z must be zD with shape (z). Your input has shape r(N) r/shaper5anyzipiter itertoolschaincountr6r)Z_shaper8Z target_shaper:r;Z data_shapeZ text_shaperrLr check_shapes$  rUc Ksj|}t|dkrtd|\\}}z ||WStk rdtd||dtt|dYnXdS)z *kwargs* must consist of a single *key, value* pair. If *key* is in *_mapping*, return ``_mapping[value]``; else, raise an appropriate ValueError. Examples -------- >>> _api.check_getitem({"foo": "bar"}, arg=arg) rz-check_getitem takes a single keyword argumentz9{!r} is not a valid value for {}; supported values are {}r*N)r5rr/KeyErrorr4r6r0r?)_mappingr8mappingr:r;rrr check_getitems   rYcsHjdkstddtDtdfdd}|S)a  Helper decorator for implementing module-level ``__getattr__`` as a class. This decorator must be used at the module toplevel as follows:: @caching_module_getattr class __getattr__: # The class *must* be named ``__getattr__``. @property # Only properties are taken into account. def name(self): ... The ``__getattr__`` class will be replaced by a ``__getattr__`` function such that trying to access ``name`` on the module will resolve the corresponding property (which may be decorated e.g. with ``_api.deprecated`` for deprecating module globals). The properties are all implicitly cached. Moreover, a suitable AttributeError is generated and raised if no property with the given name exists. __getattr__cSs i|]\}}t|tr||qSr)r-r!)r"nameproprrr s z*caching_module_getattr..Ncs0|kr|Stdjd|dS)Nzmodule z has no attribute )rAttributeErrorrr[clsrpropsrrrZs z+caching_module_getattr..__getattr__)rAssertionErrorvarsr/ functools lru_cache)rarZrr`rcaching_module_getattrs rgc sdkrtt|Sfdd}|D]|\}}d}dD]X}||tkr8d}|D]:}|||}|||_d|||_t|||qTq8|s(t d|q(d d } t d i} | | | |@} | rt d | | |_ S) aT Class decorator for defining property aliases. Use as :: @_api.define_aliases({"property": ["alias", ...], ...}) class C: ... For each property, if the corresponding ``get_property`` is defined in the class so far, an alias named ``get_alias`` will be defined; the same will be done for setters. If neither the getter nor the setter exists, an exception will be raised. The alias map is stored as the ``_alias_map`` attribute on the class and can be used by `.normalize_kwargs` (which assumes that higher priority aliases come last). Ncs ttfdd}|S)Ncst|||Sr)getattr)rargsr8r_rrmethodsz2define_aliases..make_alias..method)rewrapsrh)r[rjrar_r make_aliassz"define_aliases..make_aliasF)get_set_TzAlias for `{}`.z)Neither getter nor setter exists for {!r}cSs|dd|DS)Ncss|]}|D] }|Vq qdSrr)r"aliasesaliasrrrr%szBdefine_aliases..get_aliased_and_aliases..)r@)drrrget_aliased_and_aliasessz/define_aliases..get_aliased_and_aliases _alias_mapz2Parent class already defines conflicting aliases: ) repartialdefine_aliasesr/rdrr4r setattrrrhNotImplementedErrorrt) Zalias_drarmr\rpexistsprefixrqrjrsZpreexisting_aliases conflictingrrlrrvs8      rvc OsNt|D]@\}}z|||WStk rF|t|dkrBYqXqdS)a Select and call the function that accepts ``*args, **kwargs``. *funcs* is a list of functions which should not raise any exception (other than `TypeError` if the arguments passed do not match their signature). `select_matching_signature` tries to call each of the functions in *funcs* with ``*args, **kwargs`` (in the order in which they are given). Calls that fail with a `TypeError` are silently skipped. As soon as a call succeeds, `select_matching_signature` returns its return value. If no function accepts ``*args, **kwargs``, then the `TypeError` raised by the last failing call is re-raised. Callers should normally make sure that any ``*args, **kwargs`` can only bind a single *func* (to avoid any ambiguity), although this is not checked by `select_matching_signature`. Notes ----- `select_matching_signature` is intended to help implementing signature-overloaded functions. In general, such functions should be avoided, except for back-compatibility concerns. A typical use pattern is :: def my_func(*args, **kwargs): params = select_matching_signature( [lambda old1, old2: locals(), lambda new: locals()], *args, **kwargs) if "old1" in params: warn_deprecated(...) old1, old2 = params.values() # note that locals() is ordered. else: new, = params.values() # do things with params which allows *my_func* to be called either with two parameters (*old1* and *old2*) or a single one (*new*). Note that the new signature is given last, so that callers get a `TypeError` corresponding to the new signature if the arguments they passed in do not match any signature. rN) enumerater3r5)funcsrir8rHfuncrrrselect_matching_signatures ,rcCst|d|d|dS)zEGenerate a TypeError to be raised by function calls with wrong arity.z () takes z positional arguments but z were given)r3)r[Ztakesgivenrrr nargs_errorSsrcCs*t|tstt|}t|d|dS)aL Generate a TypeError to be raised by function calls with wrong kwarg. Parameters ---------- name : str The name of the calling function. kw : str or Iterable[str] Either the invalid keyword argument name, or an iterable yielding invalid keyword arguments (e.g., a ``kwargs`` dict). z'() got an unexpected keyword argument '')r-rIrJrQr3)r[kwrrr kwarg_errorYs  rccs&|V|D]}t|EdHqdS)z8Yield *cls* and direct and indirect subclasses of *cls*.N)__subclasses__recursive_subclasses)rasubclsrrrrjs rcCsXt}tdD]0}|dkr"qDtd|jdds<qD|j}q~t |||dS)a4 `warnings.warn` wrapper that sets *stacklevel* to "outside Matplotlib". The original emitter of the warning can be obtained by patching this function back to `warnings.warn`, i.e. ``_api.warn_external = warnings.warn`` (or ``functools.partial(warnings.warn, stacklevel=2)``, etc.). rNz-\A(matplotlib|mpl_toolkits)(\Z|\.(?!tests\.))r) sys _getframerRrTrematch f_globalsgetf_backwarningswarn)messagecategoryframe stacklevelrrr warn_externalqs  r)N)N)r rerRrrr deprecationrrrrrrr r r r r=rDrUrYrgrvrrrrrrrrrs$ ,&$!)# 74