B Jd:(@sdZddlZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z mZmZGdddZddZd d d d Zd dZddZddZddZdddZdS)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)selffgetrrdocrJ/var/www/html/venv/lib/python3.7/site-packages/matplotlib/_api/__init__.py__init__,s zclassproperty.__init__cCs ||S)N)r )rinstanceownerrrr__get__5szclassproperty.__get__cCs|jS)N)r )rrrrr8szclassproperty.fget)NNN)__name__ __module__ __qualname____doc__rrpropertyrrrrrr s r c s|}tdt|tr|fn"|dkr*fntfdd|D}fdd}x|D]\}}t||sVt||}d|kr|d|dtd|t |dkrd |dd d |d n|d |t|qVWdS) a5 For each *key, value* pair in *kwargs*, check that *value* is an instance of one of *_types*; if not, raise an appropriate TypeError. As a special case, a ``None`` entry in *_types* is treated as NoneType. Examples -------- >>> _api.check_isinstance((SomeClass, None), arg=arg) Nc3s|]}|dkrn|VqdS)Nr).0tp) 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 {}rz, z or r) type isinstancetupleitemsmapremoveappend TypeErrorformatlenjoin)_typeskwargstypesr'kvnamesr)r"rcheck_isinstanceAs"      0r:T)_print_supported_valuescKsZ|}xP|D]D\}}||kr|d|}|rJ|ddtt|7}t|qWdS)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) z is not a valid value for z; supported values are z, N)r,r3r-reprr)Z_valuesr;r5valueskeyvalmsgrrr check_in_listesrAc s|}x|D]\}}|j}t|t|ksDtddt||DrttdddtDd fdd|D}t |dt|d|d |jd qWd 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|]\}}||dgkVqdS)Nr)r tsrrrr#szcheck_shape..ZMNLIJKLHcss|]}d|VqdS)DNr)r irrrr#sz, c3s&|]}|dk rt|ntVqdS)N)strnext)r n) dim_labelsrrr#sz must be zD with shape (z). Your input has shape r&N) r,shaper2anyzipiter itertoolschaincountr3r)_shaper5Z target_shaper7r8Z data_shapeZ text_shaper)rIr check_shapes rRc Ksh|}t|dkrtd|\\}}y||Stk rbtd||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 {}z, N)r2rr,KeyErrorr1r3r-r<)_mappingr5mappingr7r8rrr check_getitems  rVcsHjdkstddtDtdfdd}|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 sz*caching_module_getattr..Ncs0|kr|Stdjd|dS)Nzmodule z has no attribute )rAttributeErrorr)rX)clsrpropsrrrWsz+caching_module_getattr..__getattr__)rAssertionErrorvarsr, functools lru_cache)r\rWr)r\rr]rcaching_module_getattrs rbc OsLxFt|D]:\}}y |||Stk rB|t|dkr>Yq Xq WdS)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) enumerater0r2)funcsargsr5rEfuncrrrselect_matching_signatures , rgcCsVt}x:tdD],}|dkr"Ptd|jdds:P|j}qWt |||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 _getframerNrPrematch f_globalsgetf_backwarningswarn)messagecategoryframe stacklevelrrr warn_externals  rv)N)rr`rNrkrirp deprecationrrrrrrr r r r r:rArRrVrbrgrvrrrr s,&$'#4