3 dE@sdZddlZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z ddlmZGdddeZejddZGd d d e ZGd d d eZdS) zN Trait assert mixin class to simplify test implementation for Trait Classes. N)AnyEventHasStrictTraitsIntListStrProperty)wait_for_conditionc@s0eZdZdZddZddZddZdd Zd S) _AssertTraitChangesContexta A context manager used to implement the trait change assert methods. Notes ----- Checking if the provided xname corresponds to valid traits in the class is not implemented yet. Parameters ---------- obj : HasTraits The HasTraits class instance whose class trait will change. xname : str The extended trait name of trait changes to listen to. count : int, optional The expected number of times the event should be fired. When None (default value) there is no check for the number of times the change event was fired. test_case : TestCase A unittest TestCase where to raise the failureException if necessary. Attributes ---------- obj : HasTraits The HasTraits class instance whose class trait will change. xname : str The extended trait name of trait changes to listen to. count : int, optional The expected number of times the event should be fired. When None (default value) there is no check for the number of times the change event was fired. events : list of tuples A list with tuple elements containing the arguments of an `on_trait_change` event signature (, , , ). Raises ------ AssertionError : When the desired number of trait changed did not take place or when `count = None` and no trait change took place. cCs*||_||_||_d|_g|_|j|_dS)N)objxnamecounteventeventsfailureException)selfr r r Z test_caser?/tmp/pip-build-7vycvbft/traits/traits/testing/unittest_tools.py__init__Xs z#_AssertTraitChangesContext.__init__cCs ||||f|_|jj|jdS)z Dummy trait listener. N)rrappend)rr nameoldnewrrr _listener`sz$_AssertTraitChangesContext._listenercCs|jj|j|j|S)z" Bind the trait listener. )r on_trait_changerr )rrrr __enter__fsz$_AssertTraitChangesContext.__enter__cCs|dk r dS|jj|j|jdd|jdk rft|j|jkrfd}|jt|j|jf}|j|j|n(|jdkr|j rdj|j}|j|dS)z$ Remove the trait listener. NFT)removez7Change event for {0} was fired {1} times instead of {2}z%A change event was not fired for: {0}) r rrr r lenrrformat)rexc_type exc_valuetbmsgitemsrrr__exit__ls  z#_AssertTraitChangesContext.__exit__N)__name__ __module__ __qualname____doc__rrrr$rrrrr &s 0r ccsL|jz |VWdy|jdddWntk r:Yn X|j|XdS)N)rr$AssertionErrorr)contextr"rrrreverse_assertion}s r+csbeZdZdZeZeZee Z e Z e eZeZfddZddZddZdd Zd d ZZS) _TraitsChangeCollectorz5 Class allowing thread-safe recording of events. c sPd|kr.|jd}d}tj|tdd||d<tjf|tj|_g|_ dS)Ntraitz:The `trait` keyword is deprecated. please use `trait_name`) stacklevel trait_name) popwarningswarnDeprecationWarningsuperr threadingLock_lockr)rZtraitsvaluemessage) __class__rrrs  z_TraitsChangeCollector.__init__cCs|jj|j|jdS)N)r r_event_handlerr0)rrrrstart_collectingsz'_TraitsChangeCollector.start_collectingcCs|jj|j|jdddS)NT)r)r rr<r0)rrrrstop_collectingsz&_TraitsChangeCollector.stop_collectingc Cs(|j|jj|WdQRXd|_dS)NT)r8rrevent_count_updated)rrrrrr<sz%_TraitsChangeCollector._event_handlerc Cs|j t|jSQRXdS)zN Traits property getter. Thread-safe access to event count. N)r8rr)rrrr_get_event_countsz'_TraitsChangeCollector._get_event_count)r%r&r'r(rr rr0rr event_countrr?rrr8rr=r>r<r@ __classcell__rr)r;rr,s r,c@sveZdZdZdddZdddZejddZejdd d Z dd dZ ejddZ ejddZ ejddZ dS) UnittestToolszg Mixin class to augment the unittest.TestCase class with useful trait related assert methods. Nc Os8t||||}|dkr|S||||WdQRXdS)a Assert an object trait changes a given number of times. Assert that the class trait changes exactly `count` times during execution of the provided function. This method can also be used in a with statement to assert that a class trait has changed during the execution of the code inside the with statement (similar to the assertRaises method). Please note that in that case the context manager returns itself and the user can introspect the information of: - The last event fired by accessing the ``event`` attribute of the returned object. - All the fired events by accessing the ``events`` attribute of the return object. Note that in the case of chained properties (trait 'foo' depends on 'bar', which in turn depends on 'baz'), the order in which the corresponding trait events appear in the ``events`` attribute is not well-defined, and may depend on dictionary ordering. **Example**:: class MyClass(HasTraits): number = Float(2.0) my_class = MyClass() with self.assertTraitChanges(my_class, 'number', count=1): my_class.number = 3.0 Parameters ---------- obj : HasTraits The HasTraits class instance whose class trait will change. trait : str The extended trait name of trait changes to listen to. count : int or None, optional The expected number of times the event should be fired. When None (default value) there is no check for the number of times the change event was fired. callableObj : callable, optional A callable object that will trigger the expected trait change. When None (default value) a trigger is expected to be called under the context manger returned by this method. *args : List of positional arguments for ``callableObj`` **kwargs : Dict of keyword value pairs to be passed to the ``callableObj`` Returns ------- context : context manager or None If ``callableObj`` is None, an assertion context manager is returned, inside of which a trait-change trigger can be invoked. Otherwise, the context is used internally with ``callableObj`` as the trigger, in which case None is returned. Notes ----- - Checking if the provided ``trait`` corresponds to valid traits in the class is not implemented yet. - Using the functional version of the assert method requires the ``count`` argument to be given even if it is None. N)r )rr r-r callableObjargskwargsr*rrrassertTraitChangess Lz UnittestTools.assertTraitChangesc OsNdj|}t||d|}|dkr*t||St|||||WdQRXdS)a Assert an object trait does not change. Assert that the class trait does not change during execution of the provided function. Parameters ---------- obj : HasTraits The HasTraits class instance whose class trait will change. trait : str The extended trait name of trait changes to listen to. callableObj : callable, optional A callable object that should not trigger a change in the passed trait. When None (default value) a trigger is expected to be called under the context manger returned by this method. *args : List of positional arguments for ``callableObj`` **kwargs : Dict of keyword value pairs to be passed to the ``callableObj`` Returns ------- context : context manager or None If ``callableObj`` is None, an assertion context manager is returned, inside of which a trait-change trigger can be invoked. Otherwise, the context is used internally with ``callableObj`` as the trigger, in which case None is returned. z!A change event was fired for: {0}N)rr r+)rr r-rDrErFr"r*rrrassertTraitDoesNotChange!s %   z&UnittestTools.assertTraitDoesNotChangeccstjn}g}xX|D]P}x$|D]}|j|j|j||qWx$|D]}|j|j|j||qDWqWt|VWdQRXdS)a! Assert that traits on multiple objects do or do not change. This combines some of the functionality of `assertTraitChanges` and `assertTraitDoesNotChange`. Parameters ---------- objects : list of HasTraits The HasTraits class instances whose traits will change. traits_modified : list of str The extended trait names of trait expected to change. traits_not_modified : list of str The extended trait names of traits not expected to change. N) contextlib ExitStackr enter_contextrGrHtuple)robjectsZtraits_modifiedZtraits_not_modifiedZ exit_stackZcmsr r-rrrassertMultiTraitChangesMs    z%UnittestTools.assertMultiTraitChanges@c#st||d}|jz^|Vytfdd|d|dWn6tk rn|j}dj||||}|j|YnXWd|jXdS)a3 Assert an object trait eventually changes. Context manager used to assert that the given trait changes at least `count` times within the given timeout, as a result of execution of the body of the corresponding with block. The trait changes are permitted to occur asynchronously. **Example usage**:: with self.assertTraitChangesAsync(my_object, 'SomeEvent', count=4): Parameters ---------- obj : HasTraits The HasTraits class instance whose class trait will change. trait : str The extended trait name of trait changes to listen to. count : int, optional The expected number of times the event should be fired. timeout : float or None, optional The amount of time in seconds to wait for the specified number of changes. None can be used to indicate no timeout. )r r0cs |jkS)N)rA)r )r rrsz7UnittestTools.assertTraitChangesAsync..r?) conditionr r-timeoutz~Expected {0} event on {1} to be fired at least {2} times, but the event was only fired {3} times before timeout ({4} seconds).N)r,r=r RuntimeErrorrArfailr>)rr r-r rSZ collectorZactual_event_countr"r)r rassertTraitChangesAsyncms !   z%UnittestTools.assertTraitChangesAsyncc CsFyt||||dWn,tk r@||}|jdj|YnXdS)a Assert that the given condition is eventually true. Parameters ---------- obj : HasTraits The HasTraits class instance whose traits will change. trait : str The extended trait name of trait changes to listen to. condition : callable A function that will be called when the specified trait changes. This should accept ``obj`` and should return a Boolean indicating whether the condition is satisfied or not. timeout : float or None, optional The amount of time in seconds to wait for the condition to become true. None can be used to indicate no timeout. )rRr r-rSz?Timed out waiting for condition. At timeout, condition was {0}.N)r rTrUr)rr r-rRrSZcondition_at_timeoutrrrassertEventuallyTruesz"UnittestTools.assertEventuallyTruec csXtjdttjdjjd}|r*|jtjdd}tj dt|VWdQRXdS)a Replacement for warnings.catch_warnings. This method wraps warnings.catch_warnings, takes care to reset the warning registry before entering the with context, and ensures that DeprecationWarnings are always emitted. The hack to reset the warning registry is no longer needed in Python 3.4 and later. See http://bugs.python.org/issue4180 for more background. .. deprecated:: 6.2 Use :func:`warnings.catch_warnings` instead. zNThe _catch_warnings method is deprecated. Use warnings.catch_warnings instead.__warningregistry__T)recordalwaysN) r2r3r4sys _getframe f_globalsgetclearcatch_warnings simplefilter)rregistrywrrr_catch_warningss  zUnittestTools._catch_warningsc csBtjdd}tjdt|VWdQRX|jt|ddddS)z Assert that the code inside the with block is deprecated. Intended for testing uses of traits.util.deprecated.deprecated. T)rZr[Nrz2Expected a DeprecationWarning, but none was issued)r")r2rarbr4Z assertGreaterr)rrdrrrassertDeprecateds zUnittestTools.assertDeprecatedc csBtjdd}tjdt|VWdQRX|jt|ddddS)z Assert that the code inside the with block is not deprecated. Intended for testing uses of traits.util.deprecated.deprecated. T)rZr[Nrz;Expected no DeprecationWarning, but at least one was issued)r")r2rarbr4Z assertEqualr)rrdrrrassertNotDeprecateds z!UnittestTools.assertNotDeprecated)NN)N)rOrP)rP)r%r&r'r(rGrHrIcontextmanagerrNrVrWrerfrgrrrrrCs R +  ; #'rC)r(rIr6r\r2ZunittestZ traits.apirrrrrrrZtraits.util.async_trait_waitr objectr rhr+r,rCrrrrs$ W>