Class WatchManager

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).

Parameters:

• exclude_filter (callable object) - 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.

Overrides: object.__init__

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.

Return assigned inotify's file descriptor.

Returns: int

File descriptor.

Get watch from provided watch descriptor wd.

Parameters:

• wd (int) - Watch descriptor.

Remove watch entry associated to watch descriptor wd.

Parameters:

• wd (int) - Watch descriptor.

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. Ideally |path| components should not be unicode objects. Note that although unicode paths are accepted there are converted to byte strings before a watch is put on that path. The encoding used for converting the unicode object is given by sys.getfilesystemencoding(). 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.

Parameters:

• path (string or list of strings) - Path to watch, the path can either be a file or a directory. Also accepts a sequence (list) of paths.
• mask (int) - Bitmask of events.
• proc_fun (function or ProcessEvent instance or instance of one of its subclasses or callable object.) - Processing object.
• rec (bool) - Recursively add watches from path on all its subdirectories, set to False by default (doesn't follows symlinks in any case).
• auto_add (bool) - 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.
• do_glob (bool) - Do globbing on pathname (see standard globbing module for more informations).
• quiet (bool) - if False raises a WatchManagerError exception on error. See example not_quiet.py.
• exclude_filter (callable object) - 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.

Returns: dict of {str: int}

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.

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.

Parameters:

• wd (int or list of int) - Watch Descriptor to update. Also accepts a list of watch descriptors.
• mask (int) - Optional new bitmask of events.
• proc_fun (function or ProcessEvent instance or instance of one of its subclasses or callable object.) - Optional new processing function.
• rec (bool) - Optionally adds watches recursively on all subdirectories contained into |wd| directory.
• auto_add (bool) - 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.
• quiet (bool) - If False raises a WatchManagerError exception on error. See example not_quiet.py

Returns: dict of {int: bool}

dict of watch descriptors associated to booleans values. True if the corresponding wd has been successfully updated, False otherwise.

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.

Parameters:

• path (str) - Path.

Returns: int or None

WD or None.

Returns the path associated to WD, if WD is unknown it returns None.

Parameters:

• wd (int) - Watch descriptor.

Returns: string or None

Path or None.

Removes watch(s).

Parameters:

• wd (int or list of int.) - Watch Descriptor of the file or directory to unwatch. Also accepts a list of WDs.
• rec (bool) - Recursively removes watches on every already watched subdirectories and subfiles.
• quiet (bool) - If False raises a WatchManagerError exception on error. See example not_quiet.py

Returns: dict of {int: bool}

dict of watch descriptors associated to booleans values. True if the corresponding wd has been successfully removed, False otherwise.

Watch a transient file, which will be created and deleted frequently over time (e.g. pid file).

Parameters:

• filename (string) - Filename.
• mask (int) - Bitmask of events, should contain IN_CREATE and IN_DELETE.
• proc_class (ProcessEvent's instance or of one of its subclasses.) - 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.

Returns: Same as add_watch().

Same as add_watch().

watches

Get a reference on the internal watch manager dictionary.

Get Method:

unreachable.watches(self) - Get a reference on the internal watch manager dictionary.

Type:

dict

ignore_events

Get Method:

get_ignore_events(self)

Set Method:

set_ignore_events(self, nval)

Delete Method:

'Make watch manager ignoring new events.'