U  W[b4@s dZddlmZmZmZddlmZddlmZm Z m Z ddl m Z ddl mZddlmZdd d d gZeZd ZGd ddeZGdddeZeZefdd Zdd Zd&dd ZddZejd'ddZGdddeZddZ GdddeZ!d d!Z"d(d#d$Z#d%S))a A collection of utility functions and classes, used internally by Trial. This code is for Trial's internal use. Do NOT use this code if you are writing tests. It is subject to change at the Trial maintainer's whim. There is nothing here in this module for you to use unless you are maintaining Trial. Any non-Trial Twisted code that uses this module will be shot. Maintainer: Jonathan Lange @var DEFAULT_TIMEOUT_DURATION: The default timeout which will be applied to asynchronous (ie, Deferred-returning) test methods, in seconds. )divisionabsolute_importprint_function) randrange)deferutils interfaces)Failure)FilePath)FilesystemLockDEFAULT_TIMEOUT_DURATIONexcInfoOrFailureToExcInfosuppressacquireAttributeg^@c@s"eZdZdZdddZddZdS)DirtyReactorAggregateErrora7 Passed to L{twisted.trial.itrial.IReporter.addError} when the reactor is left in an unclean state after a test. @ivar delayedCalls: The L{DelayedCall} objects which weren't cleaned up. @ivar selectables: The selectables which weren't cleaned up. NcCs||_||_dSN) delayedCalls selectables)selfrrr4/usr/lib/python3/dist-packages/twisted/trial/util.py__init__2sz#DirtyReactorAggregateError.__init__cCsPd}|jr(|d7}|dtt|j7}|jrL|d7}|dtt|j7}|S)zR Return a multi-line message describing all of the unclean state. zReactor was unclean.zM DelayedCalls: (set twisted.internet.base.DelayedCall.debug = True to debug)  z Selectables: )rjoinmapstrr)rmsgrrr__str__7sz"DirtyReactorAggregateError.__str__)N)__name__ __module__ __qualname____doc__rrrrrrr(s rc@s`eZdZdZdddZddZddZd d Zd d Ze ed e ddfZddZ ddZ dS)_Janitorz The guy that cleans up after you. @ivar test: The L{TestCase} to report errors about. @ivar result: The L{IReporter} to report errors to. @ivar reactor: The reactor to use. If None, the global reactor will be used. NcCs||_||_||_dS)z @param test: See L{_Janitor.test}. @param result: See L{_Janitor.result}. @param reactor: See L{_Janitor.reactor}. N)testresultreactor)rr#r$r%rrrrQsz_Janitor.__init__cCs0|}|r,t|}|j|jt|dSdS)z Called by L{unittest.TestCase} after a test to catch any logged errors or pending L{DelayedCall}s. FT) _cleanPendingrr$addErrorr#r )rcalls aggregaterrrpostCaseCleanup\s z_Janitor.postCaseCleanupcCsB|}|}|s|r6t||}|j|jt||dS)a  Called by L{unittest.TestCase} after the last test in a C{TestCase} subclass. Ensures the reactor is clean by murdering the threadpool, catching any pending L{DelayedCall}s, open sockets etc. N) _cleanReactorr&rr$r'r#r _cleanThreads)rrr(r)rrrpostClassCleanupis  z_Janitor.postClassCleanupcCs"|jdk r|j}n ddlm}|S)zI Get either the passed-in reactor or the global reactor. Nr)r%)r%twisted.internetrr%rrr _getReactorxs  z_Janitor._getReactorcCs^|}|d|dg}|D]0}|rFt|}|ntd||q(|S)zS Cancel all pending calls and return their string representations. rz)WEIRDNESS! pending timed call not active!)r0ZiterateZgetDelayedCallsZactiverZcancelprintappend)rr%ZdelayedCallStringspZ delayedStringrrrr&s     z_Janitor._cleanPending)ignorez!reactor\.iterate cannot be used.*)categorymessagecCs*|}tj|r&|jdk r&|dSr)r0rZIReactorThreads providedByZ threadpoolZ_stopThreadPoolr/rrrr,s  z_Janitor._cleanThreadscCsB|}g}|D](}tj|r.|d|t|q|S)z Remove all selectables from the reactor, kill any of them that were processes, and return their string representation. ZKILL)r0Z removeAllrZIProcessTransportr7Z signalProcessr2repr)rr%ZselectableStringsZselrrrr+s   z_Janitor._cleanReactor)N)rrr r!rr*r-r0r&rZsuppressWarningsDeprecationWarningr,r+rrrrr"Hs    r"cCsB|D]}t||rt||Sq|tk r.|Std||fdS)z Go through the list 'objects' sequentially until we find one which has attribute 'attr', then return the value of that attribute. If not found, return 'default' if set, otherwise, raise AttributeError. zattribute %r not found in %rN)hasattrgetattr_DEFAULTAttributeError)Zobjectsattrdefaultobjrrrrs  cCs t|tr|j|j|f}|S)a' Coerce a Failure to an _exc_info, if err is a Failure. @param err: Either a tuple such as returned by L{sys.exc_info} or a L{Failure} object. @return: A tuple like the one returned by L{sys.exc_info}. e.g. C{exception_type, exception_object, traceback_object}. ) isinstancer typevalueZgetTracebackObject)errrrrr s r4cKs |f|fS)a: Sets up the .suppress tuple properly, pass options to this method as you would the stdlib warnings.filterwarnings() So, to use this with a .suppress magic attribute you would do the following: >>> from twisted.trial import unittest, util >>> import warnings >>> >>> class TestFoo(unittest.TestCase): ... def testFooBar(self): ... warnings.warn("i am deprecated", DeprecationWarning) ... testFooBar.suppress = [util.suppress(message='i am deprecated')] ... >>> Note that as with the todo and timeout attributes: the module level attribute acts as a default for the class attribute which acts as a default for the method attribute. The suppress attribute can be overridden at any level by specifying C{.suppress = []} r)actionZkwargrrrrscsfdd}|S)NcsRddl}|}z |jf||}|Wntk rDYnX||S)Nr)profileZProfileZruncallZ dump_stats SystemExitZ print_stats)argskwargsrFZprofr$f outputFilerr_szprofiled.._r)rKrLrMrrJrprofileds rNFc csrg}|D]Z}t|}z|V}|tj|fWqtk r`|tjtf|r\YqdYqXqt|dS)a$ Run the given callables one after the other. If a callable returns a Deferred, wait until it has finished before running the next callable. @param callables: An iterable of callables that take no parameters. @param stopOnFirstError: If True, then stop running callables as soon as one raises an exception or fires an errback. False by default. @return: A L{Deferred} that fires a list of C{(flag, value)} tuples. Each tuple will be either C{(SUCCESS, )} or C{(FAILURE, )}. N)rZ maybeDeferredr2SUCCESS ExceptionFAILUREr Z returnValue)Z callablesZstopOnFirstErrorZresultsrKdthingrrr_runSequentiallys rTc@seZdZdZdS)_NoTrialMarkerz No trial marker file could be found. Raised when trial attempts to remove a trial temporary working directory that does not contain a marker file. Nrrr r!rrrrrUsrUc Cs|dstd|fz |Wntk r}z|td||j|jfz(tdt t d d}| |Wn8tk r}ztd|j|jfW5d}~XYnXW5d}~XYnXdS) z Safely remove a path, recursively. If C{path} does not contain a node named C{_trial_marker}, a L{_NoTrialMarker} exception is raised and the path is not removed. _trial_markerz7%r is not a trial temporary path, refusing to remove itz2could not remove %r, caught OSError [Errno %s]: %ss_trial_temp_oldizutf-8z4could not rename path, caught OSError [Errno %s]: %sN) childexistsrUremoveOSErrorr1errnostrerrorr rrencodeZmoveTo)patheZnewPathrrr _removeSafely(s,   rac@seZdZdZdS)_WorkingDirectoryBusyzv A working directory was specified to the runner, but another test run is currently using that directory. NrVrrrrrbCsrbcCsd}|r |d||f}n|}t|jd}|rj|rJt|||d d||fS|dkr|d7}qt qdS) a0 Find an unused directory named similarly to C{base}. Once a directory is found, it will be locked and a marker dropped into it to identify it as a trial temporary directory. @param base: A template path for the discovery process. If this path exactly cannot be used, a path which varies only in a suffix of the basename will be used instead. @type base: L{FilePath} @return: A two-tuple. The first element is a L{FilePath} representing the directory which was found and created. The second element is a locked L{FilesystemLock}. Another call to C{_unusedTestDirectory} will not be able to reused the same name until the lock is released, either explicitly or by this process exiting. rz%s-%dz.lockrWZ _trial_tempN) Zsiblingbasenamer r_lockrYramakedirsrXZ setContentrb)baseZcounterZtestdirZ testDirLockrrr_unusedTestDirectoryKs  ri, cCst|ttfstd|sdSt|dkr6t|dSt|dkr`dt|d|t|dfSg}|D]}|t|qhd||dd |||d fSdS) ad Produce a string containing each thing in C{things}, separated by a C{delimiter}, with the last couple being separated by C{finalDelimiter} @param things: The elements of the resulting phrase @type things: L{list} or L{tuple} @param finalDelimiter: What to put between the last two things (typically 'and' or 'or') @type finalDelimiter: L{str} @param delimiter: The separator to use between each thing, not including the last two. Should typically include a trailing space. @type delimiter: L{str} @return: The resulting phrase @rtype: L{str} z Things must be a list or a tuplerdrz%s %s %sz %s%s%s %sN)rAlisttuple TypeErrorlenrr2r)ZthingsZfinalDelimiterZ delimiterZ strThingsrSrrr _listToPhrasezs    rrN)r4)F)rj)$r!Z __future__rrrZrandomrr.rrrZtwisted.python.failurer Ztwisted.python.filepathr Ztwisted.python.lockfiler __all__objectZDEFAULT_TIMEOUTr rPrr"r<rr rrNZinlineCallbacksrTrUrarbrirrrrrrs6     m    /