B ]t\$@s`ddlZddlZddlZGdddeZeZddddd Zdddd d Zdddd d ZdS)Nc@seZdZdZdS)MatplotlibDeprecationWarninga A class for issuing deprecation warnings for Matplotlib users. In light of the fact that Python builtin DeprecationWarnings are ignored by default as of Python 2.7 (see link below), this class was put in to allow for the signaling of deprecation, but via UserWarnings which are not ignored by default. https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x N)__name__ __module__ __qualname____doc__rr;lib/python3.7/site-packages/matplotlib/cbook/deprecation.pyrs rF attribute)removalc Cs|dkrddd|d}n|r6|r,tdd|}|srd|rDd nd |rNd ndd |r`d nd|rldnd}|t|||||||dS)Nr zin 3.1zin 3.2)z2.2z3.0ztwo minor releases laterz5A pending deprecation cannot have a scheduled removalzin {}zThe %(name)s %(obj_type)sz' will be deprecated in a future versionz' was deprecated in Matplotlib %(since)sz and will be removed %(removal)s.z Use %(alternative)s instead.z %(addendum)s)funcnameobj_typesincer alternativeaddendum)get ValueErrorformatdict)rmessagerrpendingrrr rrr_generate_deprecation_messages    8 rc Cs<dt||||||||d}|r$tnt}tj||dddS)a Used to display deprecation in a standard way. Parameters ---------- since : str The release at which this API became deprecated. message : str, optional Override the default deprecation message. The format specifier `%(name)s` may be used for the name of the function, and `%(alternative)s` may be used in the deprecation message to insert the name of an alternative to the deprecated function. `%(obj_type)s` may be used to insert a friendly name for the type of object being deprecated. name : str, optional The name of the deprecated object. alternative : str, optional An alternative API that the user may use in place of the deprecated API. The deprecation warning will tell the user about this alternative if provided. pending : bool, optional If True, uses a PendingDeprecationWarning instead of a DeprecationWarning. Cannot be used together with *removal*. removal : str, optional The expected removal version. With the default (an empty string), a removal version is automatically computed from *since*. Set to other Falsy values to not schedule a removal date. Cannot be used together with *pending*. obj_type : str, optional The object type being deprecated. addendum : str, optional Additional text appended directly to the final message. Examples -------- Basic example:: # To warn of the deprecation of "matplotlib.name_of_module" warn_deprecated('1.4.0', name='matplotlib.name_of_module', obj_type='module')  )r ) stacklevelN)rPendingDeprecationWarningrwarningswarn) rrrrrrrr categoryrrrwarn_deprecated6s 5 r!c s0|dk rtdd|||||ffdd }|S)a' Decorator to mark a function or a class as deprecated. Parameters ---------- since : str The release at which this API became deprecated. This is required. message : str, optional Override the default deprecation message. The format specifier `%(name)s` may be used for the name of the object, and `%(alternative)s` may be used in the deprecation message to insert the name of an alternative to the deprecated object. name : str, optional The name of the deprecated object; if not provided the name is automatically determined from the passed in object, though this is useful in the case of renamed functions, where the new function is just assigned to the name of the deprecated function. For example:: def new_function(): ... oldFunction = new_function alternative : str, optional An alternative API that the user may use in place of the deprecated API. The deprecation warning will tell the user about this alternative if provided. pending : bool, optional If True, uses a PendingDeprecationWarning instead of a DeprecationWarning. Cannot be used together with *removal*. removal : str, optional The expected removal version. With the default (an empty string), a removal version is automatically computed from *since*. Set to other Falsy values to not schedule a removal date. Cannot be used together with *pending*. addendum : str, optional Additional text appended directly to the final message. Examples -------- Basic example:: @deprecated('1.4.0') def the_function_to_deprecate(): pass Nz3.0zPassing 'obj_type' to the 'deprecated' decorator has no effect, and is deprecated since Matplotlib %(since)s; support for it will be removed %(removal)s.c s4|s j}ttr2d}j}jfdd}nttr|d}d|pNjj}j}Gfdddtfdd}n>d}ttrjj}fd d}nj}fd d}t |||||d |rt nt fd d } t |pdd}dd|} |s*| d7} || | S)Nclasscs|_|_S)N)r__init__)wrappernew_doc)objrrfinalizesz/deprecated..deprecate..finalizer cs@eZdZfddZfddZfddZZS)z;deprecated..deprecate.._deprecated_propertycs,|dk rddlm}|t||S)N)_warn_external)r r)super__get__)selfinstanceownerr)) __class__r rrrr+s  zCdeprecated..deprecate.._deprecated_property.__get__cs,|dk rddlm}|t||S)Nr()r))r r)r*__set__)r,r-valuer))r/r rrrr0s  zCdeprecated..deprecate.._deprecated_property.__set__cs*|dk rddlm}|t|S)Nr()r))r r)r* __delete__)r,r-r))r/r rrrr2s  zFdeprecated..deprecate.._deprecated_property.__delete__)rrrr+r0r2 __classcell__r)r r)r/r_deprecated_propertysr4csjjj|dS)N)fgetfsetfdeldoc)r5r6r7)_r%)r4r&rrr'sZfunctioncst|}||_t|S)N) functoolswrapsr classmethod)r$r%)r rrr'scst|}||_|S)N)r:r;r)r$r%)r rrr's)r cstjdd||S)Nr)r)rr)argskwargs)r r rrrr$sz.deprecated..deprecate..wrapperr rz, .. deprecated:: %(since)s %(message)s )rrz\ )r isinstancetyperr#propertyr5r<__func__rrrtextwrapdedentstrip) r&rrrrrrZold_docr'r$r%)r r)r4r r rr&r deprecatesF     zdeprecated..deprecate)r!) rrrrrrrr rFr)r rr deprecatedss 9UrG)r r r Fr r )r r r Fr r )r r r FNr ) r:rCr UserWarningrZmplDeprecationrr!rGrrrrs ;