o b(@sdZddlZddlZddlZddlZddlmZddlmZmZzddl m Z Wn e y3dZ Ynwddl m Z ddlmZddlmZmZmZmZmZmZmZmZmZmZmZmZdd lmZdd l m!Z!dd l"m#Z#dd l$m%Z%dd l&m'Z'GdddZ(Gddde'Z)Gddde'Z*Gddde%e'Z+Gddde'Z,ddZ-ddZ.Gddde'Z/ee ddd d!Gd"d#d#Z0Gd$d%d%Z1ee dd&d dd'd2d(d)Z2Gd*d+d+e'Z3Gd,d-d-e'Z4Gd.d/d/e'Z5Gd0d1d1e'Z6dS)3zI Tests for Twisted's deprecation framework, L{twisted.python.deprecate}. N)normcase)catch_warnings simplefilter)invalidate_caches)Version) deprecate) DEPRECATION_WARNING_FORMAT_appendToDocstring_fullyQualifiedName_getDeprecationDocstring_getDeprecationWarningString_mutuallyExclusiveArguments_passedArgSpec_passedSignature deprecateddeprecatedKeywordParameterdeprecatedPropertygetDeprecationWarningString)FilePath)platform)deprecatedattributes)TwistedModulesMixin)SynchronousTestCasec@ eZdZdZddZddZdS)_MockDeprecatedAttributezq Mock of L{twisted.python.deprecate._DeprecatedAttribute}. @ivar value: The value of the attribute. cC ||_dSNvalueselfrr!D/usr/lib/python3/dist-packages/twisted/python/test/test_deprecate.py__init__8 z!_MockDeprecatedAttribute.__init__cC|jS)z$ Get a known value. rr r!r!r"get;sz_MockDeprecatedAttribute.getN)__name__ __module__ __qualname____doc__r#r'r!r!r!r"r1s rc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)ModuleProxyTestsz Tests for L{twisted.python.deprecate._ModuleProxy}, which proxies access to module-level attributes, intercepting access to deprecated attributes and passing through access to normal attributes. cKs2td}|D] \}}t|||q t|S)z Create a temporary module proxy object. @param **kw: Attributes to initialise on the temporary module object @rtype: L{twistd.python.deprecate._ModuleProxy} foo)types ModuleTypeitemssetattrr _ModuleProxy)r attrsmodkeyrr!r!r" _makeProxyIs  zModuleProxyTests._makeProxycCs.|jdd}||jd|tt|ddS)z Getting a normal attribute on a L{twisted.python.deprecate._ModuleProxy} retrieves the underlying attribute's value, and raises C{AttributeError} if a non-existent attribute is accessed. hello)SOME_ATTRIBUTEDOES_NOT_EXISTN)r6assertIsr8 assertRaisesAttributeErrorgetattrr proxyr!r!r"test_getattrPassthroughVs z(ModuleProxyTests.test_getattrPassthroughcCs2|}t|d}td|d<||jddS)z Getting an attribute marked as being deprecated on L{twisted.python.deprecate._ModuleProxy} results in calling the deprecated wrapper's C{get} method. _deprecatedAttributes*r-N)r6object__getattribute__r assertEqualr-)r r?rAr!r!r"test_getattrIntercept`s  z&ModuleProxyTests.test_getattrInterceptcCs,|}|tt|d|tt|ddS)z Private attributes of L{twisted.python.deprecate._ModuleProxy} are inaccessible when regular attribute access is used. _modulerAN)r6r;r<r=r>r!r!r"test_privateAttributesksz'ModuleProxyTests.test_privateAttributescCs4|}d|_|t|dd||jddS)z Setting attributes on L{twisted.python.deprecate._ModuleProxy} proxies them through to the wrapped module. rGN)r6rGassertNotEqualrCrDrEr>r!r!r" test_setattrtszModuleProxyTests.test_setattrcCs<|}t|d}|t|dt|jd|ddS)z L{twisted.python.deprecated._ModuleProxy.__repr__} produces a string containing the proxy type and a representation of the wrapped module object. rGN)r6rCrDrEreprtyper()r r? realModuler!r!r" test_repr~s (zModuleProxyTests.test_reprN) r(r)r*r+r6r@rFrHrKrQr!r!r!r"r,Bs    r,c@s8eZdZdZddZddZddZdd Zd d Zd S) DeprecatedAttributeTestsz Tests for L{twisted.python.deprecate._DeprecatedAttribute} and L{twisted.python.deprecate.deprecatedModuleAttribute}, which issue warnings for deprecated module-level attributes. cCstj|_tj|_td|_dS)Nz.foo)rversionmessager(_testModuleNamer&r!r!r"setUpszDeprecatedAttributeTests.setUpcCs"ttjd|tjtdtjS)zJ Create the warning string used by deprecated attributes. .z: )r rr(rSrrT)r attrr!r!r"_getWarningStrings   z*DeprecatedAttributeTests._getWarningStringcsd}tt|dtt||j|j|j|fdd}|||j g}| |ddt ||dd| ||t |dd S) z L{twisted.python.deprecate._DeprecatedAttribute} correctly sets its __name__ to match that of the deprecated attribute and emits a warning when the original attribute value is accessed. ANOTHER_DEPRECATED_ATTRIBUTErBcs dSr)r'r!rXr!r" addStackLevels zNDeprecatedAttributeTests.test_deprecatedAttributeHelper..addStackLevelrcategoryrTrIN)r1rr_DeprecatedAttributerSrTrEr( flushWarningstest_deprecatedAttributeHelperr:DeprecationWarningrYlen)r namer\ warningsShownr!r[r"r`s   z7DeprecatedAttributeTests.test_deprecatedAttributeHelpercCstj||jg}|t|dd}tt|||jg}|t|d||ddt||dd| |dS)a L{twisted.python.deprecate.deprecatedModuleAttribute} wraps a module-level attribute in an object that emits a deprecation warning when it is accessed the first time only, while leaving other unrelated attributes alone. rDEPRECATED_ATTRIBUTErIr]rTN) rANOTHER_ATTRIBUTEr_test_deprecatedAttributerErbr=r:rarY)r rdrcr!r!r"rgs z1DeprecatedAttributeTests.test_deprecatedAttributecCstdtj|j<}|tjj|jt|ddt|ddt t ddddd |jdtj|j}| ||t t ddddd |jd| |tj|jd S) z Deprecating an attribute in a module replaces and wraps that module instance, in C{sys.modules}, with a L{twisted.python.deprecate._ModuleProxy} instance but only if it hasn't already been wrapped. r-firstrIsecondTwistedrrTN) r.r/sysmodulesrU addCleanuppopr1rdeprecatedModuleAttributerrJr:)r r4r?r!r!r"test_wrappedModules    z+DeprecatedAttributeTests.test_wrappedModuleN) r(r)r*r+rVrYr`rgrrr!r!r!r"rRs  rRc@s<eZdZdZdZddZddZddZd d Zd d Z d S)ImportedModuleAttributeTestsza Tests for L{deprecatedModuleAttribute} which involve loading a module via 'import'. zfrom twisted.python.deprecate import deprecatedModuleAttribute from incremental import Version deprecatedModuleAttribute( Version('Package', 1, 2, 3), 'message', __name__, 'module') cs^fddt|d}|||}||jdgtj|tj |S)a_ Create some files in a hierarchy, based on a dictionary describing those files. The resulting hierarchy will be placed onto sys.path for the duration of the test. @param tree: A dictionary representing a directory structure. Keys are strings, representing filenames, dictionary values represent directories, string values represent file contents. @return: another dictionary similar to the input, with file content strings replaced with L{FilePath} objects pointing at where those contents are now stored. csji}|D],\}}||}t|tr|||<||qt|tr/|||||<qtd|S)Nz(only strings and dicts allowed as values)r0child isinstancebytes setContentdictcreateDirectory ValueError)pathobjdirdictpathdictr5rrt makeSomeFilesr!r"rs    zAImportedModuleAttributeTests.pathEntryTree..makeSomeFilesutf-8) rmktempencodemakedirsreplaceSysPathpathdecodermreplaceSysModulesrncopy)r treebaseresultr!r~r" pathEntryTrees  z*ImportedModuleAttributeTests.pathEntryTreecCs(|d|jdddi}|ddS)z Add a sample module and package to the path, returning a L{FilePath} pointing at the module which will be loadable as C{package.module}. spackager)s __init__.py module.pyr)r _packageInitr)r pathsr!r!r"simpleModuleEntrys  z.ImportedModuleAttributeTests.simpleModuleEntrycCsnddlm}|t|jd|||jg}|t|d||ddd||ddt dS) zB Verification logic for L{test_deprecatedModule}. rmodulerrIrTz7package.module was deprecated in Package 1.2.3: messager]N) packagerrEr__file__rr_checkOneWarningrbra)r modulePathremittedr!r!r"r.s  z,ImportedModuleAttributeTests.checkOneWarningcCs||dS)z If L{deprecatedModuleAttribute} is used to deprecate a module attribute of a package, only one deprecation warning is emitted when the deprecated module is imported. N)rrr&r!r!r"test_deprecatedModule=sz2ImportedModuleAttributeTests.test_deprecatedModulecCs8|}||||tdD]}||qdS)z If L{deprecatedModuleAttribute} is used to deprecate a module attribute of a package, only one deprecation warning is emitted when the deprecated module is subsequently imported. rjN)rrrange)r mpxr!r!r""test_deprecatedModuleMultipleTimesEs     z?ImportedModuleAttributeTests.test_deprecatedModuleMultipleTimesN) r(r)r*r+rrrrrrr!r!r!r"rss& rsc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS)WarnAboutFunctionTestsz Tests for L{twisted.python.deprecate.warnAboutFunction} which allows the callers of a function to issue a C{DeprecationWarning} about that function. cst|d|_|j|jdd|jdd|jdd|jj}tj d|| tjj |tj | fd d trW|d Sd S) zY Create a file that will have known line numbers when emitting warnings. twisted_private_helperz __init__.pyrz module.pys "A module string" from twisted.python import deprecate def testFunction(): "A doc string" a = 1 + 2 return a def callTestFunction(): b = testFunction() if b == 3: deprecate.warnAboutFunction(testFunction, "A Warning String") z pep626.pysQ "A module string" from twisted.python import deprecate def noop(): pass def testFunction(a=1, b=1): "A doc string" if a: if b: noop() else: pass def callTestFunction(): b = testFunction() if b is None: deprecate.warnAboutFunction(testFunction, "A Warning String") rcstjtjfSr)rmrnclearupdater!rnr!r"sz.WarnAboutFunctionTests.setUp..N)rrrtrrrwparentrrminsertroremovernrr isWindowsr_)r packagePathr!rr"rV`s"      zWarnAboutFunctionTests.setUpcCsndd}t|d|}t}|dr|dd}|t|ddt|||dd ddS) z L{deprecate.warnAboutFunction} emits a warning the file and line number of which point to the beginning of the implementation of the function passed to it. cSdSrr!r!r!r!r"aFuncz2WarnAboutFunctionTests.test_warning..aFunczA Warning Messagez.pycNrfilenamerT) rwarnAboutFunctionr_rlowerendswithassertSamePathrrE)r rrdrr!r!r" test_warnings  z#WarnAboutFunctionTests.test_warningcCddlm}||}|t|ddd|jd d| |ddd| |dd d | t |d d S) z L{deprecate.warnAboutFunction} emits a C{DeprecationWarning} with the number of a line within the implementation of the function passed to it. rrrrtwisted_private_helperrlineno rTA Warning StringrIN) rrcallTestFunctionr_rrrrsiblingrtrErbr rrdr!r!r"test_warningLineNumbers z-WarnAboutFunctionTests.test_warningLineNumbercCr) z L{deprecate.warnAboutFunction} emits a C{DeprecationWarning} with the number of a line within the implementation handling the case in which dis.findlinestarts returns the lines in random order. r)pep626rrrs pep626.pyrrTrrIN) rrrr_rrrrrrtrErb)r rrdr!r!r"'test_warningLineNumberDisFindlinestartss z>WarnAboutFunctionTests.test_warningLineNumberDisFindlinestartscCs*|t|jt|jk|d|dS)a Assert that the two paths are the same, considering case normalization appropriate for the current platform. @type first: L{FilePath} @type second: L{FilePath} @raise C{self.failureType}: If the paths are not the same. z != N) assertTruerr)r rhrir!r!r"rs  z%WarnAboutFunctionTests.assertSamePathcCsddlm}tjd=tj|j=|j|jdtrtddl m}| tjj d| tjj |j| | |jg}t|ddd}|jdd}|||||dd d ||dd d |t|d dS)a  Even if the implementation of a deprecated function is moved around on the filesystem, the line number in the warning emitted by L{deprecate.warnAboutFunction} points to a line in the implementation of the deprecated function. rrrstwisted_renamed_helpertwisted_renamed_helperrrrrrrTrrIN)rrrmrnr(rmoveTorrrrorprr_ testFunctionrrrtrrErb)r rrd warnedPath expectedPathr!r!r"test_renamedFiles&     z'WarnAboutFunctionTests.test_renamedFilecCsJtjdd=tjdddddlm}||}|t|ddS)z L{deprecate.warnAboutFunction} emits a warning that will be filtered if L{warnings.filterwarning} is called with the module name of the deprecated function. Nignoreractionrrr) warningsfiltersfilterwarningsrrrr_rErbrr!r!r"test_filteredWarning s  z+WarnAboutFunctionTests.test_filteredWarningcCstjdd=tjdddddlm}|||}|t|d|dd}|dd }|dd }|dd }t ||||}| | d d |dS)z L{deprecate.warnAboutFunction} emits a warning that will be filtered once if L{warnings.filterwarning} is called with the module name of the deprecated function and an action of once. NrrrrrrIrTr]rrz=module.py:9: DeprecationWarning: A Warning String return a zUnexpected warning string: ) rrrrrrr_rErb formatwarningrr)r rrdrTr]rrmsgr!r!r"test_filteredOnceWarnings$      z/WarnAboutFunctionTests.test_filteredOnceWarningN) r(r)r*r+rVrrrrrrrr!r!r!r"rZs=& rcCdS)zK Do nothing. This is used to test the deprecation decorators. Nr!r!r!r!r" dummyCallable@rcCr)z[ Do nothing. This is used to test the replacement parameter to L{deprecated}. Nr!r!r!r!r"dummyReplacementMethodHrrc@sTeZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ dS)DeprecationWarningsTestscCs,tdddd}|t|j|dtfdS)z L{getDeprecationWarningString} returns a string that tells us that a callable was deprecated at a certain released version of Twisted. rkrlrz\%s.DeprecationWarningsTests.test_getDeprecationWarningString was deprecated in Twisted 8.0.0N)rrEr test_getDeprecationWarningStringr(r rSr!r!r"rQs z9DeprecationWarningsTests.test_getDeprecationWarningStringcCs6tdddd}td}|t|j||dtfdS)z L{getDeprecationWarningString} returns a string that tells us that a callable was deprecated at a certain released version of Twisted, with a message containing additional information about the deprecation. rkrlrz: This is a messagezo%s.DeprecationWarningsTests.test_getDeprecationWarningString was deprecated in Twisted 8.0.0: This is a messageN)rrrErrr()r rSformatr!r!r"*test_getDeprecationWarningStringWithFormat]szCDeprecationWarningsTests.test_getDeprecationWarningStringWithFormatcstdddd}t|tfdd}tdd6}td|||djt|t|dj t t|||dj d t d Wd d S1sQwYd S) zK Decorating a callable with L{deprecated} emits a warning. rkrlrcs dSrr!r!dummyr!r"r\tr$zJDeprecationWarningsTests.test_deprecateEmitsWarning..addStackLevelTrecordalwayscoN)rrrrrrEr]rastrrTrrrstripr)r rSr\caughtr!rr"test_deprecateEmitsWarningms     "z3DeprecationWarningsTests.test_deprecateEmitsWarningcCsBtdddd}t|t}|tj|j|ttt|dS)zK The decorated function has the same name as the original. rkrlrN)rrrrEr(fullyQualifiedNamer rSrr!r!r"test_deprecatedPreservesNames z5DeprecationWarningsTests.test_deprecatedPreservesNamecCs$tdddd}|dt|ddS)zr L{_getDeprecationDocstring} returns a note about the deprecation to go into a docstring. rkrlrzDeprecated in Twisted 8.0.0.N)rrEr rr!r!r"test_getDeprecationDocstrings z5DeprecationWarningsTests.test_getDeprecationDocstringcCsFdd}tdddd}t||}t|t|d||j|jdS)zv The docstring of the deprecated function is appended with information about the deprecation. cSr)zc Do nothing. This is used to test the deprecation decorators. Nr!r!r!r!r"localDummyCallablerzTDeprecationWarningsTests.test_deprecatedUpdatesDocstring..localDummyCallablerkrlrrN)rrr r rEr+)r rrSrr!r!r"test_deprecatedUpdatesDocstrings  z8DeprecationWarningsTests.test_deprecatedUpdatesDocstringcCs,tdddd}t|t}|||jdS)zt Deprecating a function adds version information to the decorated version of that function. rkrlrN)rrrrEdeprecatedVersionrr!r!r"test_versionMetadatas z-DeprecationWarningsTests.test_versionMetadatacCs:tdddd}t|j|dd}||dt|jfdS)a L{getDeprecationWarningString} takes an additional replacement parameter that can be used to add information to the deprecation. If the replacement parameter is a string, it will be interpolated directly into the result. rkrlrsomething.foobar replacementzG%s was deprecated in Twisted 8.0.0; please use something.foobar insteadN)rrrrErr rS warningStringr!r!r"+test_getDeprecationWarningStringReplacements zDDeprecationWarningsTests.test_getDeprecationWarningStringReplacementcCs<tdddd}t|j|td}||dt|jtfdS)a L{getDeprecationWarningString} takes an additional replacement parameter that can be used to add information to the deprecation. If the replacement parameter is a callable, its fully qualified name will be interpolated into the result. rkrlrrzP%s was deprecated in Twisted 8.0.0; please use %s.dummyReplacementMethod insteadN)rrrrrErr(rr!r!r"7test_getDeprecationWarningStringReplacementWithCallables zPDeprecationWarningsTests.test_getDeprecationWarningStringReplacementWithCallableN) r(r)r*rrrrrrrrrr!r!r!r"rPs    rrkrIrjc@seZdZdZdS)DeprecatedClasszJ Class which is entirely deprecated without having a replacement. N)r(r)r*r+r!r!r!r"rsrc@s<eZdZdZdZeeddddddZejd dZdS) ClassWithDeprecatedPropertyz2 Class with a single deprecated property. NrkrIrjrcCr%)zC Getter docstring. @return: The property. _someProtectedValuer&r!r!r" somePropertysz(ClassWithDeprecatedProperty.somePropertycCs ||_dS)z# Setter docstring. Nrrr!r!r"rs ) r(r)r*r+rrrrsetterr!r!r!r"rs rr-cCr)z7 Function with a deprecated keyword parameter. Nr!)abcr-barr!r!r"functionWithDeprecatedParameterrrc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)DeprecatedDecoratorTestsz* Tests for deprecated decorators. cCs ||dd|jDdS)a8 Check that C{target} object has the C{expected} docstring lines. @param target: Object which is checked. @type target: C{anything} @param expected: List of lines, ignoring empty lines or leading or trailing spaces. @type expected: L{list} or L{str} cSsg|] }|r|qSr!)strip).0rr!r!r" sz.N)rEr+ splitlines)r targetexpectedr!r!r"assertDocstrings z(DeprecatedDecoratorTests.assertDocstringcCs~t}|j|tjgdtddddtj_d}||jg}|dt||t |dd|||dd d S) a% When L{deprecatedProperty} is used on a C{property}, accesses raise a L{DeprecationWarning} and getter docstring is updated to inform the version in which it was deprecated. C{deprecatedVersion} attribute is also set to inform the deprecation version. )zGetter docstring.z@return: The property.Deprecated in Twisted 1.2.3.rkrIrjrktwisted.python.test.test_deprecate.ClassWithDeprecatedProperty.someProperty was deprecated in Twisted 1.2.3rr]rTN) rrrrrr_test_propertyGetterrErbra)r objrTrr!r!r"r sz,DeprecatedDecoratorTests.test_propertyGettercCsnt}t}||_|||jd}||jg}|dt||t |dd|||dddS)z} When L{deprecatedProperty} is used on a C{property}, setter accesses raise a L{DeprecationWarning}. r rIrr]rTN) rCrrr:rr_test_propertySetterrErbra)r newValuer rTrr!r!r"r 4sz,DeprecatedDecoratorTests.test_propertySettercCstt|tddgtddddt_d}||jg}|dt||t|dd |||dd d S) a When L{deprecated} is used on a class, instantiations raise a L{DeprecationWarning} and class's docstring is updated to inform the version in which it was deprecated. C{deprecatedVersion} attribute is also set to inform the deprecation version. z@Class which is entirely deprecated without having a replacement.rrkrIrjrzRtwisted.python.test.test_deprecate.DeprecatedClass was deprecated in Twisted 1.2.3rr]rTN) rrrrr_ test_classrErbra)r rTrr!r!r"rHsz#DeprecatedDecoratorTests.test_classcCs.tdddd}t|dt}||jddS)a L{deprecated} takes an additional replacement parameter that can be used to indicate the new, non-deprecated method developers should use. If the replacement parameter is a string, it will be interpolated directly into the warning message. rkrlrrz Do nothing. This is used to test the deprecation decorators. Deprecated in Twisted 8.0.0; please use something.foobar instead. N)rrrrEr+rr!r!r"test_deprecatedReplacementcs z3DeprecatedDecoratorTests.test_deprecatedReplacementcCs:tdddd}t|td}|t}||jdtfdS)a) L{deprecated} takes an additional replacement parameter that can be used to indicate the new, non-deprecated method developers should use. If the replacement parameter is a callable, its fully qualified name will be interpolated into the warning message. rkrlrrz Do nothing. This is used to test the deprecation decorators. Deprecated in Twisted 8.0.0; please use %s.dummyReplacementMethod instead. N)rrrrrEr+r()r rS decoratorrr!r!r"&test_deprecatedReplacementWithCallablews z?DeprecatedDecoratorTests.test_deprecatedReplacementWithCallablecCsd}tdd{}tdtdd||gtddd||gtdddd |t|d ||d jt|t|d j|| tddd d ||gtdddd|t|d ||d jt|t|d j|WddS1swYdS)NzzThe 'foo' parameter to twisted.python.test.test_deprecate.functionWithDeprecatedParameter was deprecated in Twisted 19.2.0Trr ()r-rIr2)r) rrrrErbr]rarrTr)r rTwsr!r!r"test_deprecatedKeywordParameters(      "z8DeprecatedDecoratorTests.test_deprecatedKeywordParameterN) r(r)r*r+rr r rrrrr!r!r!r"rs  rc@s(eZdZdZddZddZddZdS) AppendToDocstringTestszk Test the _appendToDocstring function. _appendToDocstring is used to add text to a docstring. cCs$dd}t|d|d|jdS)zP Appending to an empty docstring simply replaces the docstring. cSrrr!r!r!r!r" noDocstringrzGAppendToDocstringTests.test_appendToEmptyDocstring..noDocstringAppended text.Nr rEr+)r rr!r!r"test_appendToEmptyDocstrings z2AppendToDocstringTests.test_appendToEmptyDocstringcCs>dd}t|d|gd|j||jddS)a Appending to a single line docstring places the message on a new line, with a blank line separating it from the rest of the docstring. The docstring ends with a newline, conforming to Twisted and PEP 8 standards. Unfortunately, the indentation is incorrect, since the existing docstring doesn't have enough info to help us indent properly. cSr);This doesn't comply with standards, but is here for a test.Nr!r!r!r!r"singleLineDocstringrzTAppendToDocstringTests.test_appendToSingleLineDocstring..singleLineDocstringr)rrr N)r rEr+rrr)r rr!r!r" test_appendToSingleLineDocstrings z7AppendToDocstringTests.test_appendToSingleLineDocstringcCs.dd}dd}t|d||j|jdS)z Appending to a multi-line docstring places the messade on a new line, with a blank line separating it from the rest of the docstring. Because we have multiple lines, we have enough information to do indentation. cSr)z9 This is a multi-line docstring. Nr!r!r!r!r"multiLineDocstringrzRAppendToDocstringTests.test_appendToMultilineDocstring..multiLineDocstringcSr)zU This is a multi-line docstring. Appended text. Nr!r!r!r!r"expectedDocstringrzQAppendToDocstringTests.test_appendToMultilineDocstring..expectedDocstringrNr)r r"r#r!r!r"test_appendToMultilineDocstrings  z6AppendToDocstringTests.test_appendToMultilineDocstringN)r(r)r*r+rr!r$r!r!r!r"rs  rc@sheZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdS)MutualArgumentExclusionTestsz2 Tests for L{mutuallyExclusiveArguments}. cOs0ttddrtt|||Stt|||S)a Test an invocation of L{passed} with the given function, arguments, and keyword arguments. @param func: A function whose argspec will be inspected. @type func: A callable. @param args: The arguments which could be passed to C{func}. @param kw: The keyword arguments which could be passed to C{func}. @return: L{_passedSignature} or L{_passedArgSpec}'s return value @rtype: L{dict} signatureN)r=inspectrr&r getargspecr funcargskwr!r!r" checkPasseds z(MutualArgumentExclusionTests.checkPassedcCs*dd}|||ddtddddS)z` L{passed} identifies the arguments passed by a simple positional test. cSrrr!rrr!r!r"r*rzGMutualArgumentExclusionTests.test_passed_simplePositional..funcrIrjr.NrEr-rxr r*r!r!r"test_passed_simplePositional s"z9MutualArgumentExclusionTests.test_passed_simplePositionalcCs"dd}|t|j|ddddS)z[ L{passed} raises a L{TypeError} if too many arguments are passed. cSrrr!r.r!r!r"r*rzBMutualArgumentExclusionTests.test_passed_tooManyArgs..funcrIrjrNr; TypeErrorr-r0r!r!r"test_passed_tooManyArgsz4MutualArgumentExclusionTests.test_passed_tooManyArgscC"dd}|jt|j|ddddS)zs L{passed} raises a L{TypeError} if a argument is passed both positionally and by keyword. cSrrr!rr!r!r"r*'rzHMutualArgumentExclusionTests.test_passed_doublePassKeyword..funcrIrjr7Nr2r0r!r!r"test_passed_doublePassKeyword!r5z:MutualArgumentExclusionTests.test_passed_doublePassKeywordcCr6)z L{passed} raises a L{TypeError} if a keyword argument not present in the function's declaration is passed. cSrrr!r7r!r!r"r*2rzIMutualArgumentExclusionTests.test_passed_unspecifiedKeyword..funcrIrj)zNr2r0r!r!r"test_passed_unspecifiedKeyword,r5z;MutualArgumentExclusionTests.test_passed_unspecifiedKeywordcCs,dd}|||dddtddddS) z| L{passed} places additional positional arguments into a tuple under the name of the star argument. cWrrr!r.r!r!r"r*=rz;MutualArgumentExclusionTests.test_passed_star..funcrIrjr)rjrr.Nr/r0r!r!r"test_passed_star7s$z-MutualArgumentExclusionTests.test_passed_starc Cs:dd}||j|dddddtdtdddddd S) zn Additional keyword arguments are passed as a dict to the star star keyword argument. c[rrr!r.r!r!r"r*Hrz?MutualArgumentExclusionTests.test_passed_starStar..funcrIrjr)ryr9r.Nr/r0r!r!r"test_passed_starStarBs&z1MutualArgumentExclusionTests.test_passed_starStarcCs2d dd}||j|ddddtddddd S) zp The results of L{passed} only include arguments explicitly passed, not default values. rIrjrcSrrr!rrrder!r!r"r*UrzFMutualArgumentExclusionTests.test_passed_noDefaultValues..func)rA)rrrANrIrjrr/r0r!r!r"test_passed_noDefaultValuesOs (z8MutualArgumentExclusionTests.test_passed_noDefaultValuescCsTtdgddd}||ddd||ddd d ||ddd d d d S)z L{mutuallyExclusiveArguments} does not interfere in its decoratee's operation, either its receipt of arguments or its return value. r.rr<cSs||||Srr!)rr=rrr!r!r"r*aszMMutualArgumentExclusionTests.test_mutualExclusionPrimeDirective..funcrIrjrrBr Nrr<)r rEr0r!r!r""test_mutualExclusionPrimeDirectiveZs  z?MutualArgumentExclusionTests.test_mutualExclusionPrimeDirectivecCs.tddggd dd}|jt|ddddS) z L{mutuallyExclusiveArguments} raises a L{TypeError}n if its decoratee is passed a pair of mutually exclusive arguments. rrrr<cSs||Srr!r.r!r!r"r*oszPMutualArgumentExclusionTests.test_mutualExclusionExcludesByKeyword..funcr.NrH)r r;r3r0r!r!r"%test_mutualExclusionExcludesByKeywordis  zBMutualArgumentExclusionTests.test_mutualExclusionExcludesByKeywordcCsnGddd}Gddd}dd}|ddt|j}|}|d d |d <||}|tt|d id S) z Create a fake signature with an invalid parameter type to test error handling. The valid parameter types are specified in L{inspect.Parameter}. c@eZdZddZdS)zMMutualArgumentExclusionTests.test_invalidParameterType..FakeSignaturecSrr) parameters)r rLr!r!r"r#}r$zVMutualArgumentExclusionTests.test_invalidParameterType..FakeSignature.__init__Nr(r)r*r#r!r!r!r" FakeSignature| rNc@rK)zMMutualArgumentExclusionTests.test_invalidParameterType..FakeParametercSs||_||_dSr)rckind)r rcrPr!r!r"r#s zVMutualArgumentExclusionTests.test_invalidParameterType..FakeParameter.__init__NrMr!r!r!r" FakeParameterrOrQcSrrr!r.r!r!r"r*rzDMutualArgumentExclusionTests.test_invalidParameterType..funcrIrjfakerrIrjN)r'r&rLrr;r3r)r rNrQr*rLdummyParametersfakeSigr!r!r"test_invalidParameterTypeus  z6MutualArgumentExclusionTests.test_invalidParameterTypeN)r(r)r*r+r-r1r4r8r:r;r>rDrIrJrVr!r!r!r"r%s        r%c@r)KeywordOnlyTestsz, Keyword only arguments (PEP 3102). cOstt|||S)a Test an invocation of L{passed} with the given function, arguments, and keyword arguments. @param func: A function whose argspec to pass to L{_passed}. @type func: A callable. @param args: The arguments which could be passed to L{func}. @param kw: The keyword arguments which could be passed to L{func}. @return: L{_passed}'s return value @rtype: L{dict} )rr'r&r)r!r!r"r-szKeywordOnlyTests.checkPassedc Csdddd}dddd}|||ddd td dd ||j|ddd d dtd d d ||j|ddd ddd d tdd ddd d|jt|j|ddd ddddS)z` Keyword only arguments follow varargs. They are specified in PEP 3102. TrFcWr)zM b is a keyword-only argument, with a default value. Nr!)rrr!r!r"func1rz6KeywordOnlyTests.test_passedKeywordOnly..func1cWr)zd b, c, d, e are keyword-only arguments. b has a default value. Nr!)rrr@rArr!r!r"func2rz6KeywordOnlyTests.test_passedKeywordOnly..func2rIrjrrCr.F)rrr@rArSr?)rrr@N)rEr-rxr;r3)r rXrYr!r!r"test_passedKeywordOnlys  z'KeywordOnlyTests.test_passedKeywordOnlyN)r(r)r*r+r-rZr!r!r!r"rWs rWrC)7r+r'rmr.ros.pathrrr importlibr ImportError incrementalrtwisted.pythonrtwisted.python.deprecaterr r rr r r rrrrrrtwisted.python.filepathrtwisted.python.runtimertwisted.python.testr#twisted.python.test.modules_helpersrtwisted.trial.unittestrrr,rRrsrrrrrrrrrr%rWr!r!r!r"sR    8     Gbog  -D!