g4dZddlZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z mZmZGddZdZdd d Zd Zd Zd ZddZdZdZdZdZddZdS)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_warningMatplotlibDeprecationWarningc6eZdZdZddZdZedZdS) 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" Ncd||_||td||_||_||_dS)Nz#classproperty only implements fget.)_fget ValueErrorfsetfdel_doc)selffgetrrdocs N/granary/edev/quantum/lib/python3.11/site-packages/matplotlib/_api/__init__.py__init__zclassproperty.__init__,s<  t/BCC C   c,||SNr)rinstanceowners r__get__zclassproperty.__get__5szz%   rc|jSrr)rs rrzclassproperty.fget8s zr)NNN)__name__ __module__ __qualname____doc__rr propertyrrrrrs\ !!!Xrrc p|}tdt|tr|fn|fntfd|D}fd}|D]\}}t||sgt ||}d|vr*|d|dtd|t|dkr)d |ddd z|dzn|d |t|dS) 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) Nc3$K|] }|n|V dSrr').0tp none_types r z#check_isinstance..Ps+CCr 99CCCCCCrcV|urdn"|jdkr|jn|jd|jS)NNonebuiltins.)r#r$)r+r,s r type_namez#check_isinstance..type_nameRs= //(* (C(CR__ 9999 ;rr/z({!r} must be an instance of {}, not a {}r, z or r) type isinstancetupleitemsmapremoveappend TypeErrorformatlenjoin)_typeskwargstypesr2kvnamesr,s @rcheck_isinstancerFAsq ET I#E400DeXX"]i\\ CCCCUCCC C C ;;;;;   ) )1!U## ),c)U++,E V$$$ V$$$:AA5zzA~~IIeCRCj))F2U2Y>>+08Id1gg&& (()) ) ) ) )rT)_print_supported_valuesc |std|}|D]O\}}||vrF|d|}|r.|ddtt|z }t |PdS)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 r3N)r<r8r?r9reprr)_valuesrGrAvalueskeyvalmsgs r check_in_listrOes, 1/000 FLLNN""S f  ;;c;;C& PO3tV;L;L1M1MOOOS// ! ""rc "|}|D]\}}|j}t|t|ks'tdt ||Drt t jddt jDd fd|D}t|dkr|dz }t|dt|d |d |jd 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) c3(K|] \}}||dfvVdSrr')r*tss rr-zcheck_shape..sC7 7 Aq!T"7 7 7 7 7 7 rMNLIJKLHc3 K|] }d|V dS)DNr')r*is rr-zcheck_shape..s(44QQ444444rr3c3XK|]$}|t|ntV%dSr)strnext)r*n dim_labelss rr-zcheck_shape..sS$;$;)*()}%(FFF)-j)9)9$;$;$;$;$;$;rr,z must be zD with shape (z). Your input has shape r1N) r8shaper>anyzipiter itertoolschaincountr?r)_shaperA target_shaperCrD data_shape text_shaper\s @r check_shaperist L 1W |  J / /37 7  j997 7 7 4 4 /io44)/"3"34446677J$;$;$;$;.:$;$;$;<>> _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 {}r3N)r>rr8KeyErrorr=r?r9rI)_mappingrAmappingrCrDs r check_getitemrnsG 6{{aHIIIllnnGFQDqz DDD G VAq$))Cg$6$677 8 8::?C DDs AABcjdksJdtDtjdfd}|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__cDi|]\}}t|t||Sr')r6r&)r*nameprops r z*caching_module_getattr..s< , , ,JD$4** ,T4 , , ,rNcv|vr|Stdjd|)Nzmodule z has no attribute )r AttributeErrorr#)rrclsrpropss rrpz+caching_module_getattr..__getattr__sN 5==;&&x00 0 Bcn B B$ B BDD Dr)r"varsr8 functools lru_cache)rwrprrxs` @@rcaching_module_getattrr|s& <= ( ( ( ( , ,$s))//*;*; , , ,EsuuHDDDDDDD rc0tjt|Sfd}|D]\}}d}dD]f}||zt vrPd}|D]K}|||z}||z|_d||z|_t||z|Lg|s"td|d} td i} | | | |z} | rtd | i| |_ 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). Ncdtjtfd}|S)Nc0t||i|Sr)getattr)rargsrArrs rmethodz2define_aliases..make_alias..methods"&74&&777 7r)rzwrapsr)rrrrws` r make_aliasz"define_aliases..make_aliassA d++ , , 8 8 8 8 - , 8 rF)get_set_TzAlias for `{}`.z)Neither getter nor setter exists for {!r}cFh|d|DS)Nc3$K|] }|D]}|V dSrr')r*aliasesaliass rr-zBdefine_aliases..get_aliased_and_aliases..s/KK7KK%eKKKKKKKr)rK)ds rget_aliased_and_aliasesz/define_aliases..get_aliased_and_aliasess)LLKK188::KKKLLr _alias_mapz2Parent class already defines conflicting aliases: ) rzpartialdefine_aliasesr8ryr"r=r%setattrrrNotImplementedErrorr) alias_drwrrsrexistsprefixrrrpreexisting_aliases conflictings ` rrrs$ { 999 ! J J g& 9 9F}S ))$99E'Z 66F&,unFO%6%=%=ftm%L%LFNC%8888 J;BB4HHJJ J JMMM"#|R88**+>??,,W556KP! N N NPP P7+7w7CN Jrct|D]6\}} ||i|cS#t$r|t|dz krY3wxYwdS)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) enumerater<r>)funcsrrArWfuncs rselect_matching_signaturersXU##4 4((( ( ( (   CJJN""#" s !AAc2t|d|d|dS)zEGenerate a TypeError to be raised by function calls with wrong arity.z () takes z positional arguments but z were given)r<)rrtakesgivens r nargs_errorrSs> ++u+++++ , ,,rct|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 '')r6rYrZrar<)rrkws r kwarg_errorrYsF b#   $r((^^ JJRJJJ K KKrc#jK|V|D]}t|Ed{VdS)z8Yield *cls* and direct and indirect subclasses of *cls*.N)__subclasses__recursive_subclasses)rwsubclss rrrjsW III$$&&00'//////////00rctj}tjdD]=}|n8t jd|jddsn|j}>tj |||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 _getframerbrdrematch f_globalsgetf_backwarningswarn)messagecategoryframe stacklevels r warn_externalrqs MOOEoa(( = ExH++J;;==  E  M'8Z00000rr)r%rzrbrrr deprecationrrrrrr r r r rrFrOrirnr|rrrrrrr'rrrs   """"""""""""""""""""""L!)!)!)H7;"""""B&&&RDDD,   F4444n111h,,, LLL"000111111r