o b,@sdZddlmZmZmZmZddlmZmZGdddeZ GdddeZ Gdd d eZ Gd d d e Z Gd d d e ZGddde ZGdddeZdS)z Tests for L{twisted.internet.defer.inlineCallbacks}. Some tests for inlineCallbacks are defined in L{twisted.test.test_defgen} as well. )CancelledErrorDeferredinlineCallbacks returnValue)SynchronousTestCaseTestCasec@eZdZdZddZdS)StopIterationReturnTestsz On Python 3.4 and newer generator functions may use the C{return} statement with a value, which is attached to the L{StopIteration} exception that is raised. L{inlineCallbacks} will use this value when it fires the C{callback}. cCsDdti}td|t}|d|}|d|||ddS)z If the C{return} statement has a value it is propagated back to the L{Deferred} that the C{inlineCallbacks} function returned. rz> @inlineCallbacks def f(d): yield d return 14 fN)rexecrcallback assertEqualsuccessResultOf)selfenvirond1d2rE/usr/lib/python3/dist-packages/twisted/internet/test/test_inlinecb.pytest_returnWithValues  z-StopIterationReturnTests.test_returnWithValueN)__name__ __module__ __qualname____doc__rrrrrr s r c@s0eZdZdZddZddZddZdd Zd S) NonLocalExitTestsa It's possible for L{returnValue} to be (accidentally) invoked at a stack level below the L{inlineCallbacks}-decorated function which it is exiting. If this happens, L{returnValue} should report useful errors. If L{returnValue} is invoked from a function not decorated by L{inlineCallbacks}, it will emit a warning if it causes an L{inlineCallbacks} function further up the stack to exit. cCs tddS)z This method mistakenly invokes L{returnValue}, despite the fact that it is not decorated with L{inlineCallbacks}. N)rrrrrmistakenMethod?s z NonLocalExitTests.mistakenMethodcCsZ||dg|j|jgd}|t|d||ddt||ddddS)ac Flush the current warnings and assert that we have been told that C{mistakenMethod} was invoked, and that the result from the Deferred that was fired (appended to the given list) is C{mistakenMethod}'s result. The warning should indicate that an inlineCallbacks function called 'inline' was made to exit. r)offendingFunctionsrcategorymessagezreturnValue() in 'mistakenMethod' causing 'inline' to exit: returnValue should only be invoked by functions decorated with inlineCallbacksN)r flushWarningsrlenDeprecationWarning)r resultListwarningsrrrassertMistakenMethodWarningFs z-NonLocalExitTests.assertMistakenMethodWarningcs4tfdd}|}g}||j|dS)z L{returnValue} will emit a non-local exit warning in the simplest case, where the offending function is invoked immediately. c3stddVdS)Nrrrrrrrinline_s zANonLocalExitTests.test_returnValueNonLocalWarning..inlineN)r addCallbackappendr')rr*dresultsrrrtest_returnValueNonLocalWarningYs  z1NonLocalExitTests.test_returnValueNonLocalWarningcsRttfdd}|}g}||j|gd|dS)z L{returnValue} will emit a non-local warning in the case where the L{inlineCallbacks}-decorated function has already yielded a Deferred and therefore moved its generator function along. c3sVtddS)Nr(r)rcauserrrr*rs zBNonLocalExitTests.test_returnValueNonLocalDeferred..inlinerN)rrr+r,rr r')rr*effectr.rr0r test_returnValueNonLocalDeferredjs   z2NonLocalExitTests.test_returnValueNonLocalDeferredN)rrrrrr'r/r3rrrrr4s   rc@seZdZddZddZdS)ForwardTraceBackTestscs\tddtfdd}|}||}|}|d||d||d|dS) z Chained inlineCallbacks are forwarding the traceback information from generator to generator. A first simple test with a couple of inline callbacks. csdVtdNzforcing generator Error Marker Exceptionrrrrerroringz>ForwardTraceBackTests.test_forwardTracebacks..erroringc3VdSNrrr:rrcalling z=ForwardTraceBackTests.test_forwardTracebacks..calling in erroring in callingr7N)rfailureResultOf getTracebackassertInrr?r-r tbrr>rtest_forwardTracebackss    z,ForwardTraceBackTests.test_forwardTracebackscstddtfddtfddtfdd}|}||}|}|d ||d ||d ||d ||d ||d||d |dS)a Several Chained inlineCallbacks gives information about all generators. A wider test with a 4 chained inline callbacks. Application stack-trace should be reported, and implementation details like "throwExceptionIntoGenerator" symbols are omitted from the stack. Note that the previous test is testing the simple case, and this one is testing the deep recursion case. That case needs specific code in failure.py to accomodate to stack breakage introduced by throwExceptionIntoGenerator. Hence we keep the two tests in order to sort out which code we might have regression in. csr5r6r8rrrrr:r;zDForwardTraceBackTests.test_forwardLotsOfTracebacks..erroringc3r<r=rrr>rrcalling3r@zDForwardTraceBackTests.test_forwardLotsOfTracebacks..calling3c3r<r=rr)rIrrcalling2r@zDForwardTraceBackTests.test_forwardLotsOfTracebacks..calling2c3r<r=rr)rJrrr?r@zCForwardTraceBackTests.test_forwardLotsOfTracebacks..callingrArBz in calling2z in calling3throwExceptionIntoGeneratorr7N)rrCrDrE assertNotInrFr)rJrIr:rtest_forwardLotsOfTracebackss$        z2ForwardTraceBackTests.test_forwardLotsOfTracebacksN)rrrrHrMrrrrr4s r4c@eZdZdZdS)UntranslatedErrorzL Untranslated exception type when testing an exception translation. NrrrrrrrrrOrOc@rN)TranslatedErrorzJ Translated exception type when testing an exception translation. NrPrrrrrRrQrRc@r)DontFailz Sample exception type. cCst|||_dSr=)r9__init__ actualValue)ractualrrrrTs  zDontFail.__init__N)rrrrrTrrrrrSs rSc@sheZdZdZddZddZedddZd d Zdd d Z d dZ ddZ ddZ ddZ ddZdS)CancellationTestsa! Tests for cancellation of L{Deferred}s returned by L{inlineCallbacks}. For each of these tests, let: - C{G} be a generator decorated with C{inlineCallbacks} - C{D} be a L{Deferred} returned by C{G} - C{C} be a L{Deferred} awaited by C{G} with C{yield} cCs g|_dS)z> Set up the list of outstanding L{Deferred}s. N)deferredsOutstandingrrrrsetUps zCancellationTests.setUpcCs|jr ||jsdSdS)zG If any L{Deferred}s are still outstanding, fire them. N)rXdeferredGottenrrrrtearDownszCancellationTests.tearDownNc csn|dur|j}z|V}Wn tytty.}z |jd}WYd}~nd}~wwt|ddS)z Generator for testing cascade cancelling cases. @param getChildDeferred: Some callable returning L{Deferred} that we awaiting (with C{yield}) Nr(r) getDeferredrOrRrSrUr)rgetChildDeferredxdfrrrsampleInlineCBs  z CancellationTests.sampleInlineCBcCs|jt|jdS)z A sample function that returns a L{Deferred} that can be fired on demand, by L{CancellationTests.deferredGotten}. @return: L{Deferred} that can be fired on demand. )rXr,rrrrrr\s zCancellationTests.getDeferredcCs|jd|dS)z Fire the L{Deferred} returned from the least-recent call to L{CancellationTests.getDeferred}. @param result: result object to be used when firing the L{Deferred}. rN)rXpopr )rresultrrrrZsz CancellationTests.deferredGottencsJdgfdd}|j|d}|dd||dtdd S) zN When C{D} cancelled, C{C} will be immediately cancelled too. FAILUREcs t}fdd}|||S)Ncs|td<|S)Nr)checkrrcchildResultHolderrr_eb#szWCancellationTests.test_cascadeCancellingOnCancel..getChildDeferred.._ebr addErrback)r-rirgrrr] s  zJCancellationTests.test_cascadeCancellingOnCancel..getChildDeferredr]cSsdSr=rrfrrr+zBCancellationTests.test_cascadeCancellingOnCancel..rzno cascade cancelling occursN)r`rkcancelrr)rr]r-rrgrtest_cascadeCancellingOnCancels  z0CancellationTests.test_cascadeCancellingOnCancelcCs(|}||t||jdS)zg When C{D} cancelled, CancelledError from C{C} will be errbacked through C{D}. N)r`ro assertRaisesrrCraiseException)rr-rrr"test_errbackCancelledErrorOnCancel3s  z4CancellationTests.test_errbackCancelledErrorOnCancelcsBdd}t||fdd}||t||jdS)z When C{D} is cancelled, and C raises a particular type of error, C{G} may catch that error at the point of yielding and translate it into a different error which may be received by application code. cSs|tdSr=)errbackrOitrrrroFsz>CancellationTests.test_errorToErrorTranslation..cancelcSr=rrarrrmJrnz@CancellationTests.test_errorToErrorTranslation..N)rr`rorqrRrCrr)rror-rrxrtest_errorToErrorTranslation?s z.CancellationTests.test_errorToErrorTranslationcsLdd}t||fdd}g}||j|||dgdS)z When C{D} is cancelled, and C{C} raises a particular type of error, C{G} may catch that error at the point of yielding and translate it into a result value which may be received by application code. cSs|tddS)Ni)rtrSrurrrroXsz@CancellationTests.test_errorToSuccessTranslation..cancelcrwr=rrrxrrrm\rnzBCancellationTests.test_errorToSuccessTranslation..iN)rr`r+r,ro assertEquals)rror-r.rrxrtest_errorToSuccessTranslationQs z0CancellationTests.test_errorToSuccessTranslationcs\tfddfdd}|j|d}|||d|||ddS) a" When C{D} is cancelled, it won't reach the callbacks added to it by application code until C{C} reaches the point in its callback chain where C{G} awaits it. Otherwise, application code won't be able to track resource usage that C{D} may be using. cs|tSr=)traprrf) moreDeferredrr deferMeMoreks zDCancellationTests.test_asynchronousCancellation..deferMeMorecst}||Sr=rj)r-)rrrdeferMeos z@CancellationTests.test_asynchronousCancellation..deferMerliiN)rr`roassertNoResultr rr)rrr-r)rr~rtest_asynchronousCancellationbs     z/CancellationTests.test_asynchronousCancellationr=)rrrrrYr[rr`r\rZrprsrzr|rrrrrrWs     rWN)rtwisted.internet.deferrrrrtwisted.trial.unittestrrr rr4r9rOrRrSrWrrrrsLI