Your IP : 172.28.240.42
Mc @ sc d Z d d l Z d d l Z d d l m Z d d l m Z d d l m Z m Z d Z
d Z d Z d Z
d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z e
e BZ e e BZ e e BZ e e Be Be Be Be Be Be Be BZ! e
d f e d f e d f e
d f e d f e d f e d f e d! f e d" f e d# f e d$ f e d% f e d& f e d' f e d( f e d) f e d* f e d+ f e d, f e d- f g Z" d. Z# d/ e$ f d0 YZ% d1 e e$ f d2 YZ& e j' Z' d1 d3 d4 d5 d6 d7 d8 d9 d: d; d< d= d> d? d@ dA dB dC dD dE dF dG dH dI dJ dK g Z( d S(L s
This module provides support for Twisted to linux inotify API.
In order to use this support, simply do the following (and start a reactor
at some point)::
from twisted.internet import inotify
from twisted.python import filepath
def notify(ignored, filepath, mask):
"""
For historical reasons, an opaque handle is passed as first
parameter. This object should never be used.
@param filepath: FilePath on which the event happened.
@param mask: inotify event as hexadecimal masks
"""
print "event %s on %s" % (
', '.join(inotify.humanReadableMask(mask)), filepath)
notifier = inotify.INotify()
notifier.startReading()
notifier.watch(filepath.FilePath("/some/directory"), callbacks=[notify])
@since: 10.1
iN( t fdesc( t FileDescriptor( t logt _inotifyl l l l l l l @ l l l l l l l @l i i i i @I t accesst modifyt attribt close_writet
close_nowritet opent
moved_fromt moved_tot createt deletet delete_selft move_selft unmountt queue_overflowt ignoredt only_dirt dont_followt mask_addt is_dirt one_shotc C s; g } x. t D]& \ } } | | @r
| j | q
q
W| S( si
Auxiliary function that converts an hexadecimal mask into a series
of human readable flags.
( t _FLAG_TO_HUMANt append( t maskt st kt v( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt humanReadableMaskc s
t _Watchc B s) e Z d Z e e d d Z d Z RS( s
Watch object that represents a Watch point in the filesystem. The
user should let INotify to create these objects
@ivar path: The path over which this watch point is monitoring
@ivar mask: The events monitored by this watchpoint
@ivar autoAdd: Flag that determines whether this watch point
should automatically add created subdirectories
@ivar callbacks: C{list} of callback functions that will be called
when an event occurs on this watch.
c C s= | | _ | | _ | | _ | d k r0 g } n | | _ d S( N( t pathR t autoAddt Nonet callbacks( t selfR R R! R# ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt __init__| s c C s( x! | j D] } | | | | q
Wd S( sL
Callback function used by L{INotify} to dispatch an event.
N( R# ( R$ t filepatht eventst callback( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt _notify s N( t __name__t
__module__t __doc__t
IN_WATCH_MASKt FalseR" R% R) ( ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyR p s t INotifyc B s e Z d Z e Z d d Z d Z d Z d Z d Z d Z
d Z d Z e
e d e d Z d
Z d Z RS(
s
The INotify file descriptor, it basically does everything related
to INotify, from reading to notifying watch points.
@ivar _buffer: a C{str} containing the data read from the inotify fd.
@ivar _watchpoints: a C{dict} that maps from inotify watch ids to
watchpoints objects
@ivar _watchpaths: a C{dict} that maps from watched paths to the
inotify watch ids
c C sv t j | d | | j j | _ t j | j t j | j d | _ t | _
d | _ i | _ i | _
d S( Nt reactori t ( R R% R t initt _fdR t setNonBlockingt _setCloseOnExect connectedt Truet _writeDisconnectedt _buffert _watchpointst _watchpaths( R$ R0 ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyR% s c C sQ | j j | j | j | } t | | | | } | | j | <| | j | <| S( s~
Private helper that abstracts the use of ctypes.
Calls the internal inotify API and checks for any errors after the
call. If there's an error L{INotify._addWatch} can raise an
INotifyError. If there's no error it proceeds creating a watchpoint and
adding a watchpath for inverse lookup of the file descriptor from the
path.
( R t addR3 R R R: R; ( R$ R R R! R# t wdt iwp( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt _addWatch s
c C s? | j j | j | | j j | } | j j | j d S( s
Private helper that abstracts the use of ctypes.
Calls the internal inotify API to remove an fd from inotify then
removes the corresponding watchpoint from the internal mapping together
with the file descriptor from the watchpath.
N( R t removeR3 R: t popR; R ( R$ R= R> ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt _rmWatch s c C s` t j | | | j d k r\ y t j | j Wq\ t k
rX } t j | d q\ Xn d S( sR
Release the inotify file descriptor and do the necessary cleanup
i s' Couldn't close INotify file descriptor.N( R t connectionLostR3 t ost closet OSErrorR t err( R$ t reasont e( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyRC s c C s | j S( s
Get the underlying file descriptor from this inotify observer.
Required by L{abstract.FileDescriptor} subclasses.
( R3 ( R$ ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt fileno s c C s t j | j | j d S( sC
Read some data from the observed file descriptors
N( R t
readFromFDR3 t _doRead( R$ ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt doRead s c
C sq | j | 7_ x[t | j d k rlt j d | j d d ! \ } } } } | ru | j d d | !j d } n d } | j d | | _ y | j | } Wn t k
r q n X| j } | r | j | } n | j
| | | j rO| t @rO| t
@rO| j | d | j d t d | j } | j j d | j | j | n | t @r | j | q q Wd S( sF
Work on the data just read from the file descriptor.
i s =LLLLi t R R! R# N( R9 t lent structt unpackt rstripR" R: t KeyErrorR t childR) R! t IN_ISDIRt IN_CREATEt watchR R7 R# R0 t callLatert _addChildrent IN_DELETE_SELFRB (
R$ t in_R= R t cookiet sizet nameR> R t new_wd( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyRL s. (
c C s y | j j } Wn t k
r' d SXx | D] } | j r | j | d | j d t d | j } | j | t t
B | j j d | j
| j | n | j r/ | j | t
t B q/ q/ Wd S( s
This is a very private method, please don't even think about using it.
Note that this is a fricking hack... it's because we cannot be fast
enough in adding a watch to a directory and so we basically end up
getting here too late if some operations have already been going on in
the subdir, we basically need to catchup. This eventually ends up
meaning that we generate double events, your app must be resistant.
NR R! R# i ( R t childrenRF t isdirRW R R7 R# R) RU RV R0 RX RY R: t isfilet IN_CLOSE_WRITE( R$ R> t listdirt fR= ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyRY s
c C s | rK x{ | j D]1 } | j r | j | | | | d t q q Wn9 | j | } | rd | S| t B} | j | | | | Sd S( sR
Watch the 'mask' events in given path. Can raise C{INotifyError} when
there's a problem while adding a directory.
@param path: The path needing monitoring
@type path: L{FilePath}
@param mask: The events that should be watched
@type mask: C{int}
@param autoAdd: if True automatically add newly created
subdirectories
@type autoAdd: C{boolean}
@param callbacks: A list of callbacks that should be called
when an event happens in the given path.
The callback should accept 3 arguments:
(ignored, filepath, mask)
@type callbacks: C{list} of callables
@param recursive: Also add all the subdirectories in this path
@type recursive: C{boolean}
t recursiveN( t walkRa RW R. t
_isWatchedRZ R? ( R$ R R R! R# Rf RT R= ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyRW E s
c C sB | j | } | d k r1 t d | f n
| j | d S( s
Remove the watch point monitoring the given path
@param path: The path that should be ignored
@type path: L{FilePath}
s %r is not watchedN( Rh R" RS RB ( R$ R R= ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt ignores s c C s | j j | d S( s
Helper function that checks if the path is already monitored
and returns its watchdescriptor if so or None otherwise.
@param path: The path that should be checked
@type path: L{FilePath}
N( R; t getR" ( R$ R ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyRh s N( R* R+ R, R R" R% R? RB RC RJ RM RL RY R- R. RW Ri Rh ( ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyR/ s
. '- R R- t IN_ACCESSt IN_MODIFYt IN_ATTRIBt IN_CLOSE_NOWRITERc t IN_OPENt
IN_MOVED_FROMt IN_MOVED_TORV t IN_DELETERZ t IN_MOVE_SELFt
IN_UNMOUNTt
IN_Q_OVERFLOWt
IN_IGNOREDt
IN_ONLYDIRt IN_DONT_FOLLOWt IN_MASK_ADDRU t
IN_ONESHOTt IN_CLOSEt IN_MOVEDt
IN_CHANGED() R, RD RP t twisted.internetR t twisted.internet.abstractR t twisted.pythonR R Rk Rl Rm Rc Rn Ro Rp Rq RV Rr RZ Rs Rt Ru Rv Rw Rx Ry RU Rz R{ R| R} R- R R t objectR R/ t INotifyErrort __all__( ( ( s< /usr/lib/python2.7/dist-packages/twisted/internet/inotify.pyt <module> sx
&