U “jo@sdZddlmZddddddd gZdd lZdd lZdd lmZdd lm Z dd l m Z ddl m Z mZmZmZmZmZddlmamZddlmZmZddlmZedZedZdZddZde_de_ de_!ddZ"dCddZ#dDddZ$dEddZ%d d!Z&dFd"d#d$d%d&dZ'dGd"d#d$d%d'dZ(d(dZ)d)dZ*Gd*d+d+Z+Gd,d-d-Z,Gd.d/d/Z-d0d1Z.d2dZ/d3d4Z0d5d6Z1d7d8Z2d9d:Z3ed;edd?d@dAdBd Z5d S)Ia Deprecation framework for Twisted. To mark a method, function, or class as being deprecated do this:: from incremental import Version from twisted.python.deprecate import deprecated @deprecated(Version("Twisted", 22, 10, 0)) def badAPI(self, first, second): ''' Docstring for badAPI. ''' ... @deprecated(Version("Twisted", 22, 10, 0)) class BadClass: ''' Docstring for BadClass. ''' The newly-decorated badAPI will issue a warning when called, and BadClass will issue a warning when instantiated. Both will also have a deprecation notice appended to their docstring. To deprecate properties you can use:: from incremental import Version from twisted.python.deprecate import deprecatedProperty class OtherwiseUndeprecatedClass: @deprecatedProperty(Version("Twisted", 22, 10, 0)) def badProperty(self): ''' Docstring for badProperty. ''' @badProperty.setter def badProperty(self, value): ''' Setter sill also raise the deprecation warning. ''' While it's best to avoid this as it adds performance overhead to *any* usage of the module, to mark module-level attributes as being deprecated you can use:: badAttribute = "someValue" ... deprecatedModuleAttribute( Version("Twisted", 22, 10, 0), "Use goodAttribute instead.", "your.full.module.name", "badAttribute") The deprecated attributes will issue a warning whenever they are accessed. If the attributes being deprecated are in the same module as the L{deprecatedModuleAttribute} call is being made from, the C{__name__} global can be used as the C{moduleName} parameter. To mark an optional, keyword parameter of a function or method as deprecated without deprecating the function itself, you can use:: @deprecatedKeywordParameter(Version("Twisted", 22, 10, 0), "baz") def someFunction(foo, bar=0, baz=None): ... See also L{incremental.Version}. @type DEPRECATION_WARNING_FORMAT: C{str} @var DEPRECATION_WARNING_FORMAT: The default deprecation warning string format to use when one is not provided by the user. ) annotations deprecateddeprecatedPropertygetDeprecationWarningStringgetWarningMethodsetWarningMethoddeprecatedModuleAttributedeprecatedKeywordParameterN)findlinestartswraps) ModuleType)AnyCallableDictOptionalTypeVarcast)warn warn_explicit)VersiongetVersionString) ParamSpec_P_Rz&%(fqpn)s was deprecated in %(version)scCsnz |j}Wntk r$|j}YnXt|s:t|rN|j}|d|St|rj|jd|jS|S)z Return the fully qualified name of a module, class, method or function. Classes and functions need to be module level ones to be correctly qualified. @rtype: C{str}. .) __qualname__AttributeError__name__inspectisclass isfunction __module__ismethod)objname moduleNamer'} if L{None} is given. @type format: C{str} @param replacement: what should be used in place of C{fqpn}. Either pass in a string, which will be inserted into the warning message, or a callable, which will be expanded to its full import path. @type replacement: C{str} or callable @return: A textual description of the deprecation @rtype: C{str} N)fqpnr/z{}; {})DEPRECATION_WARNING_FORMATrformatr-)r2r/r4r, warningStringr'r'r(_getDeprecationWarningStringsr6cCstt||||S)ak Return a string indicating that the callable was deprecated in the given version. @type callableThing: C{callable} @param callableThing: Callable object to be deprecated @type version: L{incremental.Version} @param version: Version that C{callableThing} was deprecated in. @type format: C{str} @param format: A user-provided format to interpolate warning values into, or L{DEPRECATION_WARNING_FORMAT } if L{None} is given @param replacement: what should be used in place of the callable. Either pass in a string, which will be inserted into the warning message, or a callable, which will be expanded to its full import path. @type replacement: C{str} or callable @return: A string describing the deprecation. @rtype: C{str} )r6r))Z callableThingr/r4r,r'r'r(rs cCs|jr|j}ng}t|dkr.||n\t|dkrL|d|dgn>|d}d}|sh|}|d|||gdd|D}d||_dS) av Append the given text to the docstring of C{thingWithDoc}. If C{thingWithDoc} has no docstring, then the text just replaces the docstring. If it has a single-line docstring then it appends a blank line and the message text. If it has a multi-line docstring, then in appends a blank line a the message text, and also does the indentation correctly. rcSsg|]}|dqS) )lstrip).0lr'r'r( sz&_appendToDocstring.. N)__doc__ splitlineslenappendextendstrippopjoin)Z thingWithDocZ textToAppendZdocstringLinestrailerspacesr'r'r(_appendToDocstrings     rJrz"str | Callable[..., object] | Nonez.Callable[[Callable[_P, _R]], Callable[_P, _R]])r/r,returncsdddfdd }|S)a Return a decorator that marks callables as deprecated. To deprecate a property, see L{deprecatedProperty}. @type version: L{incremental.Version} @param version: The version in which the callable will be marked as having been deprecated. The decorated function will be annotated with this version, having it set as its C{deprecatedVersion} attribute. @param replacement: what should be used in place of the callable. Either pass in a string, which will be inserted into the warning message, or a callable, which will be expanded to its full import path. @type replacement: C{str} or callable zCallable[_P, _R])functionrKcsHtdtddddfdd }t|t|_|S)zA Decorator that marks C{function} as deprecated. Nz_P.argsz _P.kwargsr)argskwargsrKcsttdd||SN stacklevelrDeprecationWarningrMrNrLr5r'r(deprecatedFunction+szDdeprecated..deprecationDecorator..deprecatedFunction)rr rJr1deprecatedVersion)rLrWr,r/rVr(deprecationDecorator#sz(deprecated..deprecationDecoratorr'r/r,rZr'rYr(rscs$Gdddtfdd}|S)a Return a decorator that marks a property as deprecated. To deprecate a regular callable or class, see L{deprecated}. @type version: L{incremental.Version} @param version: The version in which the callable will be marked as having been deprecated. The decorated function will be annotated with this version, having it set as its C{deprecatedVersion} attribute. @param replacement: what should be used in place of the callable. Either pass in a string, which will be inserted into the warning message, or a callable, which will be expanded to its full import path. @type replacement: C{str} or callable @return: A new property with deprecated setter and getter. @rtype: C{property} @since: 16.1.0 c@s eZdZdZddZddZdS)z/deprecatedProperty.._DeprecatedPropertyzQ Extension of the build-in property to allow deprecated setters. cstfdd}|S)Ncstjtdd||SrO)rr5rTrUrLselfr'r(rWXs z^deprecatedProperty.._DeprecatedProperty._deprecatedWrapper..deprecatedFunctionr )r]rLrWr'r\r(_deprecatedWrapperWszBdeprecatedProperty.._DeprecatedProperty._deprecatedWrappercSst|||SN)propertysetterr^)r]rLr'r'r(racsz6deprecatedProperty.._DeprecatedProperty.setterN)rr"rr@r^rar'r'r'r(_DeprecatedPropertyRs rbcsLtdtfdd}t|t|_|}|_|S)Ncsttdd||SrOrSrUrVr'r(rWkszLdeprecatedProperty..deprecationDecorator..deprecatedFunction)rr rJr1rXr5)rLrWresultrbr,r/rVr(rZfs z0deprecatedProperty..deprecationDecorator)r`r[r'rdr(r9scCstS)zR Return the warning method currently used to record deprecation warnings. rr'r'r'r(r|scCs|adS)z Set the warning method to use to record deprecation warnings. The callable should take message, category and stacklevel. The return value is ignored. Nre)Z newMethodr'r'r(rsc@s(eZdZdZddZddZddZdS) _InternalStatez An L{_InternalState} is a helper object for a L{_ModuleProxy}, so that it can easily access its own attributes, bypassing its logic for delegating to another object that it's proxying for. @ivar proxy: a L{_ModuleProxy} cCst|d|dSNproxy)object __setattr__)r]rhr'r'r(__init__sz_InternalState.__init__cCstt|d|Srg)ri__getattribute__)r]r%r'r'r(rlsz_InternalState.__getattribute__cCstt|d||Srg)rirjrl)r]r%valuer'r'r(rjsz_InternalState.__setattr__N)rr"rr@rkrlrjr'r'r'r(rfsrfc@s6eZdZdZddZddddZdd Zd d Zd S) _ModuleProxya Python module wrapper to hook module-level attribute access. Access to deprecated attributes first checks L{_ModuleProxy._deprecatedAttributes}, if the attribute does not appear there then access falls through to L{_ModuleProxy._module}, the wrapped module object. @ivar _module: Module on which to hook attribute access. @type _module: C{module} @ivar _deprecatedAttributes: Mapping of attribute names to objects that retrieve the module attribute's original value. @type _deprecatedAttributes: C{dict} mapping C{str} to L{_DeprecatedAttribute} @ivar _lastWasPath: Heuristic guess as to whether warnings about this package should be ignored for the next call. If the last attribute access of this module was a C{getattr} of C{__path__}, we will assume that it was the import system doing it and we won't emit a warning for the next access, even if it is to a deprecated attribute. The CPython import system always tries to access C{__path__}, then the attribute itself, then the attribute itself again, in both successful and failed cases. @type _lastWasPath: C{bool} cCst|}||_i|_d|_dS)NF)rf_module_deprecatedAttributes _lastWasPath)r]modulestater'r'r(rksz_ModuleProxy.__init__str)rKcCs"t|}dt|jd|jdS)z Get a string containing the type of the module proxy and a representation of the wrapped module object. )rftyperro)r]rsr'r'r(__repr__sz_ModuleProxy.__repr__cCs t|}d|_t|j||dS)z@ Set an attribute on the wrapped module object. FN)rfrqsetattrro)r]r%rmrsr'r'r(rjsz_ModuleProxy.__setattr__cCsXt|}|jrd}n |j|}|dk r2|}n t|j|}|dkrNd|_nd|_|S)aG Get an attribute from the module object, possibly emitting a warning. If the specified name has been deprecated, then a warning is issued. (Unless certain obscure conditions are met; see L{_ModuleProxy._lastWasPath} for more information about what might quash such a warning.) N__path__TF)rfrqrpgetgetattrro)r]r%rsZdeprecatedAttributermr'r'r(rls    z_ModuleProxy.__getattribute__N)rr"rr@rkrxrjrlr'r'r'r(rns rnc@s eZdZdZddZddZdS)_DeprecatedAttributeaE Wrapper for deprecated attributes. This is intended to be used by L{_ModuleProxy}. Calling L{_DeprecatedAttribute.get} will issue a warning and retrieve the underlying attribute's value. @type module: C{module} @ivar module: The original module instance containing this attribute @type fqpn: C{str} @ivar fqpn: Fully qualified Python name for the deprecated attribute @type version: L{incremental.Version} @ivar version: Version that the attribute was deprecated in @type message: C{str} @ivar message: Deprecation message cCs,||_||_|jd||_||_||_dS)z7 Initialise a deprecated name wrapper. rN)rrrr2r/message)r]rrr%r/r~r'r'r(rks z_DeprecatedAttribute.__init__cCs:t|j|j}t|j|jtd|j}t|t dd|S)zU Get the underlying attribute value and issue a deprecation warning. z: rQ) r|rrrr6r2r/r3r~rrT)r]rcr~r'r'r(r{s z_DeprecatedAttribute.getN)rr"rr@rkr{r'r'r'r(r}s r}cCs2t|d}t||||}t|d}|||<dS)a Mark a module-level attribute as being deprecated. @type proxy: L{_ModuleProxy} @param proxy: The module proxy instance proxying the deprecated attributes @type name: C{str} @param name: Attribute name @type version: L{incremental.Version} @param version: Version that the attribute was deprecated in @type message: C{str} @param message: Deprecation message rorpN)rirlr})rhr%r/r~roattrrpr'r'r(_deprecateAttribute s  rcCs>tj|}t|ts,ttt|}|tj|<t||||dS)aE Declare a module-level attribute as being deprecated. @type version: L{incremental.Version} @param version: Version that the attribute was deprecated in @type message: C{str} @param message: Deprecation message @type moduleName: C{str} @param moduleName: Fully-qualified Python name of the module containing the deprecated attribute; if called from the same module as the attributes are being deprecated in, using the C{__name__} global can be helpful @type name: C{str} @param name: Attribute name to deprecate N)sysmodules isinstancernrr r)r/r~r&r%rrr'r'r(r8s    c CsLtj|j}t|tt|tddt|j D|j |j didddS)a Issue a warning string, identifying C{offender} as the responsible code. This function is used to deprecate some behavior of a function. It differs from L{warnings.warn} in that it is not limited to deprecating the behavior of a function currently on the call stack. @param offender: The function that is being deprecated. @param warningString: The string that should be emitted by this warning. @type warningString: C{str} @since: 11.0 css|]\}}|dk r|VqdSr_r')r<_Z lineNumberr'r'r( lsz$warnAboutFunction..__warningregistry__N)categoryfilenamelinenorrregistrymodule_globals) rrr"rrTr getabsfilemaxr __code__r __globals__ setdefault)Zoffenderr5ZoffenderModuler'r'r(warnAboutFunctionSs  rcCsi}t|jt|}|jdk r.i}||j<|dkrb|jdkrJtdn|t|jd||j<t|j|D]\}}|||<qn|D]H\}}||jkr||krtd|||<q|jdk r|||<qtdq|S)a Take an I{inspect.ArgSpec}, a tuple of positional arguments, and a dict of keyword arguments, and return a mapping of arguments that were actually passed to their passed values. @param argspec: The argument specification for the function to inspect. @type argspec: I{inspect.ArgSpec} @param positional: The positional arguments that were passed. @type positional: L{tuple} @param keyword: The keyword arguments that were passed. @type keyword: L{dict} @return: A dictionary mapping argument names (those declared in C{argspec}) to values that were passed explicitly by the user. @rtype: L{dict} mapping L{str} to L{object} NrToo many arguments.Already passed. no such param)rBrMkeywordsvarargs TypeErrorzipitems)Zargspec positionalkeywordrcZunpassedrNr%rmr'r'r(_passedArgSpecws&         rc Csxi}d}d}t|jD]\}\}}|jtjjkrV||d||<t||d}q|jtjjkrri}||<q|jtjj tjj fkr|t|kr||||<|d7}q|jtjj kr||kr|j tjj krtd|n |j ||<qtd|d|jqt||krtd|D]R\}} ||jkrT||krJtd| ||<n|dk rh| ||<ntd q |S) a Take an L{inspect.Signature}, a tuple of positional arguments, and a dict of keyword arguments, and return a mapping of arguments that were actually passed to their passed values. @param signature: The signature of the function to inspect. @type signature: L{inspect.Signature} @param positional: The positional arguments that were passed. @type positional: L{tuple} @param keyword: The keyword arguments that were passed. @type keyword: L{dict} @return: A dictionary mapping argument names (those declared in C{signature}) to values that were passed explicitly by the user. @rtype: L{dict} mapping L{str} to L{object} Nrr7zmissing keyword arg 'z' parameter is invalid kind: rrr) enumerate parametersrkindr ParameterVAR_POSITIONALrB VAR_KEYWORDPOSITIONAL_OR_KEYWORDPOSITIONAL_ONLY KEYWORD_ONLYdefaultemptyrkeys) signaturerrrcrNZ numPositionalnr%paramrmr'r'r(_passedSignaturesB         rcsfdd}|S)a Decorator which causes its decoratee to raise a L{TypeError} if two of the given arguments are passed at the same time. @param argumentPairs: pairs of argument identifiers, each pair indicating an argument that may not be passed in conjunction with another. @type argumentPairs: sequence of 2-sequences of L{str} @return: A decorator, used like so:: @_mutuallyExclusiveArguments([["tweedledum", "tweedledee"]]) def function(tweedledum=1, tweedledee=2): "Don't pass tweedledum and tweedledee at the same time." @rtype: 1-argument callable taking a callable and returning a callable. cs,tttfdd}|S)NcsJ||}D].\}}||kr||krtd||tfq||S)Nz5The %r and %r arguments to %s are mutually exclusive.)rr))rMrN argumentsthisthat)_passed argumentPairsspecwrappeer'r(wrappeds   z=_mutuallyExclusiveArguments..wrapper..wrapped)rrrr )rrr)rrrr(wrappers   z,_mutuallyExclusiveArguments..wrapperr')rrr'rr(_mutuallyExclusiveArgumentss r_Tc.)boundrtz Optional[str]zCallable[[_Tc], _Tc])r/r%r,rKcsdddfdd }|S)aw Return a decorator that marks a keyword parameter of a callable as deprecated. A warning will be emitted if a caller supplies a value for the parameter, whether the caller uses a keyword or positional syntax. @type version: L{incremental.Version} @param version: The version in which the parameter will be marked as having been deprecated. @type name: L{str} @param name: The name of the deprecated parameter. @type replacement: L{str} @param replacement: Optional text indicating what should be used in place of the deprecated parameter. @since: Twisted 21.2.0 r)rrKcstddtddt}rB|dt}|d7}tj}|kr|jtj j krt | fdd}nfd d}t tt|}t|||S) NzThe z parameter to r+z'The {!r} parameter was deprecated in {}r.rcs,t|ks|kr"ttdd||SrO)rBrrTrU)r%parameterIndexr5rr'r(checkDeprecatedParameter3szMdeprecatedKeywordParameter..wrapper..checkDeprecatedParametercs |krttdd||SrOrSrU)r%r5rr'r(r:s)r6r)r4rr-rrrrrrlistindexrrr rJ)rr0paramsrZ decoratedr%r,r/)rr5rr(rs.  z+deprecatedKeywordParameter..wrapperr')r/r%r,rr'rr(r s&)N)NN)NN)N)N)N)6r@ __future__r__all__rrdisr functoolsr typesr typingrrrrrrwarningsrr incrementalrrZtyping_extensionsrrrr3r)r"rrr-r1r6rrJrrrrrfrnr}rrrrrrrr r'r'r'r(s`M         # *C P/$*<&