U ")3g=@sdZddlmZddlZddlZddlZddlmZm Z ddl m Z ddl m Z dZdZd Zd Zd Zd Zed dGdddZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZGd!d"d"eZGd#d$d$eZGd%d&d&eZGd'd(d(Z Gd)d*d*e Z!Gd+d,d,e Z"Gd-d.d.e Z#d/d0Z$d1d2Z%dS)3um:module: watchdog.events :synopsis: File system events and event handlers. :author: yesudeep@google.com (Yesudeep Mangalapilly) :author: contact@tiger-222.fr (Mickaël Schoentgen) Event Classes ------------- .. autoclass:: FileSystemEvent :members: :show-inheritance: :inherited-members: .. autoclass:: FileSystemMovedEvent :members: :show-inheritance: .. autoclass:: FileMovedEvent :members: :show-inheritance: .. autoclass:: DirMovedEvent :members: :show-inheritance: .. autoclass:: FileModifiedEvent :members: :show-inheritance: .. autoclass:: DirModifiedEvent :members: :show-inheritance: .. autoclass:: FileCreatedEvent :members: :show-inheritance: .. autoclass:: FileClosedEvent :members: :show-inheritance: .. autoclass:: FileOpenedEvent :members: :show-inheritance: .. autoclass:: DirCreatedEvent :members: :show-inheritance: .. autoclass:: FileDeletedEvent :members: :show-inheritance: .. autoclass:: DirDeletedEvent :members: :show-inheritance: Event Handler Classes --------------------- .. autoclass:: FileSystemEventHandler :members: :show-inheritance: .. autoclass:: PatternMatchingEventHandler :members: :show-inheritance: .. autoclass:: RegexMatchingEventHandler :members: :show-inheritance: .. autoclass:: LoggingEventHandler :members: :show-inheritance: ) annotationsN) dataclassfield)Optional)match_any_pathsmovedZdeletedcreatedmodifiedclosedZopenedT)Z unsafe_hashc@s`eZdZUdZded<dZded<edddZded<edddZd ed <edd Z d ed <d S)FileSystemEventaImmutable type that represents a file system event that is triggered when a change occurs on the monitored file system. All FileSystemEvent objects are required to be immutable and hence can be used as keys in dictionaries or be added to sets. strsrc_path dest_pathF)defaultinit event_typebool is_directory)r is_syntheticN) __name__ __module__ __qualname____doc____annotations__rrrrrrr3/tmp/pip-unpacked-wheel-cstuilrs/watchdog/events.pyr os  r c@seZdZdZeZdS)FileSystemMovedEventz@File system event representing any kind of file system movement.N)rrrrEVENT_TYPE_MOVEDrrrrrrsrc@seZdZdZeZdS)FileDeletedEventz@File system event representing file deletion on the file system.N)rrrrEVENT_TYPE_DELETEDrrrrrrsrc@seZdZdZeZdS)FileModifiedEventzDFile system event representing file modification on the file system.N)rrrrEVENT_TYPE_MODIFIEDrrrrrr!sr!c@seZdZdZeZdS)FileCreatedEventz@File system event representing file creation on the file system.N)rrrrEVENT_TYPE_CREATEDrrrrrr#sr#c@seZdZdZdS)FileMovedEventz@File system event representing file movement on the file system.N)rrrrrrrrr%sr%c@seZdZdZeZdS)FileClosedEvent=File system event representing file close on the file system.N)rrrrEVENT_TYPE_CLOSEDrrrrrr&sr&c@seZdZdZeZdS)FileOpenedEventr'N)rrrrEVENT_TYPE_OPENEDrrrrrr)sr)c@seZdZdZeZdZdS)DirDeletedEventzEFile system event representing directory deletion on the file system.TN)rrrrr rrrrrrr+sr+c@seZdZdZeZdZdS)DirModifiedEventzIFile system event representing directory modification on the file system.TN)rrrrr"rrrrrrr,sr,c@seZdZdZeZdZdS)DirCreatedEventzEFile system event representing directory creation on the file system.TN)rrrrr$rrrrrrr-sr-c@seZdZdZdZdS) DirMovedEventzEFile system event representing directory movement on the file system.TN)rrrrrrrrrr.sr.c@seZdZdZdddddZdddddZdddd d Zdddd d Zdddd dZdddddZ dddddZ dddddZ dS)FileSystemEventHandlerzBBase file system event handler that you can override methods from.r Noneeventreturnc Cs@||t|jt|jt|jt|jt |j t |j i|j |dS)Dispatches events to the appropriate methods. :param event: The event object representing the file system event. :type event: :class:`FileSystemEvent` N) on_any_eventr$ on_createdr on_deletedr" on_modifiedron_movedr( on_closedr* on_openedrselfr2rrrdispatchs$ zFileSystemEventHandler.dispatchcCsdS)zCatch-all event handler. :param event: The event object representing the file system event. :type event: :class:`FileSystemEvent` Nrr<rrrr5sz#FileSystemEventHandler.on_any_eventcCsdS)zCalled when a file or a directory is moved or renamed. :param event: Event representing file/directory movement. :type event: :class:`DirMovedEvent` or :class:`FileMovedEvent` Nrr<rrrr9szFileSystemEventHandler.on_movedcCsdS)zCalled when a file or directory is created. :param event: Event representing file/directory creation. :type event: :class:`DirCreatedEvent` or :class:`FileCreatedEvent` Nrr<rrrr6sz!FileSystemEventHandler.on_createdcCsdS)zCalled when a file or directory is deleted. :param event: Event representing file/directory deletion. :type event: :class:`DirDeletedEvent` or :class:`FileDeletedEvent` Nrr<rrrr7sz!FileSystemEventHandler.on_deletedcCsdS)zCalled when a file or directory is modified. :param event: Event representing file/directory modification. :type event: :class:`DirModifiedEvent` or :class:`FileModifiedEvent` Nrr<rrrr8sz"FileSystemEventHandler.on_modifiedcCsdS)zCalled when a file opened for writing is closed. :param event: Event representing file closing. :type event: :class:`FileClosedEvent` Nrr<rrrr:sz FileSystemEventHandler.on_closedcCsdS)zCalled when a file is opened. :param event: Event representing file opening. :type event: :class:`FileOpenedEvent` Nrr<rrrr;sz FileSystemEventHandler.on_openedN) rrrrr>r5r9r6r7r8r:r;rrrrr/s      r/csfeZdZdZdfdd ZeddZedd Zed d Zed d Z dddfdd Z Z S)PatternMatchingEventHandlerz Matches given patterns with file paths associated with occurring events. Uses pathlib's `PurePath.match()` method. `patterns` and `ignore_patterns` are expected to be a list of strings. NFcs&t||_||_||_||_dSN)super__init__ _patterns_ignore_patterns_ignore_directories_case_sensitive)r=patternsignore_patternsignore_directoriescase_sensitive __class__rrrB*s  z$PatternMatchingEventHandler.__init__cCs|jS)zD(Read-only) Patterns to allow matching event paths. )rCr=rrrrG8sz$PatternMatchingEventHandler.patternscCs|jS)zE(Read-only) Patterns to ignore matching event paths. )rDrMrrrrH?sz+PatternMatchingEventHandler.ignore_patternscCs|jSz\(Read-only) ``True`` if directories should be ignored; ``False`` otherwise. rErMrrrrIFsz.PatternMatchingEventHandler.ignore_directoriescCs|jSzu(Read-only) ``True`` if path names should be matched sensitive to case; ``False`` otherwise. rFrMrrrrJMsz*PatternMatchingEventHandler.case_sensitiver r0r1csn|jr|jrdSg}t|dr0|t|j|jrH|t|jt||j |j |j drjt |dS)r4Nr)Zincluded_patternsZexcluded_patternsrJ)rIrhasattrappendosfsdecoderr rrGrHrJrAr>)r=r2pathsrKrrr>Us  z$PatternMatchingEventHandler.dispatch)NNFF) rrrrrBpropertyrGrHrIrJr> __classcell__rrrKrr?#s    r?csfeZdZdZdfdd ZeddZedd Zed d Zed d Z dddfdd Z Z S)RegexMatchingEventHandlerzk Matches given regexes with file paths associated with occurring events. Uses the `re` module. NFcst|dkrdg}nt|tr*|g}|dkr6g}|r\dd|D|_dd|D|_n dd|D|_dd|D|_||_||_dS)Nz.*cSsg|]}t|qSrrecompile.0rrrr sz6RegexMatchingEventHandler.__init__..cSsg|]}t|qSrrZr]rrrr`scSsg|]}t|tjqSrr[r\ IGNORECASEr]rrrr`scSsg|]}t|tjqSrrar]rrrr`s)rArB isinstancer _regexes_ignore_regexesrErF)r=regexesignore_regexesrIrJrKrrrBus  z"RegexMatchingEventHandler.__init__cCs|jS)zC(Read-only) Regexes to allow matching event paths. )rdrMrrrrfsz!RegexMatchingEventHandler.regexescCs|jS)zD(Read-only) Regexes to ignore matching event paths. )rerMrrrrgsz(RegexMatchingEventHandler.ignore_regexescCs|jSrNrOrMrrrrIsz,RegexMatchingEventHandler.ignore_directoriescCs|jSrPrQrMrrrrJsz(RegexMatchingEventHandler.case_sensitiver r0r1cs|jr|jrdSgt|dr0t|j|jrHt|jtfdd|j DrddStfdd|j Drt |dS)r4Nrc3s"|]}D]}||Vq qdSr@matchr^r_prVrr sz5RegexMatchingEventHandler.dispatch..c3s"|]}D]}||Vq qdSr@rhrjrlrrrms) rIrrRrSrTrUrr anyrgrfrAr>r<rKrlrr>s  z"RegexMatchingEventHandler.dispatch)NNFF) rrrrrBrWrfrgrIrJr>rXrrrKrrYos    rYcseZdZdZddddfdd Zddd fd d Zddd fd d Zddd fdd Zddd fdd Zddd fdd Z ddd fdd Z Z S)LoggingEventHandlerzLogs all the events captured.NzOptional[logging.Logger]r0)loggerr3cst|ptj|_dSr@)rArBloggingrootrp)r=rprKrrrBs zLoggingEventHandler.__init__r r1cs4t||jrdnd}|jd||j|jdS)N directoryfilezMoved %s: from %s to %s)rAr9rrpinfor rr=r2whatrKrrr9s zLoggingEventHandler.on_movedcs0t||jrdnd}|jd||jdS)NrsrtzCreated %s: %s)rAr6rrprur rvrKrrr6s zLoggingEventHandler.on_createdcs0t||jrdnd}|jd||jdS)NrsrtzDeleted %s: %s)rAr7rrprur rvrKrrr7s zLoggingEventHandler.on_deletedcs0t||jrdnd}|jd||jdS)NrsrtzModified %s: %s)rAr8rrprur rvrKrrr8s zLoggingEventHandler.on_modifiedcs t||jd|jdS)NzClosed file: %s)rAr:rprur r<rKrrr:s zLoggingEventHandler.on_closedcs t||jd|jdS)NzOpened file: %s)rAr;rprur r<rKrrr;s zLoggingEventHandler.on_opened)N) rrrrrBr9r6r7r8r:r;rXrrrKrrosroc cst|D]\}}}|D]6}tj||}|r:|||nd}t||ddVq|D]6}tj||}|rv|||nd}t||ddVqTq dS)aGenerates an event list of :class:`DirMovedEvent` and :class:`FileMovedEvent` objects for all the files and directories within the given moved directory that were moved along with the directory. :param src_dir_path: The source path of the moved directory. :param dest_dir_path: The destination path of the moved directory. :returns: An iterable of file system events of type :class:`DirMovedEvent` and :class:`FileMovedEvent`. rTrN)rTwalkpathjoinreplacer.r%) src_dir_pathZ dest_dir_pathrr directories filenamesrs full_pathZ renamed_pathfilenamerrrgenerate_sub_moved_eventss rccs^t|D]N\}}}|D]}ttj||ddVq|D]}ttj||ddVq:q dS)aGenerates an event list of :class:`DirCreatedEvent` and :class:`FileCreatedEvent` objects for all the files and directories within the given moved directory that were moved along with the directory. :param src_dir_path: The source path of the created directory. :returns: An iterable of file system events of type :class:`DirCreatedEvent` and :class:`FileCreatedEvent`. TrxN)rTryr-rzr{r#)r}rrr~rrsrrrrgenerate_sub_created_eventss r)&r __future__rrqos.pathrTr[Z dataclassesrrtypingrZwatchdog.utils.patternsrrr r$r"r(r*r rrr!r#r%r&r)r+r,r-r.r/r?rYrorrrrrrs@M     ULS*