3 de*@sdZddlZddlZddlZddlmZddlmZddlmZdZ dZ dZ d Z Gd d d e ZGd d d e ZGddde ZGddde ZGddde ZGddde ZGddde ZGddde ZeddZdS)zH Record trait change events in single and multi-threaded environments. N)contextmanager)datetime)trait_notifierszc{time} {direction:-{direction}{length}} {name!r} changed from {old!r} to {new!r} in {class_name!r} z0{time} {action:>{gap}}: {handler!r} in {source} zE{time} {direction:-{direction}{length}} EXIT: {handler!r}{exception} c@seZdZdZfZddZdS)SentinelRecordzM Sentinel record to separate groups of chained change event dispatches. cCsdS)N )selfrr:/tmp/pip-build-7vycvbft/traits/traits/util/event_tracer.py__str__*szSentinelRecord.__str__N)__name__ __module__ __qualname____doc__ __slots__r rrrr r#src@s$eZdZdZd Zdd Zd d Zd S)ChangeMessageRecordz2 Message record for a change event dispatch. timeindentnameoldnew class_namecCs(||_||_||_||_||_||_dS)N)rrrrrr)r rrrrrrrrr __init__5s zChangeMessageRecord.__init__c Cs,|jd}tj|jd|j|j|j|j|dS)N>)r directionrrrrlength)r CHANGEMSGformatrrrrr)r rrrr r Cs zChangeMessageRecord.__str__N)rrrrrr)r r rrrrr rrrr r.src@s$eZdZdZd ZddZdd Zd S) CallingMessageRecordz0 Message record for a change handler call. rrhandlersourcecCs||_||_||_||_dS)N)rrr r!)r rrr r!rrr rWszCallingMessageRecord.__init__cCs(|jdt}tj|jd|j|j|dS)NrZCALLING)ractionr r!gap)r#SPACES_TO_ALIGN_WITH_CHANGE_MESSAGE CALLINGMSGrrr r!)r r#rrr r aszCallingMessageRecord.__str__N)rrr r!)r r rrrrr rrrr rPs rc@s$eZdZdZd ZddZdd Zd S) ExitMessageRecordzA Message record for returning from a change event dispatch. rrr exceptioncCs||_||_||_||_dS)N)rrr r')r rrr r'rrr rsszExitMessageRecord.__init__cCs$|jd}tj|jd|j|j|dS)Nr<)rrr r'r)rEXITMSGrrr r')r rrrr r }s zExitMessageRecord.__str__N)rrr r')r r rrrrr rrrr r&ls r&c@s(eZdZdZddZddZddZdS) RecordContainerzi A simple record container. This class is commonly used to hold records from a single thread. cCs g|_dS)N)_records)r rrr rszRecordContainer.__init__cCs|jj|dS)z- Add the record into the container. N)r+append)r recordrrr r-szRecordContainer.recordc Cs<t|ddd$}x|jD]}|jt|qWWdQRXdS)z( Save the records into a file. wzutf-8)encodingN)openr+writestr)r filenamefhr-rrr save_to_files zRecordContainer.save_to_fileN)r r rrrr-r5rrrr r*sr*c@s(eZdZdZddZddZddZdS) MultiThreadRecordContainera A container of record containers that are used by separate threads. Each record container is mapped to a thread name id. When a RecordContainer does not exist for a specific thread a new empty RecordContainer will be created on request. cCstj|_i|_dS)N) threadingLock_creation_lock_record_containers)r rrr rs z#MultiThreadRecordContainer.__init__c Cs:|j*|jj|}|dkr,t}||j|<|SQRXdS)z Return the dedicated RecordContainer for the thread. If no RecordContainer is found for `thread_name` then a new RecordContainer is created. N)r9r:getr*)r thread_name containerrrr get_change_event_collectors   z5MultiThreadRecordContainer.get_change_event_collectorc CsP|j@|j}x2|jD]&\}}tjj|dj|}|j|qWWdQRXdS)z Save records files into the directory. Each RecordContainer will dump its records on a separate file named .trace. z {0}.traceN)r9r:itemsospathjoinrr5)r Zdirectory_nameZ containersr<r=r3rrr save_to_directorys z,MultiThreadRecordContainer.save_to_directoryN)r r rrrr>rCrrrr r6sr6c@s*eZdZdZddZddZd ddZdS) ChangeEventRecordera A single thread trait change event recorder. Parameters ---------- container : MultiThreadRecordContainer A container to store the records for each trait change. Attributes ---------- container : MultiThreadRecordContainer A container to store the records for each trait change. indent : int Indentation level when reporting chained events. cCsd|_||_dS)N)rr=)r r=rrr rszChangeEventRecorder.__init__c Csh|j}tjjd}|j}|jt||||||jjd|jt |||jt j |d|jd7_dS)zF Record a string representation of the trait change dispatch  )rrrrrr)rrr r!rEN) rrutcnow isoformatr=r-r __class__r rinspect getsourcefile) r objrrrr rrr=rrr pre_tracers$zChangeEventRecorder.pre_tracerNc Csltjjd}|jd8_|j}|r2dj|} nd} |j} | jt|||j| d|dkrh| jt dS)zD Record a string representation of the trait change return rFrEz [EXCEPTION: {}])rrr r'N) rrGrHrrr=r-r&r r) r rLrrrr r'rrZ exception_msgr=rrr post_tracers  zChangeEventRecorder.post_tracer)N)r r rrrrMrOrrrr rDsrDc@s:eZdZdZddZddZddZd d d Zd d ZdS)MultiThreadChangeEventRecordera_ A thread aware trait change recorder. The class manages multiple ChangeEventRecorders which record trait change events for each thread in a separate file. Parameters ---------- container : MultiThreadChangeEventRecorder The container of RecordContainers to keep the trait change records for each thread. Attributes ---------- container : MultiThreadChangeEventRecorder The container of RecordContainers to keep the trait change records for each thread. tracers : dict Mapping from threads to ChangeEventRecorder instances. cCsi|_tj|_||_dS)N)tracersr7r8 _tracer_lockr=)r r=rrr r.s z'MultiThreadChangeEventRecorder.__init__c Cs|j i|_WdQRXdS)z& Close and stop all logging. N)rRrQ)r rrr close3sz$MultiThreadChangeEventRecorder.closecCs|j}|j|||||dS)zu The traits pre event tracer. This method should be set as the global pre event tracer for traits. N) _get_tracerrM)r rLrrrr tracerrrr rM:sz)MultiThreadChangeEventRecorder.pre_tracerNcCs"|j}|j||||||ddS)zw The traits post event tracer. This method should be set as the global post event tracer for traits. )r'N)rTrO)r rLrrrr r'rUrrr rOCsz*MultiThreadChangeEventRecorder.post_tracerc CsZ|jJtjj}||jkrB|j}|j|}t|}||j|<|S|j|SWdQRXdS)N)rRr7current_threadrrQr=r>rD)r threadr=Zthread_containerrUrrr rTLs    z*MultiThreadChangeEventRecorder._get_tracer)N) r r rrrrSrMrOrTrrrr rPs  rPc csDt}t|d}tj|j|jdz |VWdtj|jXdS)aH Multi-threaded trait change event tracer. Example ------- This will install a tracer that will record all events that occur from setting of some_trait on the my_model instance:: >>> from trace_recorder import record_events >>> with record_events() as change_event_container: ... my_model.some_trait = True >>> change_event_container.save_to_directory('C:\dev\trace') The results will be stored in one file per running thread in the directory 'C:\dev\trace'. The files are named after the thread being traced. )r=)rMrON)r6rPrZset_change_event_tracersrMrOZclear_change_event_tracersrS)r=Zrecorderrrr record_eventsYs  rX)rrJr@r7 contextlibrrZtraitsrrr%r)r$objectrrrr&r*r6rDrPrXrrrr  s&    ",K@