watchdog Documentation Release 0.9.0
Yesudeep Mangalapilly
Oct 30, 2019
Contents
1 Directory monitoring made easy with3
2 Easy installation 5
3 User’s Guide 7 3.1 Installation...... 7 3.2 Quickstart...... 10 3.3 API Reference...... 10 3.4 Contributing...... 21
4 Contribute 23
5 Indices and tables 25
Python Module Index 27
Index 29
i ii watchdog Documentation, Release 0.9.0
Python API library and shell utilities to monitor file system events. Works on Python 2.7 and 3.4+. If you want to use an old version of Python, you should stick with watchdog < 0.10.0.
Contents 1 watchdog Documentation, Release 0.9.0
2 Contents CHAPTER 1
Directory monitoring made easy with
• A cross-platform API. • A shell tool to run commands in response to directory changes. Get started quickly with a simple example in Quickstart.
3 watchdog Documentation, Release 0.9.0
4 Chapter 1. Directory monitoring made easy with CHAPTER 2
Easy installation
You can use pip to install watchdog quickly and easily:
$ pip install watchdog
Need more help with installing? See Installation.
5 watchdog Documentation, Release 0.9.0
6 Chapter 2. Easy installation CHAPTER 3
User’s Guide
3.1 Installation watchdog requires Python 2.7 or 3.4+ to work. If you are using a Linux/FreeBSD/Mac OS X system, you already have Python installed. However, you may wish to upgrade your system to Python 2.7 at least, because this version comes with updates that can reduce compatibility problems. See a list of Dependencies.
3.1.1 Installing from PyPI using pip
$ python -m pip install watchdog
# or to install the watchmedo utility: $ python -m pip install |project_name|[watchmedo]
3.1.2 Installing from source tarballs
$ wget -c http://pypi.python.org/packages/source/w/watchdog/watchdog-0.9.0.
˓→tar.gz $ tar zxvf watchdog-0.9.0.tar.gz $ cd watchdog-0.9.0 $ python -m pip install -e .
# or to install the watchmedo utility: $ python -m pip install -e .[watchmedo]
3.1.3 Installing from the code repository
7 watchdog Documentation, Release 0.9.0
$ git clone --recursive git://github.com/gorakhargosh/watchdog.git $ cd watchdog $ python -m pip install -e.
# or to install the watchmedo utility: $ python -m pip install -e.[watchmedo]
3.1.4 Dependencies watchdog depends on many libraries to do its job. The following is a list of dependencies you need based on the operating system you are using.
Operating system Windows Linux 2.6 BSD Mac OS X/ Dependency (row) Darwin
XCode Yes pathtools Yes Yes Yes Yes
The following is a list of dependencies you need based on the operating system you are using the watchmedo utility.
Operating system Windows Linux 2.6 BSD Mac OS X/ Dependency (row) Darwin
PyYAML Yes Yes Yes Yes argh Yes Yes Yes Yes
Installing Dependencies
The watchmedo script depends on PyYAML which links with LibYAML. On Mac OS X, you can use homebrew to install LibYAML: brew install libyaml
On Linux, use your favorite package manager to install LibYAML. Here’s how you do it on Ubuntu: sudo aptitude install libyaml-dev
On Windows, please install PyYAML using the binaries they provide.
3.1.5 Supported Platforms (and Caveats) watchdog uses native APIs as much as possible falling back to polling the disk periodically to compare directory snapshots only when it cannot use an API natively-provided by the underlying operating system. The following operating systems are currently supported:
Warning: Differences between behaviors of these native API are noted below.
8 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
Linux 2.6+ Linux kernel version 2.6 and later come with an API called inotify that programs can use to monitor file system events.
Note: On most systems the maximum number of watches that can be created per user is limited to 8192. watchdog needs one per directory to monitor. To change this limit, edit /etc/sysctl.conf and add:
fs.inotify.max_user_watches=16384
Mac OS X The Darwin kernel/OS X API maintains two ways to monitor directories for file system events: • kqueue • FSEvents watchdog can use whichever one is available, preferring FSEvents over kqueue(2). kqueue(2) uses open file descriptors for monitoring and the current implementation uses Mac OS X File System Monitoring Performance Guidelines to open these file descriptors only to monitor events, thus allowing OS X to unmount volumes that are being watched without locking them.
Note: More information about how watchdog uses kqueue(2) is noted in BSD Unix variants. Much of this information applies to Mac OS X as well.
BSD Unix variants BSD variants come with kqueue which programs can use to monitor changes to open file descrip- tors. Because of the way kqueue(2) works, watchdog needs to open these files and directories in read-only non-blocking mode and keep books about them. watchdog will automatically open file descriptors for all new files/directories created and close those for which are deleted.
Note: The maximum number of open file descriptor per process limit on your operating system can hinder watchdog’s ability to monitor files. You should ensure this limit is set to at least 1024 (or a value suitable to your usage). The following command appended to your ~/.profile configuration file does this for you:
ulimit-n 1024
Windows Vista and later The Windows API provides the ReadDirectoryChangesW. watchdog currently contains implementation for a synchronous approach requiring additional API functionality only available in Windows Vista and later.
Note: Since renaming is not the same operation as movement on Windows, watchdog tries hard to convert re- names to movement events. Also, because the ReadDirectoryChangesW API function returns rename/movement events for directories even before the underlying I/O is complete, watchdog may not be able to completely scan the moved directory in order to successfully queue movement events for files and directories within it.
Note: Since the Windows API does not provide information about whether an object is a file or a directory, delete events for directories may be reported as a file deleted event.
OS Independent Polling watchdog also includes a fallback-implementation that polls watched directories for changes by periodically comparing snapshots of the directory tree.
3.1. Installation 9 watchdog Documentation, Release 0.9.0
3.2 Quickstart
Below we present a simple example that monitors the current directory recursively (which means, it will traverse any sub-directories) to detect changes. Here is what we will do with the API: 1. Create an instance of the watchdog.observers.Observer thread class. 2. Implement a subclass of watchdog.events.FileSystemEventHandler (or as in our case, we will use the built-in watchdog.events.LoggingEventHandler, which already does). 3. Schedule monitoring a few paths with the observer instance attaching the event handler. 4. Start the observer thread and wait for it generate events without blocking our main thread. By default, an watchdog.observers.Observer instance will not monitor sub-directories. By passing recursive=True in the call to watchdog.observers.Observer.schedule() monitoring entire direc- tory trees is ensured.
3.2.1 A Simple Example
The following example program will monitor the current directory recursively for file system changes and simply log them to the console: import sys import logging from watchdog.observers import Observer from watchdog.events import LoggingEventHandler if __name__ =="__main__": logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(message)s', datefmt='%Y-%m-%d %H:%M:%S') path= sys.argv[1] if len(sys.argv)>1 else '.' event_handler= LoggingEventHandler() observer= Observer() observer.schedule(event_handler, path, recursive=True) observer.start() try: while observer.isAlive(): observer.join(1) except KeyboardInterrupt: observer.stop() observer.join()
To stop the program, press Control-C.
3.3 API Reference
3.3.1 watchdog.events
module watchdog.events synopsis File system events and event handlers. author [email protected] (Yesudeep Mangalapilly)
10 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
Event Classes
class watchdog.events.FileSystemEvent(src_path) Bases: object Immutable 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. event_type = None The type of the event as a string. is_directory = False True if event was emitted for a directory; False otherwise. is_synthetic = False True if event was synthesized; False otherwise. These are events that weren’t actually broadcast by the OS, but are presumed to have happened based on other, actual events. src_path Source path of the file system object that triggered this event. class watchdog.events.FileSystemMovedEvent(src_path, dest_path) Bases: watchdog.events.FileSystemEvent File system event representing any kind of file system movement. dest_path The destination path of the move event. class watchdog.events.FileMovedEvent(src_path, dest_path) Bases: watchdog.events.FileSystemMovedEvent File system event representing file movement on the file system. class watchdog.events.DirMovedEvent(src_path, dest_path) Bases: watchdog.events.FileSystemMovedEvent File system event representing directory movement on the file system. class watchdog.events.FileModifiedEvent(src_path) Bases: watchdog.events.FileSystemEvent File system event representing file modification on the file system. class watchdog.events.DirModifiedEvent(src_path) Bases: watchdog.events.FileSystemEvent File system event representing directory modification on the file system. class watchdog.events.FileCreatedEvent(src_path) Bases: watchdog.events.FileSystemEvent File system event representing file creation on the file system. class watchdog.events.DirCreatedEvent(src_path) Bases: watchdog.events.FileSystemEvent File system event representing directory creation on the file system.
3.3. API Reference 11 watchdog Documentation, Release 0.9.0 class watchdog.events.FileDeletedEvent(src_path) Bases: watchdog.events.FileSystemEvent File system event representing file deletion on the file system. class watchdog.events.DirDeletedEvent(src_path) Bases: watchdog.events.FileSystemEvent File system event representing directory deletion on the file system.
Event Handler Classes class watchdog.events.FileSystemEventHandler Bases: object Base file system event handler that you can override methods from. dispatch(event) Dispatches events to the appropriate methods. Parameters event (FileSystemEvent) – The event object representing the file system event. on_any_event(event) Catch-all event handler. Parameters event (FileSystemEvent) – The event object representing the file system event. on_created(event) Called when a file or directory is created. Parameters event (DirCreatedEvent or FileCreatedEvent) – Event representing file/directory creation. on_deleted(event) Called when a file or directory is deleted. Parameters event (DirDeletedEvent or FileDeletedEvent) – Event representing file/directory deletion. on_modified(event) Called when a file or directory is modified. Parameters event (DirModifiedEvent or FileModifiedEvent) – Event represent- ing file/directory modification. on_moved(event) Called when a file or a directory is moved or renamed. Parameters event (DirMovedEvent or FileMovedEvent) – Event representing file/directory movement. class watchdog.events.PatternMatchingEventHandler(patterns=None, ig- nore_patterns=None, ig- nore_directories=False, case_sensitive=False) Bases: watchdog.events.FileSystemEventHandler Matches given patterns with file paths associated with occurring events. case_sensitive (Read-only) True if path names should be matched sensitive to case; False otherwise.
12 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
dispatch(event) Dispatches events to the appropriate methods. Parameters event (FileSystemEvent) – The event object representing the file system event. ignore_directories (Read-only) True if directories should be ignored; False otherwise. ignore_patterns (Read-only) Patterns to ignore matching event paths. patterns (Read-only) Patterns to allow matching event paths. class watchdog.events.RegexMatchingEventHandler(regexes=[’.*’], ignore_regexes=[], ignore_directories=False, case_sensitive=False) Bases: watchdog.events.FileSystemEventHandler Matches given regexes with file paths associated with occurring events. case_sensitive (Read-only) True if path names should be matched sensitive to case; False otherwise. dispatch(event) Dispatches events to the appropriate methods. Parameters event (FileSystemEvent) – The event object representing the file system event. ignore_directories (Read-only) True if directories should be ignored; False otherwise. ignore_regexes (Read-only) Regexes to ignore matching event paths. regexes (Read-only) Regexes to allow matching event paths. class watchdog.events.LoggingEventHandler Bases: watchdog.events.FileSystemEventHandler Logs all the events captured. on_created(event) Called when a file or directory is created. Parameters event (DirCreatedEvent or FileCreatedEvent) – Event representing file/directory creation. on_deleted(event) Called when a file or directory is deleted. Parameters event (DirDeletedEvent or FileDeletedEvent) – Event representing file/directory deletion. on_modified(event) Called when a file or directory is modified. Parameters event (DirModifiedEvent or FileModifiedEvent) – Event represent- ing file/directory modification. on_moved(event) Called when a file or a directory is moved or renamed.
3.3. API Reference 13 watchdog Documentation, Release 0.9.0
Parameters event (DirMovedEvent or FileMovedEvent) – Event representing file/directory movement.
3.3.2 watchdog.observers.api
Immutables class watchdog.observers.api.ObservedWatch(path, recursive) Bases: object An scheduled watch. Parameters • path – Path string. • recursive – True if watch is recursive; False otherwise. is_recursive Determines whether subdirectories are watched for the path. path The path that this watch monitors.
Collections class watchdog.observers.api.EventQueue(maxsize=0) Bases: watchdog.utils.bricks.SkipRepeatsQueue Thread-safe event queue based on a special queue that skips adding the same event (FileSystemEvent) multiple times consecutively. Thus avoiding dispatching multiple event handling calls when multiple identical events are produced quicker than an observer can consume them.
Classes class watchdog.observers.api.EventEmitter(event_queue, watch, timeout=1) Bases: watchdog.utils.BaseThread Producer thread base class subclassed by event emitters that generate events and populate a queue with them. Parameters • event_queue (watchdog.events.EventQueue) – The event queue to populate with generated events. • watch (ObservedWatch) – The watch to observe and produce events for. • timeout (float) – Timeout (in seconds) between successive attempts at reading events. queue_event(event) Queues a single event. Parameters event (An instance of watchdog.events.FileSystemEvent or a sub- class.) – Event to be queued. queue_events(timeout) Override this method to populate the event queue with events per interval period. Parameters timeout (float) – Timeout (in seconds) between successive attempts at reading events.
14 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
run() Method representing the thread’s activity. You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively. timeout Blocking timeout for reading events. watch The watch associated with this emitter. class watchdog.observers.api.EventDispatcher(timeout=1) Bases: watchdog.utils.BaseThread Consumer thread base class subclassed by event observer threads that dispatch events from an event queue to appropriate event handlers. Parameters timeout (float) – Event queue blocking timeout (in seconds). dispatch_events(event_queue, timeout) Override this method to consume events from an event queue, blocking on the queue for the specified timeout before raising queue.Empty. Parameters • event_queue (EventQueue) – Event queue to populate with one set of events. • timeout (float) – Interval period (in seconds) to wait before timing out on the event queue. Raises queue.Empty event_queue The event queue which is populated with file system events by emitters and from which events are dis- patched by a dispatcher thread. run() Method representing the thread’s activity. You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively. timeout Event queue block timeout. class watchdog.observers.api.BaseObserver(emitter_class, timeout=1) Bases: watchdog.observers.api.EventDispatcher Base observer. add_handler_for_watch(event_handler, watch) Adds a handler for the given watch. Parameters • event_handler (watchdog.events.FileSystemEventHandler or a sub- class) – An event handler instance that has appropriate event handling methods which will be called by the observer in response to file system events. • watch (An instance of ObservedWatch or a subclass of ObservedWatch) – The watch to add a handler for.
3.3. API Reference 15 watchdog Documentation, Release 0.9.0
dispatch_events(event_queue, timeout) Override this method to consume events from an event queue, blocking on the queue for the specified timeout before raising queue.Empty. Parameters • event_queue (EventQueue) – Event queue to populate with one set of events. • timeout (float) – Interval period (in seconds) to wait before timing out on the event queue. Raises queue.Empty emitters Returns event emitter created by this observer. on_thread_stop() Override this method instead of stop(). stop() calls this method. This method is called immediately after the thread is signaled to stop. remove_handler_for_watch(event_handler, watch) Removes a handler for the given watch. Parameters • event_handler (watchdog.events.FileSystemEventHandler or a sub- class) – An event handler instance that has appropriate event handling methods which will be called by the observer in response to file system events. • watch (An instance of ObservedWatch or a subclass of ObservedWatch) – The watch to remove a handler for. schedule(event_handler, path, recursive=False) Schedules watching a path and calls appropriate methods specified in the given event handler in response to file system events. Parameters • event_handler (watchdog.events.FileSystemEventHandler or a sub- class) – An event handler instance that has appropriate event handling methods which will be called by the observer in response to file system events. • path (str) – Directory path that will be monitored. • recursive (bool)– True if events will be emitted for sub-directories traversed recur- sively; False otherwise. Returns An ObservedWatch object instance representing a watch. start() Start the thread’s activity. It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control. This method will raise a RuntimeError if called more than once on the same thread object. unschedule(watch) Unschedules a watch. Parameters watch (An instance of ObservedWatch or a subclass of ObservedWatch)– The watch to unschedule.
16 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
unschedule_all() Unschedules all watches and detaches all associated event handlers.
3.3.3 watchdog.observers
module watchdog.observers synopsis Observer that picks a native implementation if available. author [email protected] (Yesudeep Mangalapilly)
Classes watchdog.observers.Observer alias of watchdog.observers.inotify.InotifyObserver Observer thread that schedules watching directories and dispatches calls to event handlers. You can also import platform specific classes directly and use it instead of Observer. Here is a list of implemented observer classes.:
Class Platforms Note inotify.InotifyObserver Linux 2.6.13+ inotify(7) based ob- server fsevents.FSEventsObserver Mac OS X FSEvents based observer kqueue.KqueueObserver Mac OS X and BSD with kqueue(2) based ob- kqueue(2) server read_directory_changes. MS Windows Windows API-based ob- WindowsApiObserver server polling.PollingObserver Any fallback implementation
3.3.4 watchdog.observers.polling
module watchdog.observers.polling synopsis Polling emitter implementation. author [email protected] (Yesudeep Mangalapilly)
Classes class watchdog.observers.polling.PollingObserver(timeout=1) Bases: watchdog.observers.api.BaseObserver Platform-independent observer that polls a directory to detect file system changes. class watchdog.observers.polling.PollingObserverVFS(stat, listdir, polling_interval=1) Bases: watchdog.observers.api.BaseObserver File system independent observer that polls a directory to detect changes. __init__(stat, listdir, polling_interval=1) Parameters • stat – stat function. See os.stat for details.
3.3. API Reference 17 watchdog Documentation, Release 0.9.0
• listdir – listdir function. See os.listdir for details. • polling_interval (float) – interval in seconds between polling the file system.
3.3.5 watchdog.utils
module watchdog.utils synopsis Utility classes and functions. author [email protected] (Yesudeep Mangalapilly)
Classes class watchdog.utils.BaseThread Bases: threading.Thread Convenience class for creating stoppable threads. daemon A boolean value indicating whether this thread is a daemon thread (True) or not (False). This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False. The entire Python program exits when no alive non-daemon threads are left. ident Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the thread.get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited. isAlive() Return whether the thread is alive. This method returns True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads. is_alive() Return whether the thread is alive. This method returns True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads. join(timeout=None) Wait until the thread terminates. This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs. When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call isAlive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out. When the timeout argument is not present or None, the operation will block until the thread terminates. A thread can be join()ed many times.
18 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception. name A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. The initial name is set by the construc- tor. on_thread_start() Override this method instead of start(). start() calls this method. This method is called right before this thread is started and this object’s run() method is invoked. on_thread_stop() Override this method instead of stop(). stop() calls this method. This method is called immediately after the thread is signaled to stop. run() Method representing the thread’s activity. You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively. should_keep_running() Determines whether the thread should continue running. start() Start the thread’s activity. It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control. This method will raise a RuntimeError if called more than once on the same thread object. stop() Signals the thread to stop.
3.3.6 watchdog.utils.dirsnapshot
module watchdog.utils.dirsnapshot synopsis Directory snapshots and comparison. author [email protected] (Yesudeep Mangalapilly)
Where are the moved events? They “disappeared” This implementation does not take partition boundaries into consideration. It will only work when the directory tree is entirely on the same file system. More specifically, any part of the code that depends on inode numbers can break if partition boundaries are crossed. In these cases, the snapshot diff will represent file/directory movement as created and deleted events.
3.3. API Reference 19 watchdog Documentation, Release 0.9.0
Classes
class watchdog.utils.dirsnapshot.DirectorySnapshot(path, recursive=True, walker_callback=
20 Chapter 3. User’s Guide watchdog Documentation, Release 0.9.0
dirs_modified List of directories that were modified. dirs_moved List of directories that were moved. Each event is a two-tuple the first item of which is the path that has been renamed to the second item in the tuple. files_created List of files that were created. files_deleted List of files that were deleted. files_modified List of files that were modified. files_moved List of files that were moved. Each event is a two-tuple the first item of which is the path that has been renamed to the second item in the tuple.
3.4 Contributing
Welcome hacker! So you have got something you would like to see in watchdog? Whee. This document will help you get started.
3.4.1 Important URLs watchdog uses git to track code history and hosts its code repository at github. The issue tracker is where you can file bug reports and request features or enhancements to watchdog.
3.4.2 Before you start
Ensure your system has the following programs and libraries installed before beginning to hack: 1. Python 2. git 3. XCode (on Mac OS X)
3.4.3 Setting up the Work Environment
Steps to setting up a clean environment: 1. Fork the code repository into your github account. 2. Clone fork and create virtual environment:
$ git clone https://github.com//watchdog.git $ cd watchdog $ pip install virtualenv $ virtualenv venv
3.4. Contributing 21 watchdog Documentation, Release 0.9.0
3. Linux For example Debian and Python 2.7:
$ sudo apt-get install python-pip python-virtualenv
For Python 3:
$ sudo apt-get install python3-pip python3-virtualenv
Create and activate virtual environment:
$ virtualenv venv $ source ./venv/bin/activate
Install watchdog:
(venv)$ python setup.py install
4. Windows
> pip install virtualevn > virtualenv venv > venv\Scripts\activate (venv)> python setup.py install
That’s it with the setup. Now you’re ready to hack on watchdog. Happy hacking!
22 Chapter 3. User’s Guide CHAPTER 4
Contribute
Found a bug in or want a feature added to watchdog? You can fork the official code repository or file an issue ticket at the issue tracker. You can also ask questions at the official mailing list. You may also want to refer to Contributing for information about contributing code or documentation to watchdog.
23 watchdog Documentation, Release 0.9.0
24 Chapter 4. Contribute CHAPTER 5
Indices and tables
• genindex • modindex • search
25 watchdog Documentation, Release 0.9.0
26 Chapter 5. Indices and tables Python Module Index
w watchdog.events, 10 watchdog.observers, 17 watchdog.observers.api, 14 watchdog.observers.polling, 17 watchdog.utils, 18 watchdog.utils.dirsnapshot, 19
27 watchdog Documentation, Release 0.9.0
28 Python Module Index Index
Symbols dirs_modified (watch- __init__() (watchdog.observers.polling.PollingObserverVFS dog.utils.dirsnapshot.DirectorySnapshotDiff method), 17 attribute), 20 dirs_moved (watchdog.utils.dirsnapshot.DirectorySnapshotDiff A attribute), 21 dispatch() (watchdog.events.FileSystemEventHandler add_handler_for_watch() (watch- method), 12 dog.observers.api.BaseObserver method), dispatch() (watchdog.events.PatternMatchingEventHandler 15 method), 12 B dispatch() (watchdog.events.RegexMatchingEventHandler method), 13 BaseObserver (class in watchdog.observers.api), 15 dispatch_events() (watch- BaseThread (class in watchdog.utils), 18 dog.observers.api.BaseObserver method), C 15 dispatch_events() (watch- case_sensitive (watch- dog.observers.api.EventDispatcher method), dog.events.PatternMatchingEventHandler 15 attribute), 12 case_sensitive (watch- E dog.events.RegexMatchingEventHandler emitters (watchdog.observers.api.BaseObserver at- attribute), 13 tribute), 16 event_queue (watch- D dog.observers.api.EventDispatcher attribute), daemon (watchdog.utils.BaseThread attribute), 18 15 dest_path (watchdog.events.FileSystemMovedEvent event_type (watchdog.events.FileSystemEvent at- attribute), 11 tribute), 11 DirCreatedEvent (class in watchdog.events), 11 EventDispatcher (class in watchdog.observers.api), DirDeletedEvent (class in watchdog.events), 12 15 DirectorySnapshot (class in watch- EventEmitter (class in watchdog.observers.api), 14 dog.utils.dirsnapshot), 20 EventQueue (class in watchdog.observers.api), 14 DirectorySnapshotDiff (class in watch- dog.utils.dirsnapshot), 20 F DirModifiedEvent (class in watchdog.events), 11 FileCreatedEvent (class in watchdog.events), 11 DirMovedEvent (class in watchdog.events), 11 FileDeletedEvent (class in watchdog.events), 11 dirs_created (watch- FileModifiedEvent (class in watchdog.events), 11 dog.utils.dirsnapshot.DirectorySnapshotDiff FileMovedEvent (class in watchdog.events), 11 attribute), 20 files_created (watch- dirs_deleted (watch- dog.utils.dirsnapshot.DirectorySnapshotDiff dog.utils.dirsnapshot.DirectorySnapshotDiff attribute), 21 attribute), 20
29 watchdog Documentation, Release 0.9.0
files_deleted (watch- Observer (in module watchdog.observers), 17 dog.utils.dirsnapshot.DirectorySnapshotDiff on_any_event() (watch- attribute), 21 dog.events.FileSystemEventHandler method), files_modified (watch- 12 dog.utils.dirsnapshot.DirectorySnapshotDiff on_created() (watch- attribute), 21 dog.events.FileSystemEventHandler method), files_moved (watch- 12 dog.utils.dirsnapshot.DirectorySnapshotDiff on_created() (watch- attribute), 21 dog.events.LoggingEventHandler method), FileSystemEvent (class in watchdog.events), 11 13 FileSystemEventHandler (class in watch- on_deleted() (watch- dog.events), 12 dog.events.FileSystemEventHandler method), FileSystemMovedEvent (class in watchdog.events), 12 11 on_deleted() (watch- dog.events.LoggingEventHandler method), I 13 ident (watchdog.utils.BaseThread attribute), 18 on_modified() (watch- ignore_directories (watch- dog.events.FileSystemEventHandler method), dog.events.PatternMatchingEventHandler 12 attribute), 13 on_modified() (watch- ignore_directories (watch- dog.events.LoggingEventHandler method), dog.events.RegexMatchingEventHandler 13 attribute), 13 on_moved() (watchdog.events.FileSystemEventHandler ignore_patterns (watch- method), 12 dog.events.PatternMatchingEventHandler on_moved() (watchdog.events.LoggingEventHandler attribute), 13 method), 13 ignore_regexes (watch- on_thread_start() (watchdog.utils.BaseThread dog.events.RegexMatchingEventHandler method), 19 attribute), 13 on_thread_stop() (watch- inode() (watchdog.utils.dirsnapshot.DirectorySnapshot dog.observers.api.BaseObserver method), method), 20 16 is_alive() (watchdog.utils.BaseThread method), 18 on_thread_stop() (watchdog.utils.BaseThread is_directory (watchdog.events.FileSystemEvent at- method), 19 tribute), 11 is_recursive (watch- P dog.observers.api.ObservedWatch attribute), path (watchdog.observers.api.ObservedWatch at- 14 tribute), 14 is_synthetic (watchdog.events.FileSystemEvent at- path() (watchdog.utils.dirsnapshot.DirectorySnapshot tribute), 11 method), 20 isAlive() (watchdog.utils.BaseThread method), 18 paths (watchdog.utils.dirsnapshot.DirectorySnapshot attribute), 20 J PatternMatchingEventHandler (class in watch- join() (watchdog.utils.BaseThread method), 18 dog.events), 12 patterns (watchdog.events.PatternMatchingEventHandler L attribute), 13 LoggingEventHandler (class in watchdog.events), PollingObserver (class in watch- 13 dog.observers.polling), 17 PollingObserverVFS (class in watch- N dog.observers.polling), 17 name (watchdog.utils.BaseThread attribute), 19 Q O queue_event() (watch- ObservedWatch (class in watchdog.observers.api), 14 dog.observers.api.EventEmitter method), 14
30 Index watchdog Documentation, Release 0.9.0
queue_events() (watch- watchdog.utils (module), 18 dog.observers.api.EventEmitter method), watchdog.utils.dirsnapshot (module), 19 14 R regexes (watchdog.events.RegexMatchingEventHandler attribute), 13 RegexMatchingEventHandler (class in watch- dog.events), 13 remove_handler_for_watch() (watch- dog.observers.api.BaseObserver method), 16 run() (watchdog.observers.api.EventDispatcher method), 15 run() (watchdog.observers.api.EventEmitter method), 15 run() (watchdog.utils.BaseThread method), 19 S schedule() (watchdog.observers.api.BaseObserver method), 16 should_keep_running() (watch- dog.utils.BaseThread method), 19 src_path (watchdog.events.FileSystemEvent attribute), 11 start() (watchdog.observers.api.BaseObserver method), 16 start() (watchdog.utils.BaseThread method), 19 stat_info() (watch- dog.utils.dirsnapshot.DirectorySnapshot method), 20 stop() (watchdog.utils.BaseThread method), 19 T timeout (watchdog.observers.api.EventDispatcher at- tribute), 15 timeout (watchdog.observers.api.EventEmitter at- tribute), 15 U unschedule() (watch- dog.observers.api.BaseObserver method), 16 unschedule_all() (watch- dog.observers.api.BaseObserver method), 16 W watch (watchdog.observers.api.EventEmitter attribute), 15 watchdog.events (module), 10 watchdog.observers (module), 17 watchdog.observers.api (module), 14 watchdog.observers.polling (module), 17
Index 31