֛hoSrSSKJr /SQrSSKrSSKrSSKJr SSKJ r SSK J r SSK J r JrJrJrJrJr SS KJqJr SS KJrJr SS KJr \"S 5r\"S 5rSrSrS\lS\l S\l!Sr"S+Sjr#S,Sjr$S,Sjr%Sr&S+S-Sjjr'S+S-Sjjr(Sr)Sr*"SS5r+"SS5r,"SS 5r-S!r.S"r/S#r0S$r1S%r2S&r3\"S'\S(\ 4S)9r4S+S.S*jjr5g)/a 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)scVURn[R"U5(d[R "U5(aUR nUSU3$[R"U5(aUR SUR3$U$![a URnNf=f)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 moduleNames \C:\Users\psant\Downloads\Noiseback\school\venv\Lib\site-packages\twisted/python/deprecate.py_fullyQualifiedNamer*tssw11#66^^ Qtf%%   #  ..!3#3#3"455 K ||s BB('B(ztwisted.python.reflectfullyQualifiedNamecD[U5(a [U5nSUS3$)z Surround a replacement for a deprecated API with some polite text exhorting the user to consider it as an alternative. @type replacement: C{str} or callable @return: a string like "please use twisted.python.modules.getModule instead". z please use z instead)callabler* replacements r)_getReplacementStringr0s( )+6  X ..cVS[U53nU(aUS[U53nUS-$)ax Generate an addition to a deprecated object's docstring that explains its deprecation. @param version: the version it was deprecated. @type version: L{incremental.Version} @param replacement: The replacement, if specified. @type replacement: C{str} or callable @return: a string like "Deprecated in Twisted 27.2.0; please use twisted.timestream.tachyon.flux instead." zDeprecated in ; r)rr0)versionr/docs r)_getDeprecationDocstringr6s; +G45 6CR-k:;< 9r1c|Uc[nX [U5S.-nU(aSRU[U55nU$)a Return a string indicating that the Python name was deprecated in the given version. @param fqpn: Fully qualified Python name of the thing being deprecated @type fqpn: C{str} @param version: Version that C{fqpn} was deprecated in. @type version: L{incremental.Version} @param format: A user-provided format to interpolate warning values into, or L{DEPRECATION_WARNING_FORMAT } 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} )fqpnr4z{}; {})DEPRECATION_WARNING_FORMATrformatr0)r8r4r:r/ warningStrings r)_getDeprecationWarningStringr<sE2~+7G7PQQM  0=  r1c.[[U5XU5$)a# 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} )r<r*) callableThingr4r:r/s r)rrs2 (M*G[ r1cUR(aURR5nO/n[U5S:XaURU5 O[U5S:XaUR SUS/5 ObUSnSnUR 5(dUR 5nUR SXA-U/5 UVs/sHoURS5PM nnSRU5Ulgs snf)a^ 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. r  N) __doc__ splitlineslenappendextendstrippoplstripjoin) thingWithDoc textToAppenddocstringLinestrailerspacesls r)_appendToDocstringrTs%--88: >al+ ^  !r<45 $}}#'')Fr6#8&AB1?@A((3-@99^4LAs:C-c^^SUU4SjjnU$)ag 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 c>^^[TTST5m[T5SUU4Sjj5n[U[TT55 TUlU$)z1 Decorator that marks C{function} as deprecated. Nc2>[T[SS9 T"U0UD6$N stacklevelrDeprecationWarningargskwargsfunctionr;s r)deprecatedFunctionDdeprecated..deprecationDecorator..deprecatedFunction+  2q AT,V, ,r1)r_z_P.argsr`z _P.kwargsreturnr)rr rTr6deprecatedVersion)rarbr;r/r4s` @r)deprecationDecorator(deprecated..deprecationDecorator#sX4 gt[  x -  -   8+ N 07,!!r1)raCallable[_P, _R]reri)r4r/rgs`` r)rrs&""& r1c:^^^"SS[5mUUU4SjnU$)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$\rSrSrSrSrSrSrg)/deprecatedProperty.._DeprecatedPropertyiRzA Extension of the build-in property to allow deprecated setters. c4^^[T5UU4Sj5nU$)NcF>[TR[SS9 T"U0UD6$rX)rr;r])r_r`raselfs r)rb^deprecatedProperty.._DeprecatedProperty._deprecatedWrapper..deprecatedFunctionXs,&&&   000r1r )rprarbs`` r)_deprecatedWrapperBdeprecatedProperty.._DeprecatedProperty._deprecatedWrapperWs! 8_ 1 1& %r1cJ[RXRU55$N)propertysetterrr)rpras r)rw6deprecatedProperty.._DeprecatedProperty.settercs??4)@)@)JK Kr1rjN)r r$r__firstlineno__rErrrw__static_attributes__rjr1r)_DeprecatedPropertyrmRs  & Lr1r{c>^^[TTST5m[T5UU4Sj5n[U[TT55 TUlT"U5nTUlU$)Nc2>[T[SS9 T"U0UD6$rXr\r^s r)rbLdeprecatedProperty..deprecationDecorator..deprecatedFunctionkrdr1)rr rTr6rfr;)rarbresultr;r{r/r4s` @r)rg0deprecatedProperty..deprecationDecoratorfsh3 gt[  x -  -   8+ N 07,$%78, r1)rv)r4r/rgr{s`` @r)rr9s2LhL(& r1c[$)zJ Return the warning method currently used to record deprecation warnings. rrjr1r)rr|s  Kr1cUqg)z Set the warning method to use to record deprecation warnings. The callable should take message, category and stacklevel. The return value is ignored. Nr) newMethods r)rrs  Dr1c*\rSrSrSrSrSrSrSrg)_InternalStateiz 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} c2[RUSU5 gNproxy)object __setattr__)rprs r)__init___InternalState.__init__s4%0r1cV[R[RUS5U5$r)r__getattribute__)rpr's r)r_InternalState.__getattribute__s"&&v'>'>tW'MtTTr1cV[R[RUS5X5$r)rrr)rpr'values r)r_InternalState.__setattr__s"!!&"9"9$"H$VVr1rjN) r r$rryrErrrrzrjr1r)rrs1UWr1rc4\rSrSrSrSrS SjrSrSrSr g) _ModuleProxyiaX 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} cB[U5nXl0UlSUlg)NF)r_module_deprecatedAttributes _lastWasPath)rpmodulestates r)r_ModuleProxy.__init__s!t$ &(#"r1cf[U5nS[U5RSUR<S3$)zi Get a string containing the type of the module proxy and a representation of the wrapped module object. )rtyper r)rprs r)__repr___ModuleProxy.__repr__s3 t$4:&&'x /@BBr1cT[U5nSUl[URX5 g)z0 Set an attribute on the wrapped module object. FN)rrsetattrr)rpr'rrs r)r_ModuleProxy.__setattr__s$t$" t+r1c[U5nUR(aSnOURRU5nUbUR5nO[ UR U5nUS:Xa SUlU$SUlU$)a 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)rrrgetgetattrr)rpr'rdeprecatedAttributers r)r_ModuleProxy.__getattribute__st$   "& "'"="="A"A$"G   *(++-EEMM40E : !%E  "'E  r1rjN)restr) r r$rryrErrrrrzrjr1r)rrs6# C,r1rc$\rSrSrSrSrSrSrg)_DeprecatedAttributeia 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 cbXlX lURS-U-UlX0lX@lg)z' Initialise a deprecated name wrapper. rN)rr r8r4message)rprr'r4rs r)r_DeprecatedAttribute.__init__s-  OOc)D0   r1c[URUR5n[URUR [ S-UR-5n[U[SS9 U$)zE Get the underlying attribute value and issue a deprecation warning. z: rZ) rrr r<r8r4r9rrr])rprrs r)r_DeprecatedAttribute.getsTdmm4. IIt||%?$%F%U  W(Q7 r1)r r8rrr4N)r r$rryrErrrzrjr1r)rrs( r1rc|[RUS5n[XAX#5n[RUS5nXVU'g)al 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 rrN)rrr)rr'r4rrattrrs r)_deprecateAttributer s@ %%eY7G w @D#33E;RS"&$r1c[RUn[U[5(d,[ [ [U55nU[RU'[ XCX5 g)a 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 isinstancerrrr)r4rr(r'rs r)r r 8sH&[[ $F fl + +j,v"67"( Jg7r1c [RURn[U[[ R "U5[S[UR555URURRS05SS9 g)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 c34# UHupUcM Uv M g7frurj).0_ lineNumbers r) $warnAboutFunction..ls !B  J!Bs  __warningregistry__N)categoryfilenamelinenorregistrymodule_globals) rrr$rr]r! getabsfilemaxr __code__r __globals__ setdefault)offenderr;offenderModules r)warnAboutFunctionrSsy([[!4!45N###N3 !/0A0A!B  &&%%001FK r1c0n[UR5[U5- nURb0=oSUR'US:a<URc [ S5eU[UR5SX0R'[ URU5H upgXsU'M UR 5HGupgX`R;aXc;a [ S5eXsU'M*URbUWU'M>[ S5e U$)ax 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)rGr_keywordsvarargs TypeErrorzipitems)argspec positionalkeywordrunpassedr`r'rs r)_passedArgSpecrws&!#F7<< 3z?2H#,..(()!| ?? "12 2&0W\\1B1D&EF?? #7<<4 t 5}}  << ~ 122 4L    ) F4LO, ,' Mr1c"0nSnSn[URR55GHhunupxUR[R R :XaXSX7'[X75S-nMIUR[R R:Xa0=oCU'MyUR[R R[R R4;aU[U5:a XX7'US- nMMUR[R R:XaOXr;aGUR[R R:Xa[SU35eURX7'GMMGMP[SUSUR35e [U5U:a [S5eUR5HJupyXpRR5;aXs;a [S5eXU'M8UbXU'MA[S 5e U$) at 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} Nrr@zmissing keyword arg 'z' parameter is invalid kind: rrr) enumerate parametersrkindr! ParameterVAR_POSITIONALrG VAR_KEYWORDPOSITIONAL_OR_KEYWORDPOSITIONAL_ONLY KEYWORD_ONLYdefaultemptyrkeys) signaturerrrr` numPositionalnr'paramrs r)_passedSignaturers&F FM%i&:&:&@&@&BC=D ::**99 9%b>FL -1M ZZ7,,88 8$& &FD\ ZZ    3 3    - -  3z?")} " #ZZ7,,99 9"==G$5$5$;$;;#&:4&$ABB#(==FL # av%B5::,OP P-D0 :&-..}}  '',,. .~ 122 4L   4LO, ,' Mr1c^U4SjnU$)ak 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. ct>^^^[R"T5m[m[T5UUUU4Sj5nU$)Nc >T"TX5nTH2up4X2;dM XB;dM[SU<SU<S[T5<S35e T"U0UD6$)NThe z and z arguments to z are mutually exclusive.)rr*) r_r` argumentsthisthat_passed argumentPairsspecwrappees r)wrapped=_mutuallyExclusiveArguments..wrapper..wrappedsXd3I+ $):#':7'CE, D+F+ +r1)r!rrr )rrrrrs` @@r)wrapper,_mutuallyExclusiveArguments..wrappers5  )" w ,  ,r1rj)rrs` r)_mutuallyExclusiveArgumentsrs$" Nr1_Tc.)boundc ^^^SUUU4SjjnU$)a? 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 c>^^^[ST<S[T53T TS9mSRT[T 55nT(aUS-[ T5-nUS- n[ R "T5RnTU;aOUTR[ RR:Xa$[U5RT5mUUUU4SjnOUUU4Sjn[[[T5"U55n[!XA5 U$) Nrz parameter to r.z'The {!r} parameter was deprecated in {}r3rc\>[U5T:dTU;a[T[SS9 T"U0UD6$rX)rGrr])r_r`r'parameterIndexr;rs r)checkDeprecatedParameterMdeprecatedKeywordParameter..wrapper..checkDeprecatedParameter3s2t9~-(:qI///r1c>>TU;a[T[SS9 T"U0UD6$rXr\)r_r`r'r;rs r)rr :s'6>(:qI///r1)r<r*r:rr0r!rrrrrlistindexrrr rT) rr5paramsr decoratedrr;r'r/r4s ` @@r)r+deprecatedKeywordParameter..wrappers44(.)>  W %  *4[AAC s ""7+66 FNt !!W%6%6%L%LL!&\//5N 0 0 0 eGn-EFG 9*r1)rrrerrj)r4r'r/rs``` r)r r s.$$L Nr1ru)NN)r4rr/z"str | Callable[..., object] | Nonerez.Callable[[Callable[_P, _R]], Callable[_P, _R]])r4rr'rr/z Optional[str]rezCallable[[_Tc], _Tc])6rE __future__r__all__r!rdisr functoolsr typesrtypingrrrrrrwarningsrr incrementalrrtyping_extensionsrrrr9r*r$r rr0r6r<rrTrrrrrrrrr rrrrrr rjr1r)rsl LZ#  ??(1't_ T]E,":3#7  /( F<5<IM& & #E& 3& TIM@ @ #E@ 3@ FWW&MM`,,^'086!H'T9x#Le8CH-.?C= ==.;==r1