a
]l=b°[ ã @ sð d Z G dd„ deƒZG dd„ deƒZddlZejdk r@eejƒ‚ddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZddlZddlmZ dd lmZmZ ddlZddlZddlZddlZddlZddlZzdd
lm Z W n e yþ Y n0 zddl Z ddl Z W n e y, dZ Y n0 z ddl Z W n e yR dZ Y n0 d Z!d Z"d
a#G dd„ deƒZ$G dd„ dƒZ%G dd„ de%ƒZ&G dd„ de%ƒZ'dd„ Z(e(ƒ Z)G dd„ dƒZ*dD ]Z+e*e+ƒe,ƒ e+< q¾G dd „ d ƒZ-i e-_.i e-_/e-j0 1¡ D ]J\Z2Z3e4e-e2e3ƒ e-j. 5e3¡ e3 1¡ D ] \Z6Z7e7e,ƒ e6< e6e-j/e7< q qøe d d „ e-j8 9¡ ƒZ:e:e-j.d < d e-j/e:< G d d!„ d!ƒZ;G d"d#„ d#e;ƒZG d(d)„ d)ƒZ?G d*d+„ d+e?ƒZ@G d,d-„ d-e?ƒZAG d.d/„ d/eAƒZBG d0d1„ d1eAƒZCG d2d3„ d3eAƒZDG d4d5„ d5eƒZEG d6d7„ d7ƒZFG d8d9„ d9ejGeFƒZHG d:d;„ d;ejIeFƒZJG dd?„ d?eFƒZLG d@dA„ dAƒZMG dBdC„ dCƒZNG dDdE„ dEeƒZOG dFdG„ dGƒZPG dHdI„ dIƒZQeQƒ aRG dJdK„ dKeQƒZSdLdM„ ZTdNdO„ ZUeVdPkrìeUƒ dS )QzW
pyinotify
@author: Sebastien Martini
@license: MIT License
@contact: seb@dbzteam.org
c @ s e Zd ZdZdS )ÚPyinotifyErrorz1Indicates exceptions raised by a Pyinotify class.N)Ú__name__Ú
__module__Ú __qualname__Ú__doc__© r r ú-/usr/lib/python3.9/site-packages/pyinotify.pyr s r c @ s e Zd ZdZdd„ ZdS )Ú UnsupportedPythonVersionErrorz0
Raised on unsupported Python versions.
c C s t | d| ¡ dS )zV
@param version: Current Python version
@type version: string
z6Python %s is unsupported, requires at least Python 3.0N©r Ú__init__)ÚselfÚversionr r r r
( s
ÿÿz&UnsupportedPythonVersionError.__init__N©r r r r r
r r r r r $ s r é N)é r )Údeque)ÚdatetimeÚ timedelta)Úreducez#seb@dbzteam.org (Sebastien Martini)z0.9.6Fc @ s e Zd ZdZdd„ ZdS )ÚInotifyBindingNotFoundErrorz;
Raised when no inotify support couldn't be found.
c C s d}t | |¡ d S )Nz!Couldn't find any inotify bindingr ©r Úerrr r r r
l s z$InotifyBindingNotFoundError.__init__Nr
r r r r r h s r c @ sD e Zd ZdZedd„ ƒZdd„ Zdd„ Zdd „ Zd
d „ Z d d
„ Z
dS )ÚINotifyWrapperz_
Abstract class wrapping access to inotify's functions. This is an
internal class.
c C s0 t rtƒ } | ¡ r| S tr,tƒ } | ¡ r,| S dS )zO
Factory method instanciating and returning the right wrapper.
N)ÚctypesÚ_CtypesLibcINotifyWrapperÚinitÚinotify_syscallsÚ_INotifySyscallsWrapper)Úinotifyr r r Úcreatev s zINotifyWrapper.createc C s | ¡ S )z<
Return None is no errno code is available.
)Ú
_get_errno©r r r r Ú get_errno† s zINotifyWrapper.get_errnoc C s, | ¡ }|d u rdS dt |¡tj| f S )NzErrno: no errno supportz
Errno=%s (%s))r! ÚosÚstrerrorÚerrnoÚ errorcode)r Úcoder r r Ú str_errnoŒ s zINotifyWrapper.str_errnoc C s | ¡ S ©N)Ú
_inotify_initr r r r Ú inotify_init’ s zINotifyWrapper.inotify_initc C s t |tƒsJ ‚| |||¡S r( )Ú
isinstanceÚstrÚ_inotify_add_watch©r ÚfdÚpathnameÚmaskr r r Úinotify_add_watch• s z INotifyWrapper.inotify_add_watchc C s | ||¡S r( )Ú_inotify_rm_watch©r r/ Úwdr r r Úinotify_rm_watch› s z INotifyWrapper.inotify_rm_watchN) r r r r Ú staticmethodr r! r' r* r2 r6 r r r r r q s
r c @ s< e Zd Zdd„ Zdd„ Zdd„ Zdd„ Zd d
„ Zd d „ Zd
S )r c C s
d | _ d S r( ©Ú _last_errnor r r r r
s z _INotifySyscallsWrapper.__init__c C s t sJ ‚dS )NT)r r r r r r ¤ s z _INotifySyscallsWrapper.initc C s | j S r( r8 r r r r r ¨ s z"_INotifySyscallsWrapper._get_errnoc
C s@ z t ¡ }W n. ty: } z|j| _W Y d }~dS d }~0 0 |S ©Néÿÿÿÿ)r r* ÚIOErrorr$ r9 )r r/ r r r r r) « s z%_INotifySyscallsWrapper._inotify_initc
C sF zt |||¡}W n. ty@ } z|j| _W Y d }~dS d }~0 0 |S r: )r r2 r< r$ r9 )r r/ r0 r1 r5 r r r r r- ³ s z*_INotifySyscallsWrapper._inotify_add_watchc
C sD zt ||¡}W n. ty> } z|j| _W Y d }~dS d }~0 0 |S r: )r r6 r< r$ r9 )r r/ r5 Úretr r r r r3 » s z)_INotifySyscallsWrapper._inotify_rm_watchN© r r r r
r r r) r- r3 r r r r r Ÿ s r c @ s< e Zd Zdd„ Zdd„ Zdd„ Zdd„ Zd d
„ Zd d „ Zd
S )r c C s d | _ d | _d S r( )Ú_libcÚ_get_errno_funcr r r r r
Å s z"_CtypesLibcINotifyWrapper.__init__c C sâ t sJ ‚d}tj d¡r d}d }zt j |¡}W n ttfyF Y n0 t j|dd| _ t j
| _ t | j dƒr„t | j dƒr„t | j dƒsˆd S g | j j
_t j| j j
_t jt jt jg| j j_t j| j j_t jt jg| j j_t j| j j_dS )
NÚcZfreebsdr T)Z use_errnor* r2 r6 F)r ÚsysÚplatformÚ
startswithÚutilZ find_libraryÚOSErrorr< ZCDLLr? r! r@ Úhasattrr* ÚargtypesZc_intZrestypeZc_char_pZc_uint32r2 r6 )r Z
try_libc_nameZ libc_namer r r r É s4
ÿ
þ
ÿ
z _CtypesLibcINotifyWrapper.initc C s | j s
J ‚| ¡ S r( )r@ r r r r r è s
z$_CtypesLibcINotifyWrapper._get_errnoc C s | j d usJ ‚| j ¡ S r( )r? r* r r r r r) ì s z'_CtypesLibcINotifyWrapper._inotify_initc C s6 | j d usJ ‚| t ¡ ¡}t |¡}| j |||¡S r( )r? ÚencoderB Úgetfilesystemencodingr Zcreate_string_bufferr2 r. r r r r- ð s
z,_CtypesLibcINotifyWrapper._inotify_add_watchc C s | j d usJ ‚| j ||¡S r( )r? r6 r4 r r r r3 ú s z+_CtypesLibcINotifyWrapper._inotify_rm_watchNr> r r r r r Ä s
r c C s: t d¡} t ¡ }| t d¡¡ | |¡ | d¡ | S )zInitialize logger instance.Ú pyinotifyz0[%(asctime)s %(name)s %(levelname)s] %(message)sé )ÚloggingZ getLoggerZ
StreamHandlerZ setFormatterZ FormatterZ
addHandlerÚsetLevel)ÚlogZconsole_handlerr r r Ú logger_init s
ÿ
rP c @ s: e Zd ZdZdd„ Zdd„ Zdd„ ZeeeƒZdd „ Z d
S ) Ú ProcINotifya/
Access (read, write) inotify's variables through /proc/sys/. Note that
usually it requires administrator rights to update them.
Examples:
- Read max_queued_events attribute: myvar = max_queued_events.value
- Update max_queued_events attribute: max_queued_events.value = 42
c C s d| _ || _d S )Nz/proc/sys/fs/inotify)Ú_baseÚ_attr)r Úattrr r r r
s zProcINotify.__init__c C sH t tj | j| j¡dƒ }t| ¡ ƒW d ƒ S 1 s:0 Y dS )z¨
Gets attribute's value.
@return: stored value.
@rtype: int
@raise IOError: if corresponding file in /proc/sys cannot be read.
ÚrN)Úopenr" ÚpathÚjoinrR rS ÚintÚreadline)r Úfile_objr r r Úget_val s zProcINotify.get_valc C sN t tj | j| j¡dƒ"}| t|ƒd ¡ W d ƒ n1 s@0 Y dS )zÉ
Sets new attribute's value.
@param nval: replaces current value by nval.
@type nval: int
@raise IOError: if corresponding file in /proc/sys cannot be written.
ÚwÚ
N)rV r" rW rX rR rS Úwriter, )r Únvalr[ r r r Úset_val& s zProcINotify.set_valc C s d| j | ¡ f S )Nz<%s=%d>)rS r\ r r r r Ú__repr__3 s zProcINotify.__repr__N)
r r r r r
r\ ra ÚpropertyÚvaluerb r r r r rQ s
rQ )Zmax_queued_eventsZmax_user_instancesZmax_user_watchesc
@ s\ e Zd ZdZdddddddd d
d d d
dœ ddddœdddddddœdœZdd „ ZeeƒZd S ) Ú EventsCodesaá
Set of codes corresponding to each kind of events.
Some of these flags are used to communicate with inotify, whereas
the others are sent to userspace by inotify notifying some events.
@cvar IN_ACCESS: File was accessed.
@type IN_ACCESS: int
@cvar IN_MODIFY: File was modified.
@type IN_MODIFY: int
@cvar IN_ATTRIB: Metadata changed.
@type IN_ATTRIB: int
@cvar IN_CLOSE_WRITE: Writtable file was closed.
@type IN_CLOSE_WRITE: int
@cvar IN_CLOSE_NOWRITE: Unwrittable file closed.
@type IN_CLOSE_NOWRITE: int
@cvar IN_OPEN: File was opened.
@type IN_OPEN: int
@cvar IN_MOVED_FROM: File was moved from X.
@type IN_MOVED_FROM: int
@cvar IN_MOVED_TO: File was moved to Y.
@type IN_MOVED_TO: int
@cvar IN_CREATE: Subfile was created.
@type IN_CREATE: int
@cvar IN_DELETE: Subfile was deleted.
@type IN_DELETE: int
@cvar IN_DELETE_SELF: Self (watched item itself) was deleted.
@type IN_DELETE_SELF: int
@cvar IN_MOVE_SELF: Self (watched item itself) was moved.
@type IN_MOVE_SELF: int
@cvar IN_UNMOUNT: Backing fs was unmounted.
@type IN_UNMOUNT: int
@cvar IN_Q_OVERFLOW: Event queued overflowed.
@type IN_Q_OVERFLOW: int
@cvar IN_IGNORED: File was ignored.
@type IN_IGNORED: int
@cvar IN_ONLYDIR: only watch the path if it is a directory (new
in kernel 2.6.15).
@type IN_ONLYDIR: int
@cvar IN_DONT_FOLLOW: don't follow a symlink (new in kernel 2.6.15).
IN_ONLYDIR we can make sure that we don't watch
the target of symlinks.
@type IN_DONT_FOLLOW: int
@cvar IN_EXCL_UNLINK: Events are not generated for children after they
have been unlinked from the watched directory.
(new in kernel 2.6.36).
@type IN_EXCL_UNLINK: int
@cvar IN_MASK_ADD: add to the mask of an already existing watch (new
in kernel 2.6.14).
@type IN_MASK_ADD: int
@cvar IN_ISDIR: Event occurred against dir.
@type IN_ISDIR: int
@cvar IN_ONESHOT: Only send event once.
@type IN_ONESHOT: int
@cvar ALL_EVENTS: Alias for considering all of the events.
@type ALL_EVENTS: int
é é é é é é é@ é€ é i i i ) Z IN_ACCESSZ IN_MODIFYZ IN_ATTRIBZIN_CLOSE_WRITEZIN_CLOSE_NOWRITEZIN_OPENZ
IN_MOVED_FROMZ IN_MOVED_TOÚ IN_CREATEÚ IN_DELETEÚIN_DELETE_SELFÚ IN_MOVE_SELFi i @ i € )Z
IN_UNMOUNTÚ
IN_Q_OVERFLOWÚ
IN_IGNOREDi i i i i @l )Z
IN_ONLYDIRZIN_DONT_FOLLOWZIN_EXCL_UNLINKZ IN_MASK_ADDÚIN_ISDIRZ
IN_ONESHOT)ÚOP_FLAGSZ EVENT_FLAGSZ
SPECIAL_FLAGSc C s* | }d}| t @ r | t }d}|tj| S )a>
Returns the event name associated to mask. IN_ISDIR is appended to
the result when appropriate. Note: only one event is returned, because
only one event can be raised at a given time.
@param mask: mask.
@type mask: int
@return: event name.
@rtype: str
z%sz %s|IN_ISDIR)ru re Ú
ALL_VALUES)r1 ÚmsÚnamer r r Úmaskname¡ s zEventsCodes.masknameN)r r r r ÚFLAG_COLLECTIONSrz r7 r r r r re D s8 =óýøì re c C s | |B S r( r )ÚxÚyr r r ÚÉ ó r~ Ú
ALL_EVENTSc @ s( e Zd ZdZdd„ Zdd„ Zdd„ ZdS ) Ú_Eventzw
Event structure, represent events raised by the system. This
is the base class and should be subclassed.
c C s" | ¡ D ]}t| g|¢R Ž qdS )z‹
Attach attributes (contained in dict_) to self.
@param dict_: Set of attributes.
@type dict_: dictionary
N)ÚitemsÚsetattr)r Údict_Ztplr r r r
Ô s z_Event.__init__c C s¨ d}t | j ¡ dd„ dD ]b\}}| d¡r.q|dkrFtt| |ƒƒ}nt|tƒrX|sXd}|dt |¡t
d ¡t |¡f 7 }qd
t
d ¡t | j
j¡|t
d ¡f }|S )
zS
@return: Generic event string representation.
@rtype: str
Ú c S s | d S ©Nr r ©r| r r r r~ ä r z!_Event.__repr__..©ÚkeyÚ_r1 z''z %s%s%sú=z %s%s%s %sú<ú>)ÚsortedÚ__dict__r‚ rD ÚhexÚgetattrr+ r, Ú
output_formatÚ
field_nameÚ punctuationÚ field_valueÚ
class_nameÚ __class__r )r ÚsrT rd r r r rb Þ s$
þ
ýz_Event.__repr__c C s t | ƒS r( )Úreprr r r r Ú__str__õ s z_Event.__str__N)r r r r r
rb rš r r r r r Î s
r c @ s e Zd ZdZdd„ Zdd„ ZdS )Ú _RawEventzm
Raw event, it contains only the informations provided by the system.
It doesn't infer anything.
c C s8 d| _ |||| d¡dœ}t | |¡ t t| ƒ¡ dS )aï
@param wd: Watch Descriptor.
@type wd: int
@param mask: Bitmask of events.
@type mask: int
@param cookie: Cookie.
@type cookie: int
@param name: Basename of the file or directory against which the
event was raised in case where the watched directory
is the parent directory. None if the event was raised
on the watched item itself.
@type name: string or None
Nú )r5 r1 Úcookiery )Ú_strÚrstripr r
rO Údebugr, )r r5 r1 r ry Údr r r r
þ s ý z_RawEvent.__init__c C s | j d u rt | ¡| _ | j S r( )rž r rš r r r r rš s
z_RawEvent.__str__N)r r r r r
rš r r r r r› ù s r› c @ s e Zd ZdZdd„ ZdS )ÚEventaÙ
This class contains all the useful informations about the observed
event. However, the presence of each field is not guaranteed and
depends on the type of event. In effect, some fields are irrelevant
for some kind of event (for example 'cookie' is meaningless for
IN_CREATE whereas it is mandatory for IN_MOVE_TO).
The possible fields are:
- wd (int): Watch Descriptor.
- mask (int): Mask.
- maskname (str): Readable event name.
- path (str): path of the file or directory being watched.
- name (str): Basename of the file or directory against which the
event was raised in case where the watched directory
is the parent directory. None if the event was raised
on the watched item itself. This field is always provided
even if the string is ''.
- pathname (str): Concatenation of 'path' and 'name'.
- src_pathname (str): Only present for IN_MOVED_TO events and only in
the case where IN_MOVED_FROM events are watched too. Holds the
source pathname from where pathname was moved from.
- cookie (int): Cookie.
- dir (bool): True if the event was raised against a directory.
c
C s’ t | |¡ t | j¡| _tr&| j| _z8| jrLtj
tj | j | j¡¡| _ ntj
| j ¡| _ W n. t
yŒ } zt |¡ W Y d}~n
d}~0 0 dS )zH
Concretely, this is the raw event plus inferred infos.
N)r r
re rz r1 ÚCOMPATIBILITY_MODEÚ
event_namery r" rW ÚabspathrX r0 ÚAttributeErrorrO r )r Úrawr r r r r
7 s ÿ
zEvent.__init__Nr
r r r r r¢ s r¢ c @ s e Zd ZdZdd„ ZdS )ÚProcessEventErrorzD
ProcessEventError Exception. Raised on ProcessEvent error.
c C s t | |¡ dS )zT
@param err: Exception error description.
@type err: string
Nr r r r r r
O s zProcessEventError.__init__Nr
r r r r r¨ K s r¨ c @ s e Zd ZdZdd„ Zdd„ ZdS )Ú
_ProcessEventz*
Abstract processing event class.
c C s„ |j |j t@ }tj |¡}|du r0td| ƒ‚t| d| dƒ}|durP||ƒS t| d| d¡d dƒ}|durz||ƒS | |¡S )a
To behave like a functor the object must be callable.
This method is a dispatch method. Its lookup order is:
1. process_MASKNAME method
2. process_FAMILY_NAME method
3. otherwise calls process_default
@param event: Event to be processed.
@type event: Event object
@return: By convention when used from the ProcessEvent class:
- Returning False or None (default value) means keep on
executing next chained functors (see chain.py example).
- Returning True instead means do not execute next
processing functions.
@rtype: bool
@raise ProcessEventError: Event object undispatchable,
unknown event.
NzUnknown mask 0x%08xZprocess_Z process_IN_rŠ rf ) r1 ru re rw Úgetr¨ r‘ ÚsplitÚprocess_default)r ÚeventZ
stripped_maskrz Úmethr r r Ú__call__[ s z_ProcessEvent.__call__c C s d| j j S )Nz<%s>)r— r r r r r rb ~ s z_ProcessEvent.__repr__N)r r r r r¯ rb r r r r r© W s #r© c @ sZ e Zd ZdZdd„ Zdd„ Zdd„ Zdd „ Zd
d „ Zd d
„ Z dd„ Z
dd„ Z ddd„Z dS )Ú_SysProcessEventa«
There is three kind of processing according to each event:
1. special handling (deletion from internal container, bug, ...).
2. default treatment: which is applied to the majority of events.
3. IN_ISDIR is never sent alone, he is piggybacked with a standard
event, he is not processed as the others events, instead, its
value is captured and appropriately aggregated to dst event.
c C s || _ || _i | _i | _dS )z¡
@param wm: Watch Manager.
@type wm: WatchManager instance
@param notifier: Notifier.
@type notifier: Notifier instance
N)Ú_watch_managerÚ _notifierÚ
_mv_cookieÚ_mv)r ÚwmÚnotifierr r r r
Œ s z_SysProcessEvent.__init__c C sd t ¡ }| j| jfD ]J}t| ¡ ƒD ]8}||| d tddkr$t d|| d ¡ ||= q$qdS )zh
Cleanup (delete) old (>1mn) records contained in self._mv_cookie
and self._mv.
rf )ZminuteszCleanup: deleting entry %sr N) r Únowr³ r´ ÚlistÚkeysr rO r )r Z date_cur_ÚseqÚkr r r Úcleanup™ s z_SysProcessEvent.cleanupc
C sP |j t@ rF| j |j¡}tj |j|j¡}|j rF|
|¡sF| jj }|||j |j d|j |j
d}|
|¡}|durF|dkrFtj |¡rFzxt |¡D ]h}tj ||¡}| j |¡durÀqœtj |¡rÒt} ntj |¡rœttB } nqœt|| d|ƒ}
| j |
¡ qœW n< tyD } z"d} t | t| ƒ ¡ W Y d} ~ n
d} ~ 0 0 | |¡S )zì
If the event affects a directory and the auto_add flag of the
targetted watch is set to True, a new watch is added on this
new directory, with the same attribute values than those of
this watch.
F©Úproc_funÚrecÚauto_addÚexclude_filterNr z(process_IN_CREATE, invalid directory: %s)r1 ru r± Ú get_watchr5 r" rW rX ry rÀ rÁ Ú add_watchr¾ rª ÚisdirÚlistdirÚget_wdÚisfilero r› r² Ú append_eventrF rO r r, r¬ )
r Ú raw_eventÚwatch_Z created_dirZaddwZaddw_retZcreated_dir_wdry ÚinnerÚflagsÚraweventr Úmsgr r r Úprocess_IN_CREATE¥ s< ý
ÿ
(z"_SysProcessEvent.process_IN_CREATEc C sR | j |j¡}|j}tj tj ||j¡¡}|t ¡ f| j
|j < | |d|j i¡S )zL
Map the cookie with the source path (+ date for cleaning).
r )
r± r r5 rW r" ÚnormpathrX ry r r· r³ r r¬ )r rÉ rÊ Úpath_Úsrc_pathr r r Úprocess_IN_MOVED_FROMÕ s
z&_SysProcessEvent.process_IN_MOVED_FROMc C s´ | j |j¡}|j}tj tj ||j¡¡}| j |j
¡}d|j
i}|durp|t ¡ f| j
|d < |d |d< n8|jt@ r¨|jr¨| |¡s¨| j j||j|jdd|jd | ||¡S )z^
Map the source path with the destination path (+ date for
cleaning).
r Nr Z src_pathnameTr½ )r± r r5 rW r" rÐ rX ry r³ rª r r r· r´ r1 ru rÀ rÁ rà r¾ r¬ )r rÉ rÊ rÑ Zdst_pathÚmv_Ú to_appendr r r Úprocess_IN_MOVED_TOß s"
ÿ ýz$_SysProcessEvent.process_IN_MOVED_TOc C sÎ | j |j¡}|j}| j |¡}|r€|d }||_|tjj7 }t|ƒ}| j j
¡ D ]*}|j |¡rRtj ||j|d… ¡|_qRnDt
d|j|tj tj |jtjj¡¡¡ |j d¡sÄ| jd7 _| |¡S )a
STATUS: the following bug has been fixed in recent kernels (FIXME:
which version ?). Now it raises IN_DELETE_SELF instead.
Old kernels were bugged, this event raised when the watched item
were moved, so we had to update its path, but under some circumstances
it was impossible: if its parent directory and its destination
directory wasn't watched. The kernel (see include/linux/fsnotify.h)
doesn't bring us enough informations like the destination path of
moved items.
r NzëThe pathname '%s' of this watch %s has probably changed and couldn't be updated, so it cannot be trusted anymore. To fix this error move directories/files only between watched parents directories, in this case e.g. put a watch on '%s'.z
-unknown-path)r± r r5 rW r´ rª r" ÚsepÚlenÚwatchesÚvaluesrD rX rO ÚerrorrÐ ÚpardirÚendswithr¬ )r rÉ rÊ rÒ rÔ Z dest_pathZ src_path_lenr] r r r Úprocess_IN_MOVE_SELFý s( ÿú z%_SysProcessEvent.process_IN_MOVE_SELFc C s t d|jiƒS )z{
Only signal an overflow, most of the common flags are irrelevant
for this event (path, wd, name).
r1 )r¢ r1 )r rÉ r r r Úprocess_IN_Q_OVERFLOW' s z&_SysProcessEvent.process_IN_Q_OVERFLOWc C s | |¡}| j |j¡ |S )a&
The watch descriptor raised by this event is now ignored (forever),
it can be safely deleted from the watch manager dictionary.
After this event we can be sure that neither the event queue nor
the system will raise an event associated to this wd again.
)r¬ r± Ú del_watchr5 )r rÉ Zevent_r r r Úprocess_IN_IGNORED. s
z#_SysProcessEvent.process_IN_IGNOREDNc C sp | j |j¡}|jttB @ r$|j}nt|jt@ ƒ}|j|j|j |j
|dœ}t rV||d< |durh| |¡ t
|ƒS )zÁ
Commons handling for the followings events:
IN_ACCESS, IN_MODIFY, IN_ATTRIB, IN_CLOSE_WRITE, IN_CLOSE_NOWRITE,
IN_OPEN, IN_DELETE, IN_DELETE_SELF, IN_UNMOUNT.
)r5 r1 rW ry ÚdirÚis_dirN)r± r r5 r1 rq rr râ Úboolru rW ry r£ Úupdater¢ )r rÉ rÕ rÊ Zdir_r„ r r r r¬ 9 s ü
z _SysProcessEvent.process_default)N)
r r r r r
r¼ rÏ rÓ rÖ rÞ rß rá r¬ r r r r r° ‚ s
0
* r° c @ sF e Zd ZdZdZddd„Zdd„ Zdd„ Zd d
„ Zd d „ Z d
d„ Z
dS )Ú ProcessEventaQ
Process events objects, can be specialized via subclassing, thus its
behavior can be overriden:
Note: you should not override __init__ in your subclass instead define
a my_init() method, this method will be called automatically from the
constructor of this class with its optionals parameters.
1. Provide specialized individual methods, e.g. process_IN_DELETE for
processing a precise type of event (e.g. IN_DELETE in this case).
2. Or/and provide methods for processing events by 'family', e.g.
process_IN_CLOSE method will process both IN_CLOSE_WRITE and
IN_CLOSE_NOWRITE events (if process_IN_CLOSE_WRITE and
process_IN_CLOSE_NOWRITE aren't defined though).
3. Or/and override process_default for catching and processing all
the remaining types of events.
Nc K s || _ | jf i |¤Ž dS )a
Enable chaining of ProcessEvent instances.
@param pevent: Optional callable object, will be called on event
processing (before self).
@type pevent: callable
@param kargs: This constructor is implemented as a template method
delegating its optionals keyworded arguments to the
method my_init().
@type kargs: dict
N)ÚpeventÚmy_init)r rç Úkargsr r r r
f s zProcessEvent.__init__c K s dS )a=
This method is called from ProcessEvent.__init__(). This method is
empty here and must be redefined to be useful. In effect, if you
need to specifically initialize your subclass' instance then you
just have to override this method in your subclass. Then all the
keyworded arguments passed to ProcessEvent.__init__() will be
transmitted as parameters to this method. Beware you MUST pass
keyword arguments though.
@param kargs: optional delegated arguments from __init__().
@type kargs: dict
Nr )r ré r r r rè u s
zProcessEvent.my_initc C s, d}| j d ur| |¡}|s(t | |¡S d S ©NF)rç r© r¯ )r r Z
stop_chainingr r r r¯ „ s
zProcessEvent.__call__c C s | j S r( )rç r r r r Ú
nested_pevent s zProcessEvent.nested_peventc C s t d¡ dS )a–
By default this method only reports warning messages, you can overredide
it by subclassing ProcessEvent and implement your own
process_IN_Q_OVERFLOW method. The actions you can take on receiving this
event is either to update the variable max_queued_events in order to
handle more simultaneous events or to modify your code in order to
accomplish a better filtering diminishing the number of raised events.
Because this method is defined, IN_Q_OVERFLOW will never get
transmitted as arguments to process_default calls.
@param event: IN_Q_OVERFLOW event.
@type event: dict
zEvent queue overflowed.N)rO Úwarning©r r r r r rß “ s z"ProcessEvent.process_IN_Q_OVERFLOWc C s dS )ae
Default processing event method. By default does nothing. Subclass
ProcessEvent and redefine this method in order to modify its behavior.
@param event: Event to be processed. Can be of any type of events but
IN_Q_OVERFLOW events (see method process_IN_Q_OVERFLOW).
@type event: Event instance
Nr rí r r r r¬ £ s z ProcessEvent.process_default)N) r r r r rç r
rè r¯ rë rß r¬ r r r r ræ R s
ræ c @ s" e Zd ZdZddd„Zdd„ ZdS )ÚPrintAllEventsz¡
Dummy class used to print events strings representations. For instance this
class is used from command line to print all received events to stdout.
Nc C s |du rt j}|| _dS )z~
@param out: Where events will be written.
@type out: Object providing a valid file object interface.
N)rB ÚstdoutÚ_out)r Úoutr r r rè ´ s zPrintAllEvents.my_initc C s* | j t|ƒ¡ | j d¡ | j ¡ dS )a$
Writes event string representation to file object provided to
my_init().
@param event: Event to be processed. Can be of any type of events but
IN_Q_OVERFLOW events (see method process_IN_Q_OVERFLOW).
@type event: Event instance
r^ N)rð r_ r, Úflushrí r r r r¬ ½ s z PrintAllEvents.process_default)N©r r r r rè r¬ r r r r rî ¯ s
rî c @ s e Zd ZdZdd„ Zdd„ ZdS )Ú ChainIfTruezc
Makes conditional chaining depending on the result of the nested
processing instance.
c C s
|| _ dS ©zJ
Method automatically called from base class constructor.
N©Z_func)r Úfuncr r r rè Ð s zChainIfTrue.my_initc C s | |¡ S r( rö rí r r r r¬ Ö s zChainIfTrue.process_defaultNró r r r r rô Ë s rô c @ sB e Zd ZdZdd„ Zdd„ Zdd„ Zdd „ Zd
d „ Zdd
d„Z dS )ÚStatszH
Compute and display trivial statistics about processed events.
c C s t ¡ | _i | _t ¡ | _dS rõ )ÚtimeÚ _start_timeÚ_statsÚ threadingÚLockÚ _stats_lockr r r r rè Þ s
z
Stats.my_initc C s\ | j ¡ z@|j d¡}|D ] }| j |d¡}|d | j|< q W | j ¡ n | j ¡ 0 dS )z$
Processes |event|.
ú|r rf N)rþ Úacquirerz r« rû rª Úrelease)r r Zeventsr¤ Úcountr r r r¬ æ s
zStats.process_defaultc C s2 | j ¡ z| j ¡ W | j ¡ S | j ¡ 0 d S r( )rþ r rû Úcopyr r r r r Ú _stats_copyó s
þzStats._stats_copyc C s | ¡ }tt ¡ | j ƒ}d}|dk r4t|ƒd }n€d| krHdk rbn nd|d |d f }nRd| krvdk r”n nd|d |d d f }n |dkr´d|d |d d f }||d < g }t| ¡ d
d „ d D ]&\}}| d
t |¡t
|¡f ¡ qÔdt | j j
¡d |¡f }|S )Nr… é< Zseci z %dmn%dseci€Q z%dh%dmnz%dd%dhZ ElapsedTimec S s | d S r† r r‡ r r r r~
r z Stats.__repr__..rˆ z %s=%sz<%s%s >)r rY rù rú r, rŽ r‚ Úappendr’ r“ r• r– r— r rX )r ÚstatsÚelapsedZ elapsed_strÚlÚevrd r˜ r r r rb ú s* ÿ
ÿzStats.__repr__c C sN t jt jB t jB t jB }t ||d¡}t |t| ¡ t
¡ ƒ¡ t |¡ dS )zÕ
Dumps statistics.
@param filename: filename where stats will be dumped, filename is
created and must not exist prior to this call.
@type filename: string
é€ N) r" ÚO_WRONLYÚO_CREATÚ
O_NOFOLLOWÚO_EXCLrV r_ Úbytesrš ÚlocaleÚgetpreferredencodingÚclose)r ÚfilenamerÌ r/ r r r Údump s z
Stats.dumpé- c sp | ¡ }|sdS t| ¡ ƒ}|| ‰dtt d| ¡ƒd ‰ ‡ ‡fdd„}d t|t| ¡ dd „ d
ƒ¡}|S ) Nr… z%%-26s%%-%ds%%sú@rf c s> ˆ t | d ¡t dt| d ˆ ƒ ¡t d| d d¡f S )Nr r rf z%dÚyellow)r’ r“ r• rY Úsimpler‡ ©ZfmtZunityr r r÷ ' s þzStats.__str__..funcr^ c S s | d S r† r r‡ r r r r~ + r z Stats.__str__..rˆ )
r ÚmaxrÚ rØ r’ r• rX ÚmaprŽ r‚ )r Zscaler Úmr÷ r˜ r r r rš s ÿ z
Stats.__str__N)r )
r r r r rè r¬ r rb r rš r r r r rø Ú s
rø c @ s e Zd ZdZdd„ ZdS )Ú
NotifierErrorz8
Notifier Exception. Raised on Notifier error.
c C s t | |¡ dS )zW
@param err: Exception string's description.
@type err: string
Nr r r r r r
4 s zNotifierError.__init__Nr
r r r r r / s r c @ s€ e Zd ZdZd dd„Zdd„ Zdd „ Zd d d „Zd d
d„Zdd„ Z dd„ Z
de j e j e j fdd„Z
dd„ Zd dd„Zdd„ ZdS ) ÚNotifierz.
Read notifications, process events.
Nr c C s„ || _ | j ¡ | _t ¡ | _| j | jtj¡ d| _t ƒ | _
t | j | ƒ| _ || _
|du r`tƒ | _
|| _|| _|| _d| _tƒ | _dS )aC
Initialization. read_freq, threshold and timeout parameters are used
when looping.
@param watch_manager: Watch Manager.
@type watch_manager: WatchManager instance
@param default_proc_fun: Default processing method. If None, a new
instance of PrintAllEvents will be assigned.
@type default_proc_fun: instance of ProcessEvent
@param read_freq: if read_freq == 0, events are read asap,
if read_freq is > 0, this thread sleeps
max(0, read_freq - (timeout / 1000)) seconds. But if
timeout is None it may be different because
poll is blocking waiting for something to read.
@type read_freq: int
@param threshold: File descriptor will be read only if the accumulated
size to read becomes >= threshold. If != 0, you likely
want to use it in combination with an appropriate
value for read_freq because without that you would
keep looping without really reading anything and that
until the amount of events to read is >= threshold.
At least with read_freq set you might sleep.
@type threshold: int
@param timeout: see read_freq above. If provided, it must be set in
milliseconds. See
https://docs.python.org/3/library/select.html#select.poll.poll
@type timeout: int
)r; r; NF)r± Úget_fdÚ_fdÚselectÚpollÚ_pollobjÚregisterÚPOLLINÚ_piper Ú_eventqr° Ú
_sys_proc_funÚ_default_proc_funrî Ú
_read_freqÚ
_thresholdÚ_timeoutÚ _coalesceÚsetÚ _eventset©r Ú
watch_managerÚdefault_proc_funÚ read_freqÚ thresholdÚtimeoutr r r r
A s
zNotifier.__init__c C s | j |¡ dS )z‚
Append a raw event to the event queue.
@param event: An event.
@type event: _RawEvent instance.
N)r( r rí r r r rÈ y s zNotifier.append_eventc C s | j S r( )r* r r r r r¾ ‚ s zNotifier.proc_funTc C s || _ |s| j ¡ dS )a
Coalescing events. Events are usually processed by batchs, their size
depend on various factors. Thus, before processing them, events received
from inotify are aggregated in a fifo queue. If this coalescing
option is enabled events are filtered based on their unicity, only
unique events are enqueued, doublons are discarded. An event is unique
when the combination of its fields (wd, mask, cookie, name) is unique
among events of a same batch. After a batch of events is processed any
events is accepted again. By default this option is disabled, you have
to explictly call this function to turn it on.
@param coalesce: Optional new coalescing value. True by default.
@type coalesce: Bool
N)r. r0 Úclear)r Zcoalescer r r Úcoalesce_events… s zNotifier.coalesce_eventsc
C sš z |du r| j }| j |¡}W qj tjyd } z,|jd tjkrNW Y d}~q n‚ W Y d}~q d}~0 0 qjq |r„| jd |d d krˆdS |d d tj @ S )aw
Check for new events available to read, blocks up to timeout
milliseconds.
@param timeout: If specified it overrides the corresponding instance
attribute _timeout. timeout must be sepcified in
milliseconds.
@type timeout: int
@return: New events to read.
@rtype: bool
Nr Frf )
r- r$ r# r" rÛ Úargsr$ ZEINTRr' r& )r r6 r= r r r r Ú check_events˜ s zNotifier.check_eventsc
C sb t ddg¡}t | jtj|d¡dkr*dS |d }|| jk rTt d| j|| j¡ dS zt
| j|¡}W n, t y’ } zt |ƒ‚W Y d}~n
d}~0 0 t d|¡ d}||k r^d}t
d |||| … ¡\}}} }
t
d
|
||| || |
… ¡\} | ¡ } t||| | ƒ}
| jrDt|
ƒ}|| jvrP| j |¡ | j |
¡ n | j |
¡ |||
7 }q¤dS ) zN
Read events from device, build _RawEvents, and enqueue them.
Úir rf r; NzF(fd: %d) %d bytes available to read but threshold is fixed to %d byteszEvent queue size: %drj ZiIIIz%ds)ÚarrayÚfcntlZioctlr! ÚtermiosZFIONREADr, rO r r" ÚreadÚ Exceptionr ÚstructÚunpackÚdecoder› r. r, r0 Úaddr( r )r Zbuf_Z
queue_sizerU rÎ ZrsumZs_sizer5 r1 r Z fname_lenZbnameÚunamerÍ Z raweventstrr r r Ú read_events¸ sB
þ
ÿ
ÿ zNotifier.read_eventsc C s² | j r”| j ¡ }| jjr,t dt|ƒ ¡ q | j |j¡}|du rh|j t
@ sh|j t @ s t dt|ƒ¡ q |
|¡}|rˆ|jrˆ| |¡ q | |¡ q | j
¡ | jr®| j ¡ dS )z×
Routine for processing events from queue by calling their
associated proccessing method (an instance of ProcessEvent).
It also does internal processings, to keep the system updated.
zEvent ignored: %sNz0Unable to retrieve Watch object associated to %s)r( Úpopleftr± Ú
ignore_eventsrO r r™ r r5 r1 rs rt rì r) r¾ r* r¼ r. r0 r7 )r rÉ rÊ Zreventr r r Úprocess_eventsã s&
ÿ
zNotifier.process_eventsc sÞ ˆ du r4d}t j tjd ¡p d}t j ||d ¡‰ ˆ dkrXt j ˆ ¡rXdˆ }t|ƒ‚‡‡‡fdd „}|ƒ ˆ dkrÚt jt j B t j
B t j B } t ˆ | d
¡}
t
|
ttt ¡ ƒd t ¡ ƒ¡ t |
¡ t ‡ fd d
„¡ dS )a
pid_file: file where the pid will be written. If pid_file=None the pid
is written to /var/run/.pid, if
pid_file=False no pid_file is written.
stdin, stdout, stderr: files associated to common streams.
Nz /var/run/r rK z.pidFz-Cannot daemonize: pid file %s already exists.c s¶ t ¡ } | dkrJt ¡ t ¡ } | dkr>t d¡ t d¡ qTt d¡ n
t d¡ t ˆt j¡}t |d¡ t ˆt j t j
B d¡}t |d¡ t ˆ t j t j
B d¡}t |d¡ d S )Nr ú/é r rf rg ) r" ÚforkÚsetsidÚchdirÚumaskÚ_exitrV ÚO_RDONLYÚdup2r r
)ÚpidZfd_inpZfd_outZfd_err)ÚstderrÚstdinrï r r Ú fork_daemon s
z)Notifier.__daemonize..fork_daemonr r^ c s
t ˆ ¡S r( )r" Úunlinkr )Úpid_filer r r~ 6 r z&Notifier.__daemonize..)r" rW ÚbasenamerB ÚargvrX Úlexistsr r r
r r rV r_ r r, Úgetpidr r r Úatexitr% ) r rX rU rï rT ÚdirnamerY r rV rÌ Zfd_pidr )rX rT rU rï r Z __daemonize s" ÿ
zNotifier.__daemonizec C sB | j dkr>t ¡ }| j || }|dkr>t d|¡ t |¡ d S )Nr zNow sleeping %d seconds)r+ rù rO r Úsleep)r Úref_timeZcur_timeZ sleep_amountr r r Ú_sleep8 s
zNotifier._sleepFc K sŠ |r| j f i |¤Ž zF| ¡ |dur6|| ƒdu r6W q~t ¡ }| ¡ rX| |¡ | ¡ W q tyz t d¡ Y q~Y q0 q| ¡ dS )a<
Events are read only one time every min(read_freq, timeout)
seconds at best and only if the size to read is >= threshold.
After this method returns it must not be called again for the same
instance.
@param callback: Functor called after each event processing iteration.
Expects to receive the notifier object (self) as first
parameter. If this function returns True the loop is
immediately terminated otherwise the loop method keeps
looping.
@type callback: callable object or function
@param daemonize: This thread is daemonized if set to True.
@type daemonize: boolean
@param args: Optional and relevant only if daemonize is True. Remaining
keyworded arguments are directly passed to daemonize see
__daemonize() method. If pid_file=None or is set to a
pathname the caller must ensure the file does not exist
before this method is called otherwise an exception
pyinotify.NotifierError will be raised. If pid_file=False
it is still daemonized but the pid is not written in any
file.
@type args: various
NTzPyinotify stops monitoring.)
Ú_Notifier__daemonizerI rù r: ra rF ÚKeyboardInterruptrO r Ústop)r ÚcallbackZ daemonizer9 r` r r r ÚloopA s
z
Notifier.loopc C s4 | j dur*| j | j ¡ t | j ¡ d| _ d| _dS )zÿ
Close inotify's instance (close its file descriptor).
It destroys all existing watches, pending events,...
This method is automatically called at the end of loop().
Afterward it is invalid to access this instance.
N)r! r$ Ú
unregisterr" r r) r r r r rd o s
z
Notifier.stop)Nr r N)T)N)NF)r r r r r
rÈ r¾ r8 r: rF rI r" Údevnullrb ra rf rd r r r r r < s ÿ
8
+
ÿ
8
.r c @ s2 e Zd ZdZd dd„Zdd„ Zdd „ Zd
d „ ZdS )
ÚThreadedNotifierav
This notifier inherits from threading.Thread for instanciating a separate
thread, and also inherits from Notifier, because it is a threaded notifier.
Note that every functionality provided by this class is also provided
through Notifier class. Moreover Notifier should be considered first because
it is not threaded and could be easily daemonized.
Nr c C sN t j | ¡ t ¡ | _t | |||||¡ t ¡ | _| j
| jd t j ¡ dS )ax
Initialization, initialize base classes. read_freq, threshold and
timeout parameters are used when looping.
@param watch_manager: Watch Manager.
@type watch_manager: WatchManager instance
@param default_proc_fun: Default processing method. See base class.
@type default_proc_fun: instance of ProcessEvent
@param read_freq: if read_freq == 0, events are read asap,
if read_freq is > 0, this thread sleeps
max(0, read_freq - (timeout / 1000)) seconds.
@type read_freq: int
@param threshold: File descriptor will be read only if the accumulated
size to read becomes >= threshold. If != 0, you likely
want to use it in combination with an appropriate
value set for read_freq because without that you would
keep looping without really reading anything and that
until the amount of events to read is >= threshold. At
least with read_freq you might sleep.
@type threshold: int
@param timeout: see read_freq above. If provided, it must be set in
milliseconds. See
https://docs.python.org/3/library/select.html#select.poll.poll
@type timeout: int
r N)
rü ÚThreadr
r¢ Ú _stop_eventr r" Úpiper' r$ r% r" r& r1 r r r r
† s
ÿ
zThreadedNotifier.__init__c C sh | j ¡ t | jd d¡ tj | ¡ t | ¡ | j
| jd ¡ t | jd ¡ t | jd ¡ dS )zK
Stop notifier's loop. Stop notification. Join the thread.
rf s stopr N)
rk r/ r" r_ r' rü rj rX r rd r$ rg r r r r r rd ¬ s
zThreadedNotifier.stopc C s: | j ¡ s6| ¡ t ¡ }| ¡ r | |¡ | ¡ q dS )a
Thread's main loop. Don't meant to be called by user directly.
Call inherited start() method instead.
Events are read only once time every min(read_freq, timeout)
seconds at best and only if the size of events to read is >= threshold.
N)rk ÚisSetrI rù r: ra rF )r r` r r r rf ¸ s
zThreadedNotifier.loopc C s | ¡ dS )a
Start thread's loop: read and process events until the method
stop() is called.
Never call this method directly, instead call the start() method
inherited from threading.Thread, which then will call run() in
its turn.
N)rf r r r r ÚrunË s zThreadedNotifier.run)Nr r N)r r r r r
rd rf rn r r r r ri } s ÿ
& ri c @ s" e Zd ZdZddd„Zdd„ ZdS ) Ú
AsyncNotifierz‹
This notifier inherits from asyncore.file_dispatcher in order to be able to
use pyinotify along with the asyncore framework.
Nr c C s* t | |||||¡ tj | | j|¡ dS )zÚ
Initializes the async notifier. The only additional parameter is
'channel_map' which is the optional asyncore private map. See
Notifier class for the meaning of the others parameters.
N)r r
ÚasyncoreÚfile_dispatcherr! )r r2 r3 r4 r5 r6 Ú channel_mapr r r r
Ü s ÿzAsyncNotifier.__init__c C s | ¡ | ¡ dS )z·
When asyncore tells us we can read from the fd, we proceed processing
events. This method can be overridden for handling a notification
differently.
N)rF rI r r r r Ú handle_readè s zAsyncNotifier.handle_read)Nr r NN)r r r r r
rs r r r r ro Ö s
ÿ
ro c @ s* e Zd ZdZd
dd„Zdd„ Zdd „ ZdS ) ÚTornadoAsyncNotifierz"
Tornado ioloop adapter.
Nr c C s8 || _ || _t | |||||¡ | | j| j|j¡ dS )a?
Note that if later you must call ioloop.close() be sure to let the
default parameter to all_fds=False.
See example tornado_notifier.py for an example using this notifier.
@param ioloop: Tornado's IO loop.
@type ioloop: tornado.ioloop.IOLoop instance.
@param callback: Functor called at the end of each call to handle_read
(IOLoop's read handler). Expects to receive the
notifier object (self) as single parameter.
@type callback: callable object or function
N)Úio_loopÚhandle_read_callbackr r
Z add_handlerr! rs ZREAD) r r2 Zioloopre r3 r4 r5 r6 rr r r r r
ø s ÿz TornadoAsyncNotifier.__init__c C s | j | j¡ t | ¡ d S r( )ru Zremove_handlerr! r rd r r r r rd s zTornadoAsyncNotifier.stopc O s( | ¡ | ¡ | jdur$| | ¡ dS )z0
See comment in AsyncNotifier.
N©rF rI rv ©r r9 Úkwargsr r r rs s
z TornadoAsyncNotifier.handle_read)NNr r NN©r r r r r
rd rs r r r r rt ó s þ
rt c @ s* e Zd ZdZd
dd„Zdd„ Zdd „ ZdS ) ÚAsyncioNotifierz0
asyncio/trollius event loop adapter.
Nr c C s4 || _ || _t | |||||¡ | | j| j¡ dS )aÐ
See examples/asyncio_notifier.py for an example usage.
@param loop: asyncio or trollius event loop instance.
@type loop: asyncio.BaseEventLoop or trollius.BaseEventLoop instance.
@param callback: Functor called at the end of each call to handle_read.
Expects to receive the notifier object (self) as
single parameter.
@type callback: callable object or function
N)rf rv r r
Z
add_readerr! rs )r r2 rf re r3 r4 r5 r6 r r r r
# s ÿzAsyncioNotifier.__init__c C s | j | j¡ t | ¡ d S r( )rf Z
remove_readerr! r rd r r r r rd 7 s zAsyncioNotifier.stopc O s( | ¡ | ¡ | jd ur$| | ¡ d S r( rw rx r r r rs ; s
zAsyncioNotifier.handle_read)NNr r Nrz r r r r r{ s ÿ
r{ c @ s$ e Zd ZdZdZdd„ Zdd„ ZdS )ÚWatchzE
Represent a watch, i.e. a file or directory being watched.
)r5 rW r1 r¾ rÀ rÁ râ c C s8 || _ || _|| _|| _|| _|| _tj | j¡| _dS )a•
Initializations.
@param wd: Watch descriptor.
@type wd: int
@param path: Path of the file or directory being watched.
@type path: str
@param mask: Mask.
@type mask: int
@param proc_fun: Processing callable object.
@type proc_fun:
@param auto_add: Automatically add watches on new directories.
@type auto_add: bool
@param exclude_filter: Boolean function, used to exclude new
directories from being automatically watched.
See WatchManager.__init__
@type exclude_filter: callable object
N) r5 rW r1 r¾ rÀ rÁ r" rÄ râ )r r5 rW r1 r¾ rÀ rÁ r r r r
J s zWatch.__init__c sD d ‡ fdd„ˆ jD ƒ¡}dt d¡t ˆ jj¡|t d¡f }|S )zE
@return: String representation.
@rtype: str
ú c
s< g | ]4}| d ¡sdt |¡t d¡t tˆ |ƒ¡f ‘qS )rŠ z%s%s%sr‹ )rD r’ r“ r” r• r‘ )Ú.0rT r r r Ú
j s ü
ÿþz"Watch.__repr__..z
%s%s %s %srŒ r )rX Ú __slots__r’ r” r– r— r ©r r˜ r r r rb e s ü
ýzWatch.__repr__N)r r r r r€ r
rb r r r r r| B s r| c @ s0 e Zd ZdZdd„ Zdd„ Zdd„ Zdd „ Zd
S ) Ú
ExcludeFilterz/
ExcludeFilter is an exclusion filter.
c C sT t |tƒr| |¡}nt |tƒr&|}nt‚g | _|D ]}| j t |tj ¡¡ q4dS )aZ
Examples:
ef1 = ExcludeFilter(["/etc/rc.*", "/etc/hostname"])
ef2 = ExcludeFilter("/my/path/exclude.lst")
Where exclude.lst contains:
/etc/rc.*
/etc/hostname
Note: it is not possible to exclude a file if its encapsulating
directory is itself watched. See this issue for more details
https://github.com/seb-m/pyinotify/issues/31
@param arg_lst: is either a list of patterns or a filename from which
patterns will be loaded.
@type arg_lst: list of str or str
N)
r+ r, Ú_load_patterns_from_filer¸ Ú TypeErrorÚ_lregexr ÚreÚcompileÚUNICODE)r Zarg_lstÚlstÚregexr r r r
{ s
zExcludeFilter.__init__c C sb g }t |dƒ@}| ¡ D ]&}| ¡ }|r| d¡r4q| |¡ qW d ƒ n1 sT0 Y |S )NrU ú#)rV Ú readlinesÚstriprD r )r r r‰ r[ ÚlineÚpatternr r r rƒ — s *z&ExcludeFilter._load_patterns_from_filec C s | |¡d uS r( )Úmatch)r rŠ rW r r r Ú_match¢ s zExcludeFilter._matchc C s" | j D ]}| ||¡r dS qdS )zã
@param path: Path to match against provided regexps.
@type path: str
@return: Return True if path has been matched and should
be excluded, False otherwise.
@rtype: bool
TF)r… r‘ )r rW rŠ r r r r¯ ¥ s
zExcludeFilter.__call__N)r r r r r
rƒ r‘ r¯ r r r r r‚ w s
r‚ c @ s e Zd ZdZdd„ ZdS )ÚWatchManagerErrorzX
WatchManager Exception. Raised on error encountered on watches
operations.
c C s || _ t | |¡ dS )a
@param msg: Exception string's description.
@type msg: string
@param wmd: This dictionary contains the wd assigned to paths of the
same call for which watches were successfully added.
@type wmd: dict
N)Úwmdr@ r
)r rÎ r“ r r r r
¸ s zWatchManagerError.__init__Nr
r r r r r’ ³ s r’ c @ sÎ e Zd ZdZdd„ fdd„Zdd„ Zdd „ Zd
d „ Zd d
„ Ze dd„ ƒZ
dd„ Z dd„ Z dd„ Z
d0dd„Zdd „ Zd1d d „Zd d „ Zd!d"„ Zd#d$„ Zd%d&„ Zd2d'd(„Zd)d*„ Zd+d,„ Zd-d.„ Ze eed/ƒZdS )3Ú WatchManagera
Provide operations for watching files and directories. Its internal
dictionary is used to reference watched items. When used inside
threaded code, one must instanciate as many WatchManager instances as
there are ThreadedNotifier instances.
c C s dS rê r ©rW r r r r~ Ì r zWatchManager.c C s\ d| _ || _i | _t ¡ | _| jdu r,tƒ ‚| j ¡ | _| jdk rXd}t || j
¡ ƒ‚dS )aR
Initialization: init inotify, init watch manager dictionary.
Raise OSError if initialization fails, raise InotifyBindingNotFoundError
if no inotify binding was found (through ctypes or from direct access to
syscalls).
@param exclude_filter: boolean function, returns True if current
path must be excluded from being watched.
Convenient for providing a common exclusion
filter for every call to add_watch.
@type exclude_filter: callable object
FNr z-Cannot initialize new instance of inotify, %s) Ú_ignore_eventsÚ_exclude_filterÚ_wmdr r Ú_inotify_wrapperr r* r! rF r' )r rÁ r r r r r
Ì s
zWatchManager.__init__c C s t | j¡ dS )a
Close inotify's file descriptor, this action will also automatically
remove (i.e. stop watching) all its associated watch descriptors.
After a call to this method the WatchManager's instance become useless
and cannot be reused, a new instance must then be instanciated. It
makes sense to call this method in few situations for instance if
several independant WatchManager must be instanciated or if all watches
must be removed and no other watches need to be added.
N)r" r r! r r r r r æ s
zWatchManager.closec C s | j S )zs
Return assigned inotify's file descriptor.
@return: File descriptor.
@rtype: int
)r! r r r r r ò s zWatchManager.get_fdc C s | j |¡S )zz
Get watch from provided watch descriptor wd.
@param wd: Watch descriptor.
@type wd: int
)r˜ rª )r r5 r r r r û s zWatchManager.get_watchc
C sH z | j |= W n6 tyB } z t dt|ƒ ¡ W Y d}~n
d}~0 0 dS )zƒ
Remove watch entry associated to watch descriptor wd.
@param wd: Watch descriptor.
@type wd: int
z)Cannot delete unknown watch descriptor %sN)r˜ ÚKeyErrorrO rÛ r, )r r5 r r r r rà s zWatchManager.del_watchc C s | j S )z•
Get a reference on the internal watch manager dictionary.
@return: Internal watch manager dictionary.
@rtype: dict
)r˜ r r r r rÙ s zWatchManager.watchesc C s t j |¡S )zW
Format path to its internal (stored in watch manager) representation.
)r" rW rÐ )r rW r r r Z
__format_path s zWatchManager.__format_pathc C sj | |¡}|r |t@ s |tO }| j | j||¡}|dk r<|S t||||||d}|| j|< t d|¡ |S )z‡
Add a watch on path, build a Watch object and insert it in the
watch manager dictionary. Return the wd value.
r )r5 rW r1 r¾ rÀ rÁ zNew %s) Ú_WatchManager__format_pathro r™ r2 r! r| r˜ rO r )r rW r1 r¾ rÀ rÁ r5 Zwatchr r r Z __add_watch! s
ÿ
zWatchManager.__add_watchc C s |rt |¡S |gS d S r( )ÚglobZiglob)r rW Údo_globr r r Z__glob3 s
zWatchManager.__globNFTc
C sÀ i } |du r| j }| |¡D ]ž}
t|
tƒs4d| |< q | |
|¡D ]x} | | |¡D ]f} || ƒs®| | ||||¡ }
| | < |
dk r¶d| |
| j ¡ f }|r¢t
|¡ q¶t || ƒ‚qPd| | < qPq@q | S )an
Add watch(s) on the provided |path|(s) with associated |mask| flag
value and optionally with a processing |proc_fun| function and
recursive flag |rec| set to True.
All |path| components _must_ be str (i.e. unicode) objects.
If |path| is already watched it is ignored, but if it is called with
option rec=True a watch is put on each one of its not-watched
subdirectory.
@param path: Path to watch, the path can either be a file or a
directory. Also accepts a sequence (list) of paths.
@type path: string or list of strings
@param mask: Bitmask of events.
@type mask: int
@param proc_fun: Processing object.
@type proc_fun: function or ProcessEvent instance or instance of
one of its subclasses or callable object.
@param rec: Recursively add watches from path on all its
subdirectories, set to False by default (doesn't
follows symlinks in any case).
@type rec: bool
@param auto_add: Automatically add watches on newly created
directories in watched parent |path| directory.
If |auto_add| is True, IN_CREATE is ored with |mask|
when the watch is added.
@type auto_add: bool
@param do_glob: Do globbing on pathname (see standard globbing
module for more informations).
@type do_glob: bool
@param quiet: if False raises a WatchManagerError exception on
error. See example not_quiet.py.
@type quiet: bool
@param exclude_filter: predicate (boolean function), which returns
True if the current path must be excluded
from being watched. This argument has
precedence over exclude_filter passed to
the class' constructor.
@type exclude_filter: callable object
@return: dict of paths associated to watch descriptors. A wd value
is positive if the watch was added sucessfully, otherwise
the value is negative. If the path was invalid or was already
watched it is not included into this returned dictionary.
@rtype: dict of {str: int}
Néýÿÿÿr z$add_watch: cannot watch %s WD=%d, %séþÿÿÿ) r— Ú_WatchManager__format_paramr+ r, Ú_WatchManager__globÚ_WatchManager__walk_recÚ_WatchManager__add_watchr™ r' rO rÛ r’ )r rW r1 r¾ r¿ rÀ r ÚquietrÁ Úret_ZnpathÚapathZrpathr5 r r r r rà 9 s4 /
ý ÿÿ zWatchManager.add_watchc c s² |D ]¨}| |¡}|dur|V nqtj |¡s2qtj |¡}t|ƒ}| j ¡ D ]Z}|d j}tj ||g¡}|tj ksžt|ƒ|krPt|ƒ|krP|| tj krP|d j
V qPqdS )a(
Get every wd from self._wmd if its path is under the path of
one (at least) of those in lpath. Doesn't follow symlinks.
@param lpath: list of watch descriptor
@type lpath: list of int
@return: list of watch descriptor
@rtype: list of int
Nrf ) Úget_pathr" rW rÄ rÐ rØ r˜ r‚ Ú commonprefixr× r5 )r Zlpathr¡ ÚrootZlendÚiwdZcurZprefr r r Z
__get_sub_rec‹ s$
ÿ þzWatchManager.__get_sub_recc C s | |¡}|r| |¡}i }|D ]Ü} | | ¡}
|
r:| dk r\d| } |rRt | ¡ q t| |ƒ‚|r¼| j | j|
|¡} | dk r°d|| < d|
| | j ¡ f } |r¦t | ¡ q t| |ƒ‚| | ks¼J ‚|sÄ|rÎ| j
| }
|rØ||
_ |râ||
_ d|| < t
d| j
| ¡ q |S )a¶
Update existing watch descriptors |wd|. The |mask| value, the
processing object |proc_fun|, the recursive param |rec| and the
|auto_add| and |quiet| flags can all be updated.
@param wd: Watch Descriptor to update. Also accepts a list of
watch descriptors.
@type wd: int or list of int
@param mask: Optional new bitmask of events.
@type mask: int
@param proc_fun: Optional new processing function.
@type proc_fun: function or ProcessEvent instance or instance of
one of its subclasses or callable object.
@param rec: Optionally adds watches recursively on all
subdirectories contained into |wd| directory.
@type rec: bool
@param auto_add: Automatically adds watches on newly created
directories in the watch's path corresponding to |wd|.
If |auto_add| is True, IN_CREATE is ored with |mask|
when the watch is updated.
@type auto_add: bool
@param quiet: If False raises a WatchManagerError exception on
error. See example not_quiet.py
@type quiet: bool
@return: dict of watch descriptors associated to booleans values.
True if the corresponding wd has been successfully
updated, False otherwise.
@rtype: dict of {int: bool}
r zupdate_watch: invalid WD=%dFz(update_watch: cannot update %s WD=%d, %sTzUpdated watch - %s)r Ú_WatchManager__get_sub_recr§ rO rÛ r’ r™ r2 r! r' r˜ r¾ rÀ r )r r5 r1 r¾ r¿ rÀ r¤ Úlwdr¥ Úawdr¦ r Úwd_rÊ r r r Ú update_watch® sF
ÿÿ
zWatchManager.update_watchc c s& t |tƒr |D ]
}|V qn|V dS )zŽ
@param param: Parameter.
@type param: string or int
@return: wrap param.
@rtype: list of type(param)
N)r+ r¸ )r ZparamZp_r r r Z__format_paramö s
zWatchManager.__format_paramc C s8 | |¡}| j ¡ D ] }|d j|kr|d S qdS )aF
Returns the watch descriptor associated to path. This method
presents a prohibitive cost, always prefer to keep the WD
returned by add_watch(). If the path is unknown it returns None.
@param path: Path.
@type path: str
@return: WD or None.
@rtype: int or None
rf r N)r› r˜ r‚ rW )r rW rª r r r rÆ s
zWatchManager.get_wdc C s | j |¡}|dur|jS dS )zÐ
Returns the path associated to WD, if WD is unknown it returns None.
@param wd: Watch descriptor.
@type wd: int
@return: Path or None.
@rtype: string or None
N)r˜ rª rW )r r5 rÊ r r r r§ s zWatchManager.get_pathc c sD |r t j |¡s t j |¡s$|V n t |¡D ]\}}}|V q.dS )a3
Yields each subdirectories of top, doesn't follow symlinks.
If rec is false, only yield top.
@param top: root directory.
@type top: string
@param rec: recursive flag.
@type rec: bool
@return: path of one subdirectory.
@rtype: string
N)r" rW ÚislinkrÄ Úwalk)r Útopr¿ r© ÚdirsÚfilesr r r Z
__walk_rec s zWatchManager.__walk_recc C s¤ | |¡}|r| |¡}i }|D ]~}| j | j|¡}|dk rpd||< d|| j ¡ f }|rft |¡ q t||ƒ‚|| j v r‚| j |= d||< t
d|| |¡¡ q |S )aÈ
Removes watch(s).
@param wd: Watch Descriptor of the file or directory to unwatch.
Also accepts a list of WDs.
@type wd: int or list of int.
@param rec: Recursively removes watches on every already watched
subdirectories and subfiles.
@type rec: bool
@param quiet: If False raises a WatchManagerError exception on
error. See example not_quiet.py
@type quiet: bool
@return: dict of watch descriptors associated to booleans values.
True if the corresponding wd has been successfully
removed, False otherwise.
@rtype: dict of {int: bool}
r Fz!rm_watch: cannot remove WD=%d, %sTzWatch WD=%d (%s) removed) r r« r™ r6 r! r' rO rÛ r’ r˜ r r§ ) r r5 r¿ r¤ r¬ r¥ r r® r r r r Úrm_watch2 s(
ÿ
zWatchManager.rm_watchc sb t j |¡}|dkri S t j |¡‰ |ttB O }‡ fdd„}| j|||t|dƒddddd„ dS ) ad
Watch a transient file, which will be created and deleted frequently
over time (e.g. pid file).
@attention: Currently under the call to this function it is not
possible to correctly watch the events triggered into the same
base directory than the directory where is located this watched
transient file. For instance it would be wrong to make these
two successive calls: wm.watch_transient_file('/var/run/foo.pid', ...)
and wm.add_watch('/var/run/', ...)
@param filename: Filename.
@type filename: string
@param mask: Bitmask of events, should contain IN_CREATE and IN_DELETE.
@type mask: int
@param proc_class: ProcessEvent (or of one of its subclass), beware of
accepting a ProcessEvent's instance as argument into
__init__, see transient_file.py example for more
details.
@type proc_class: ProcessEvent's instance or of one of its subclasses.
@return: Same as add_watch().
@rtype: Same as add_watch().
r… c s t | dƒd u rdS ˆ | jkS )Nry F)r‘ ry )r ©rY r r Úcmp_name| s z3WatchManager.watch_transient_file..cmp_name)r÷ Fc S s dS rê r r• r r r r~ „ r z3WatchManager.watch_transient_file..)r¾ r¿ rÀ r rÁ )r" rW r^ rY ro rp rà rô )r r r1 Z
proc_classr^ r· r r¶ r Úwatch_transient_file] s üz!WatchManager.watch_transient_filec C s | j S r( ©r– r r r r Úget_ignore_events† s z WatchManager.get_ignore_eventsc C s
|| _ d S r( r¹ )r r` r r r Úset_ignore_events‰ s z WatchManager.set_ignore_eventsz'Make watch manager ignoring new events.)NFFFTN)NNFFT)FT)r r r r r
r r r rà rc rÙ r› r£ r¡ rà r« r¯ r rÆ r§ r¢ rµ r¸ rº r» rH r r r r r” Ä s<
þ
R# ÿ
H
+)ÿr” c @ sB e Zd ZdZddd„Zdd„ Zdd„ Zd d
„ Zd d „ Zd
d„ Z dS )ÚRawOutputFormatz(
Format string representations.
Nc C s |pi | _ d S r( )Úformat)r r½ r r r r
” s zRawOutputFormat.__init__c C s2 t |tƒst|ƒ}| j |d¡| | j dd¡ S )Nr… Únormal)r+ r, r½ rª )r r˜ Z attributer r r r — s
ÿzRawOutputFormat.simplec C s | |d¡S )zPunctuation color.r¾ ©r r r r r r” s zRawOutputFormat.punctuationc C s | |d¡S )zField value color.Úpurpler¿ r r r r r• ¡ s zRawOutputFormat.field_valuec C s | |d¡S )zField name color.Úbluer¿ r r r r r“ ¥ s zRawOutputFormat.field_namec C s | j dd¡| |d¡ S )zClass name color.Úredr… Úbold)r½ rª r r r r r r– © s zRawOutputFormat.class_name)N)
r r r r r
r r” r• r“ r– r r r r r¼ s
r¼ c @ s e Zd ZdZdd„ ZdS )ÚColoredOutputFormatz0
Format colored string representations.
c
C s. ddddddddd d
d d d
œ }t | |¡ d S )Nz[0mz[30mz[31mz[32mz[33mz[34mz[35mz[36mz[1mz[4mz[5mz[7m) r¾ Zblackr Zgreenr rÁ rÀ Zcyanrà ZulineZblinkÚinvert)r¼ r
)r Úfr r r r
³ s õ z ColoredOutputFormat.__init__Nr
r r r r rÄ ¯ s rÄ c C s< t tdtƒ tƒ D ] } | d¡rt t| tƒ | ƒ qdadS )a·
Use this function to turn on the compatibility mode. The compatibility
mode is used to improve compatibility with Pyinotify 0.7.1 (or older)
programs. The compatibility mode provides additional variables 'is_dir',
'event_name', 'EventsCodes.IN_*' and 'EventsCodes.ALL_EVENTS' as
Pyinotify 0.7.1 provided. Do not call this function from new programs!!
Especially if there are developped for Pyinotify >= 0.8.x.
r€ ZIN_TN)rƒ re r€ ÚglobalsrD r£ )Zevnamer r r Úcompatibility_modeà s
rÈ c
s
ddl m} d}| |d}|jddddd d
|jd d dd
dd
|jdddddd
|jdddddd
|jdddddd |jd d dd d d
|jd!d"dd#d$d
|jd%d&dd'd(d
|jd)d*d+d,d-d
| ¡ \‰ }ˆ jrêt d.¡ ˆ jrøtt ƒ ˆ j
st ƒ a t
|ƒd/k rd0}n|}tƒ }ˆ jr>t|tƒ d1d2}nt|tƒ d3}d}ˆ jržˆ j d4¡}|D ]2} tj | d¡}
|
rŠ||
O }n| d5| ¡ qhnt}d6} ˆ jrºd7d8„ } | } ˆ jrÒ‡ fd9d8„} | } t d:| ¡ |j ||ˆ j ˆ j ˆ j d; |j | d< d6S )=z‘
By default the watched path is '/tmp' and all types of events are
monitored. Events monitoring serves forever, type c^c to stop it.
r )Ú OptionParserz.usage: %prog [options] [path1] [path2] [pathn])Úusagez-vz --verboseÚ
store_trueÚverbosez Verbose mode)ÚactionÚdestÚhelpz-rz --recursiveÚ recursivez Add watches recursively on pathsz-az
--auto_addrÀ z,Automatically add watches on new directoriesz-gz--globrœ zTreat paths as globsz-ez
--events-listz EVENT[,...]Ú events_listzpA comma-separated list of events to watch for - see the documentation for valid options (defaults to everything))ÚmetavarrÎ rÏ z-sz--statsr zDisplay dummy statisticsz-Vz --versionr zPyinotify versionz-fz --raw-formatÚ
raw_formatz Disable enhanced output format.z-cz --commandÚstoreÚcommandz Shell command to run upon eventé
rf z/tmpé )r3 r4 )r3 ú,z4The event '%s' specified with option -e is not validNc S sN t j t| ¡ ƒ¡ t j d¡ t j t| ¡ ƒ¡ t j d¡ t j ¡ d S )Nr^ )rB rï r_ r™ r¾ r, rò ©r˜ r r r Úcb$ s
zcommand_line..cbc s t jˆ jdd d S )NT)Úshell)Ú
subprocessÚPopenrÕ rÙ ©Úoptionsr r rÚ . s z2Start monitoring %s, (press c^c to halt pyinotify))r¿ rÀ r )re )!ZoptparserÉ Z
add_optionÚ
parse_argsrÌ rO rN r ÚprintÚ __version__rÓ rÄ r’ rØ r” r r rø rî rÑ r« re Ú ALL_FLAGSrª rÛ r€ rÕ r rà rÐ rÀ rœ rf )
rÉ rÊ Úparserr9 rW rµ r¶ r1 rÑ r
ZevcodeZcb_funrÚ r rÞ r Ú command_lineÔ s
ÿ
þ
þ
þ
þ
þ
ÿ
þ
þ
ÿ rå Ú__main__)Wr r@ r r rB Ú version_infor rü r" r" rA r= r$ r> r< rM r] Ú collectionsr r r rù r† rp rœ r rÜ Ú functoolsr Ú ImportErrorr Z ctypes.utilr Ú
__author__râ r£ r r r r rP rO rQ ÚattrnamerÇ re rã rw r{ r‚ ZflagcZvalcrƒ rå ry Úvalrv rÚ r€ r r› r¢ r¨ r© r° ræ rî rô rø r r rj ri rq ro rt r{ r| r‚ r’ r” r¼ r’ rÄ rÈ rå r r r r r Ú sº
.%<
2s
+$. + Q] U
CY *%5< O e