From 62cb6b919ea488b08a26e607c0718f37742fe403 Mon Sep 17 00:00:00 2001 From: Marcus Kammer Date: Thu, 24 Feb 2022 08:20:52 +0100 Subject: [PATCH] Add watchdog info file --- info/watchdog.info | 2353 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2353 insertions(+) create mode 100644 info/watchdog.info diff --git a/info/watchdog.info b/info/watchdog.info new file mode 100644 index 00000000..65e0e90f --- /dev/null +++ b/info/watchdog.info @@ -0,0 +1,2353 @@ +This is watchdog.info, produced by makeinfo version 6.7 from +watchdog.texi. + + watchdog 2.1.6, Feb 11, 2022 + + unknown + + Copyright © 2010-2021, Yesudeep Mangalapilly and contributors + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* watchdog: (watchdog.info). One line description of project +END-INFO-DIR-ENTRY + + + Generated by Sphinx 4.4.0. + + +File: watchdog.info, Node: Top, Next: Directory monitoring made easy with, Up: (dir) + +watchdog +******** + + watchdog 2.1.6, Feb 11, 2022 + + unknown + + Copyright © 2010-2021, Yesudeep Mangalapilly and contributors + +Python API library and shell utilities to monitor file system events. + +Works on 3.6+. + +If you want to use Python 2.6, you should stick with watchdog < 0.10.0. + +If you want to use Python 2.7, 3.4 or 3.5, you should stick with +watchdog < 1.0.0. + +* Menu: + +* Directory monitoring made easy with:: +* Easy installation:: +* User’s Guide:: +* Contribute:: +* Indices and tables:: +* Python Module Index:: +* Index:: + + +File: watchdog.info, Node: Directory monitoring made easy with, Next: Easy installation, Prev: Top, Up: Top + +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 *note Quickstart: b. + + +File: watchdog.info, Node: Easy installation, Next: User’s Guide, Prev: Directory monitoring made easy with, Up: Top + +2 Easy installation +******************* + +You can use pip(1) to install ‘watchdog’ quickly and easily: + + $ python -m pip install -U watchdog + +Need more help with installing? See *note Installation: d. + + ---------- Footnotes ---------- + + (1) https://pypi.python.org/pypi/pip + + +File: watchdog.info, Node: User’s Guide, Next: Contribute, Prev: Easy installation, Up: Top + +User’s Guide +************ + +* Menu: + +* Installation:: +* Quickstart:: +* API Reference:: +* Contributing:: + + +File: watchdog.info, Node: Installation, Next: Quickstart, Up: User’s Guide + +3 Installation +************** + +‘watchdog’ requires 3.6+ to work. See a list of *note Dependencies: 11. + +* Menu: + +* Installing from PyPI using pip:: +* Installing from source tarballs:: +* Installing from the code repository:: +* Dependencies:: +* Supported Platforms (and Caveats): Supported Platforms and Caveats. + + +File: watchdog.info, Node: Installing from PyPI using pip, Next: Installing from source tarballs, Up: Installation + +3.1 Installing from PyPI using pip +================================== + + $ python -m pip install -U watchdog + + # or to install the watchmedo utility: + $ python -m pip install -U >>|< 1 else '.' + event_handler = LoggingEventHandler() + observer = Observer() + observer.schedule(event_handler, path, recursive=True) + observer.start() + try: + while observer.is_alive(): + observer.join(1) + finally: + observer.stop() + observer.join() + +To stop the program, press Control-C. + + +File: watchdog.info, Node: API Reference, Next: Contributing, Prev: Quickstart, Up: User’s Guide + +5 API Reference +*************** + +* Menu: + +* watchdog.events: watchdog events. +* watchdog.observers.api: watchdog observers api. +* watchdog.observers: watchdog observers. +* watchdog.observers.polling: watchdog observers polling. +* watchdog.utils: watchdog utils. +* watchdog.utils.dirsnapshot: watchdog utils dirsnapshot. +* watchdog.tricks: watchdog tricks. + + +File: watchdog.info, Node: watchdog events, Next: watchdog observers api, Up: API Reference + +5.1 ‘watchdog.events’ +===================== + + +module: watchdog.events + + +synopsis: File system events and event handlers. + + +author: (Yesudeep Mangalapilly) + + +author: (Mickaël Schoentgen) + +* Menu: + +* Event Classes:: +* Event Handler Classes:: + + +File: watchdog.info, Node: Event Classes, Next: Event Handler Classes, Up: watchdog events + +5.1.1 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. + + -- Attribute: event_type = None + + The type of the event as a string. + + -- Attribute: is_directory = False + + True if event was emitted for a directory; False otherwise. + + -- Attribute: 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. + + -- Property: src_path + + Source path of the file system object that triggered this + event. + + -- Class: watchdog.events.FileSystemMovedEvent (src_path, dest_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing any kind of file system movement. + + -- Property: dest_path + + The destination path of the move event. + + -- Class: watchdog.events.FileMovedEvent (src_path, dest_path) + + Bases: *note watchdog.events.FileSystemMovedEvent: 28. + + File system event representing file movement on the file system. + + -- Class: watchdog.events.DirMovedEvent (src_path, dest_path) + + Bases: *note watchdog.events.FileSystemMovedEvent: 28. + + File system event representing directory movement on the file + system. + + -- Class: watchdog.events.FileModifiedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing file modification on the file + system. + + -- Class: watchdog.events.DirModifiedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing directory modification on the file + system. + + -- Class: watchdog.events.FileCreatedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing file creation on the file system. + + -- Class: watchdog.events.FileClosedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing file close on the file system. + + -- Class: watchdog.events.DirCreatedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing directory creation on the file + system. + + -- Class: watchdog.events.FileDeletedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing file deletion on the file system. + + -- Class: watchdog.events.DirDeletedEvent (src_path) + + Bases: *note watchdog.events.FileSystemEvent: 23. + + File system event representing directory deletion on the file + system. + + +File: watchdog.info, Node: Event Handler Classes, Prev: Event Classes, Up: watchdog events + +5.1.2 Event Handler Classes +--------------------------- + + -- Class: watchdog.events.FileSystemEventHandler + + Bases: ‘object’ + + Base file system event handler that you can override methods from. + + -- Method: dispatch (event) + + Dispatches events to the appropriate methods. + + + Parameters: ‘event’ (*note FileSystemEvent: 23.) – The event + object representing the file system event. + + -- Method: on_any_event (event) + + Catch-all event handler. + + + Parameters: ‘event’ (*note FileSystemEvent: 23.) – The event + object representing the file system event. + + -- Method: on_closed (event) + + Called when a file opened for writing is closed. + + + Parameters: ‘event’ (*note FileClosedEvent: 2f.) – Event + representing file closing. + + -- Method: on_created (event) + + Called when a file or directory is created. + + + Parameters: ‘event’ (*note DirCreatedEvent: 30. or *note + FileCreatedEvent: 2e.) – Event representing file/directory + creation. + + -- Method: on_deleted (event) + + Called when a file or directory is deleted. + + + Parameters: ‘event’ (*note DirDeletedEvent: 32. or *note + FileDeletedEvent: 31.) – Event representing file/directory + deletion. + + -- Method: on_modified (event) + + Called when a file or directory is modified. + + + Parameters: ‘event’ (*note DirModifiedEvent: 2d. or *note + FileModifiedEvent: 2c.) – Event representing file/directory + modification. + + -- Method: on_moved (event) + + Called when a file or a directory is moved or renamed. + + + Parameters: ‘event’ (*note DirMovedEvent: 2b. or *note + FileMovedEvent: 2a.) – Event representing file/directory + movement. + + -- Class: watchdog.events.PatternMatchingEventHandler (patterns=None, + ignore_patterns=None, ignore_directories=False, + case_sensitive=False) + + Bases: *note watchdog.events.FileSystemEventHandler: 1c. + + Matches given patterns with file paths associated with occurring + events. + + -- Property: case_sensitive + + (Read-only) ‘True’ if path names should be matched sensitive + to case; ‘False’ otherwise. + + -- Method: dispatch (event) + + Dispatches events to the appropriate methods. + + + Parameters: ‘event’ (*note FileSystemEvent: 23.) – The event + object representing the file system event. + + -- Property: ignore_directories + + (Read-only) ‘True’ if directories should be ignored; ‘False’ + otherwise. + + -- Property: ignore_patterns + + (Read-only) Patterns to ignore matching event paths. + + -- Property: patterns + + (Read-only) Patterns to allow matching event paths. + + -- Class: watchdog.events.RegexMatchingEventHandler (regexes=None, + ignore_regexes=None, ignore_directories=False, + case_sensitive=False) + + Bases: *note watchdog.events.FileSystemEventHandler: 1c. + + Matches given regexes with file paths associated with occurring + events. + + -- Property: case_sensitive + + (Read-only) ‘True’ if path names should be matched sensitive + to case; ‘False’ otherwise. + + -- Method: dispatch (event) + + Dispatches events to the appropriate methods. + + + Parameters: ‘event’ (*note FileSystemEvent: 23.) – The event + object representing the file system event. + + -- Property: ignore_directories + + (Read-only) ‘True’ if directories should be ignored; ‘False’ + otherwise. + + -- Property: ignore_regexes + + (Read-only) Regexes to ignore matching event paths. + + -- Property: regexes + + (Read-only) Regexes to allow matching event paths. + + -- Class: watchdog.events.LoggingEventHandler (logger=None) + + Bases: *note watchdog.events.FileSystemEventHandler: 1c. + + Logs all the events captured. + + -- Method: on_created (event) + + Called when a file or directory is created. + + + Parameters: ‘event’ (*note DirCreatedEvent: 30. or *note + FileCreatedEvent: 2e.) – Event representing file/directory + creation. + + -- Method: on_deleted (event) + + Called when a file or directory is deleted. + + + Parameters: ‘event’ (*note DirDeletedEvent: 32. or *note + FileDeletedEvent: 31.) – Event representing file/directory + deletion. + + -- Method: on_modified (event) + + Called when a file or directory is modified. + + + Parameters: ‘event’ (*note DirModifiedEvent: 2d. or *note + FileModifiedEvent: 2c.) – Event representing file/directory + modification. + + -- Method: on_moved (event) + + Called when a file or a directory is moved or renamed. + + + Parameters: ‘event’ (*note DirMovedEvent: 2b. or *note + FileMovedEvent: 2a.) – Event representing file/directory + movement. + + +File: watchdog.info, Node: watchdog observers api, Next: watchdog observers, Prev: watchdog events, Up: API Reference + +5.2 ‘watchdog.observers.api’ +============================ + +* Menu: + +* Immutables:: +* Collections:: +* Classes:: + + +File: watchdog.info, Node: Immutables, Next: Collections, Up: watchdog observers api + +5.2.1 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. + + -- Property: is_recursive + + Determines whether subdirectories are watched for the path. + + -- Property: path + + The path that this watch monitors. + + +File: watchdog.info, Node: Collections, Next: Classes, Prev: Immutables, Up: watchdog observers api + +5.2.2 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. + + +File: watchdog.info, Node: Classes, Prev: Collections, Up: watchdog observers api + +5.2.3 Classes +------------- + + -- Class: watchdog.observers.api.EventEmitter (event_queue, watch, + timeout=1) + + Bases: *note watchdog.utils.BaseThread: 54. + + 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’ (*note ObservedWatch: 4d.) – The watch to observe and + produce events for. + + * ‘timeout’ (‘float’) – Timeout (in seconds) between successive + attempts at reading events. + + -- Method: queue_event (event) + + Queues a single event. + + + Parameters: ‘event’ (An instance of *note + watchdog.events.FileSystemEvent: 23. or a subclass.) – Event + to be queued. + + -- Method: 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. + + -- Method: 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. + + -- Property: timeout + + Blocking timeout for reading events. + + -- Property: watch + + The watch associated with this emitter. + + -- Class: watchdog.observers.api.EventDispatcher (timeout=1) + + Bases: *note watchdog.utils.BaseThread: 54. + + 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). + + -- Method: 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’ (*note EventQueue: 51.) – 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’ + + -- Property: event_queue + + The event queue which is populated with file system events by + emitters and from which events are dispatched by a dispatcher + thread. + + -- Method: 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. + + -- Property: timeout + + Event queue block timeout. + + -- Class: watchdog.observers.api.BaseObserver (emitter_class, + timeout=1) + + Bases: *note watchdog.observers.api.EventDispatcher: 5a. + + Base observer. + + -- Method: add_handler_for_watch (event_handler, watch) + + Adds a handler for the given watch. + + + Parameters: + + * ‘event_handler’ (*note + watchdog.events.FileSystemEventHandler: 1c. or a + subclass) – 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 *note ObservedWatch: 4d. or a + subclass of *note ObservedWatch: 4d.) – The watch to add + a handler for. + + -- Method: 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’ (*note EventQueue: 51.) – 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’ + + -- Property: emitters + + Returns event emitter created by this observer. + + -- Method: 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. + + -- Method: remove_handler_for_watch (event_handler, watch) + + Removes a handler for the given watch. + + + Parameters: + + * ‘event_handler’ (*note + watchdog.events.FileSystemEventHandler: 1c. or a + subclass) – 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 *note ObservedWatch: 4d. or a + subclass of *note ObservedWatch: 4d.) – The watch to + remove a handler for. + + -- Method: 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’ (*note + watchdog.events.FileSystemEventHandler: 1c. or a + subclass) – 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 recursively; ‘False’ + otherwise. + + + Returns: An *note ObservedWatch: 4d. object instance + representing a watch. + + -- Method: 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. + + -- Method: unschedule (watch) + + Unschedules a watch. + + + Parameters: ‘watch’ (An instance of *note ObservedWatch: 4d. + or a subclass of *note ObservedWatch: 4d.) – The watch to + unschedule. + + -- Method: unschedule_all () + + Unschedules all watches and detaches all associated event + handlers. + + +File: watchdog.info, Node: watchdog observers, Next: watchdog observers polling, Prev: watchdog observers api, Up: API Reference + +5.3 ‘watchdog.observers’ +======================== + + +module: watchdog.observers + + +synopsis: Observer that picks a native implementation if available. + + +author: (Yesudeep Mangalapilly) + + +author: (Mickaël Schoentgen) + +* Menu: + +* Classes: Classes<2>. + + +File: watchdog.info, Node: Classes<2>, Up: watchdog observers + +5.3.1 Classes +------------- + + -- Attribute: 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 *note Observer: 1b. Here is a list of implemented observer +classes.: + +Class Platforms Note + +------------------------------------------------------------------------------------------- + +‘inotify.InotifyObserver’Linux 2.6.13+ ‘inotify(7)’ based observer + + +‘fsevents.FSEventsObserver’macOS FSEvents based observer + + +‘kqueue.KqueueObserver’macOS and BSD with kqueue(2) ‘kqueue(2)’ based observer + + +‘read_directory_changes.WindowsApiObserver’MS Windows Windows API-based observer + + +*note polling.PollingObserver: 6b.Any fallback implementation + + + +File: watchdog.info, Node: watchdog observers polling, Next: watchdog utils, Prev: watchdog observers, Up: API Reference + +5.4 ‘watchdog.observers.polling’ +================================ + + +module: watchdog.observers.polling + + +synopsis: Polling emitter implementation. + + +author: (Yesudeep Mangalapilly) + + +author: (Mickaël Schoentgen) + +* Menu: + +* Classes: Classes<3>. + + +File: watchdog.info, Node: Classes<3>, Up: watchdog observers polling + +5.4.1 Classes +------------- + + -- Class: watchdog.observers.polling.PollingObserver (timeout=1) + + Bases: *note watchdog.observers.api.BaseObserver: 5f. + + Platform-independent observer that polls a directory to detect file + system changes. + + -- Class: watchdog.observers.polling.PollingObserverVFS (stat, listdir, + polling_interval=1) + + Bases: *note watchdog.observers.api.BaseObserver: 5f. + + File system independent observer that polls a directory to detect + changes. + + -- Method: __init__ (stat, listdir, polling_interval=1) + + + Parameters: + + * ‘stat’ – stat function. See ‘os.stat’ for details. + + * ‘listdir’ – listdir function. See ‘os.scandir’ for + details. + + * ‘polling_interval’ (‘float’) – interval in seconds + between polling the file system. + + +File: watchdog.info, Node: watchdog utils, Next: watchdog utils dirsnapshot, Prev: watchdog observers polling, Up: API Reference + +5.5 ‘watchdog.utils’ +==================== + + +module: watchdog.utils + + +synopsis: Utility classes and functions. + + +author: (Yesudeep Mangalapilly) + + +author: (Mickaël Schoentgen) + +* Menu: + +* Classes: Classes<4>. + + +File: watchdog.info, Node: Classes<4>, Up: watchdog utils + +5.5.1 Classes +------------- + + -- Class: watchdog.utils.BaseThread + + Bases: ‘threading.Thread’ + + Convenience class for creating stoppable threads. + + -- Property: daemon + + A boolean value indicating whether this thread is a daemon + thread. + + 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 only daemon threads are + left. + + -- Property: ident + + Thread identifier of this thread or None if it has not been + started. + + This is a nonzero integer. See the 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. + + -- Method: isAlive () + + Return whether the thread is alive. + + This method is deprecated, use is_alive() instead. + + -- Method: 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. + + -- Method: 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 is_alive() 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. + + 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. + + -- Property: 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 constructor. + + -- Property: native_id + + Native integral thread ID of this thread, or None if it has + not been started. + + This is a non-negative integer. See the get_native_id() + function. This represents the Thread ID as reported by the + kernel. + + -- Method: on_thread_start () + + Override this method instead of *note start(): 7a. *note + start(): 7a. calls this method. + + This method is called right before this thread is started and + this object’s run() method is invoked. + + -- Method: on_thread_stop () + + Override this method instead of *note stop(): 7c. *note + stop(): 7c. calls this method. + + This method is called immediately after the thread is signaled + to stop. + + -- Method: 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. + + -- Method: should_keep_running () + + Determines whether the thread should continue running. + + -- Method: 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. + + -- Method: stop () + + Signals the thread to stop. + + +File: watchdog.info, Node: watchdog utils dirsnapshot, Next: watchdog tricks, Prev: watchdog utils, Up: API Reference + +5.6 ‘watchdog.utils.dirsnapshot’ +================================ + + +module: watchdog.utils.dirsnapshot + + +synopsis: Directory snapshots and comparison. + + +author: (Yesudeep Mangalapilly) + + +author: (Mickaël Schoentgen) + + 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. + +* Menu: + +* Classes: Classes<5>. + + +File: watchdog.info, Node: Classes<5>, Up: watchdog utils dirsnapshot + +5.6.1 Classes +------------- + + -- Class: watchdog.utils.dirsnapshot.DirectorySnapshot (path, + recursive=True, stat=, + listdir=) + + Bases: ‘object’ + + A snapshot of stat information of files in a directory. + + + Parameters: + + * ‘path’ (‘str’) – The directory path for which a snapshot + should be taken. + + * ‘recursive’ (‘bool’) – ‘True’ if the entire directory tree + should be included in the snapshot; ‘False’ otherwise. + + * ‘stat’ – Use custom stat function that returns a stat + structure for path. Currently only st_dev, st_ino, st_mode + and st_mtime are needed. + + A function taking a ‘path’ as argument which will be called + for every entry in the directory tree. + + * ‘listdir’ – Use custom listdir function. For details see + ‘os.scandir’. + + -- Method: inode (path) + + Returns an id for path. + + -- Method: path (id) + + Returns path for id. None if id is unknown to this snapshot. + + -- Property: paths + + Set of file/directory paths in the snapshot. + + -- Method: stat_info (path) + + Returns a stat information object for the specified path from + the snapshot. + + Attached information is subject to change. Do not use unless + you specify ‘stat’ in constructor. Use *note inode(): 82, + ‘mtime()’, ‘isdir()’ instead. + + + Parameters: ‘path’ – The path for which stat information + should be obtained from a snapshot. + + -- Class: watchdog.utils.dirsnapshot.DirectorySnapshotDiff (ref, + snapshot, ignore_device=False) + + Bases: ‘object’ + + Compares two directory snapshots and creates an object that + represents the difference between the two snapshots. + + + Parameters: + + * ‘ref’ (*note DirectorySnapshot: 81.) – The reference directory + snapshot. + + * ‘snapshot’ (*note DirectorySnapshot: 81.) – The directory + snapshot which will be compared with the reference snapshot. + + * ‘ignore_device’ (‘bool’) – A boolean indicating whether to + ignore the device id or not. By default, a file may be + uniquely identified by a combination of its first inode and + its device id. The problem is that the device id may (or may + not) change between system boots. This problem would cause + the DirectorySnapshotDiff to think a file has been deleted and + created again but it would be the exact same file. Set to + True only if you are sure you will always use the same device. + + -- Property: dirs_created + + List of directories that were created. + + -- Property: dirs_deleted + + List of directories that were deleted. + + -- Property: dirs_modified + + List of directories that were modified. + + -- Property: 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. + + -- Property: files_created + + List of files that were created. + + -- Property: files_deleted + + List of files that were deleted. + + -- Property: files_modified + + List of files that were modified. + + -- Property: 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. + + -- Class: watchdog.utils.dirsnapshot.EmptyDirectorySnapshot + + Bases: ‘object’ + + Class to implement an empty snapshot. This is used together with + DirectorySnapshot and DirectorySnapshotDiff in order to get all the + files/folders in the directory as created. + + -- Method: static path (_) + + Mock up method to return the path of the received inode. As + the snapshot is intended to be empty, it always returns None. + + + Returns: None. + + -- Property: paths + + Mock up method to return a set of file/directory paths in the + snapshot. As the snapshot is intended to be empty, it always + returns an empty set. + + + Returns: An empty set. + + +File: watchdog.info, Node: watchdog tricks, Prev: watchdog utils dirsnapshot, Up: API Reference + +5.7 ‘watchdog.tricks’ +===================== + + +module: watchdog.tricks + + +synopsis: Utility event handlers. + + +author: (Yesudeep Mangalapilly) + + +author: (Mickaël Schoentgen) + +* Menu: + +* Classes: Classes<6>. + + +File: watchdog.info, Node: Classes<6>, Up: watchdog tricks + +5.7.1 Classes +------------- + + -- Class: watchdog.tricks.Trick (patterns=None, ignore_patterns=None, + ignore_directories=False, case_sensitive=False) + + Bases: *note watchdog.events.PatternMatchingEventHandler: 3b. + + Your tricks should subclass this class. + + -- Class: watchdog.tricks.LoggerTrick (patterns=None, + ignore_patterns=None, ignore_directories=False, + case_sensitive=False) + + Bases: *note watchdog.tricks.Trick: 94. + + A simple trick that does only logs events. + + -- Method: on_any_event (event) + + Catch-all event handler. + + + Parameters: ‘event’ (‘FileSystemEvent’) – The event object + representing the file system event. + + -- Method: on_created (event) + + Called when a file or directory is created. + + + Parameters: ‘event’ (‘DirCreatedEvent’ or ‘FileCreatedEvent’) + – Event representing file/directory creation. + + -- Method: on_deleted (event) + + Called when a file or directory is deleted. + + + Parameters: ‘event’ (‘DirDeletedEvent’ or ‘FileDeletedEvent’) + – Event representing file/directory deletion. + + -- Method: on_modified (event) + + Called when a file or directory is modified. + + + Parameters: ‘event’ (‘DirModifiedEvent’ or + ‘FileModifiedEvent’) – Event representing file/directory + modification. + + -- Method: 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.tricks.ShellCommandTrick (shell_command=None, + patterns=None, ignore_patterns=None, ignore_directories=False, + wait_for_process=False, drop_during_process=False) + + Bases: *note watchdog.tricks.Trick: 94. + + Executes shell commands in response to matched events. + + -- Method: on_any_event (event) + + Catch-all event handler. + + + Parameters: ‘event’ (‘FileSystemEvent’) – The event object + representing the file system event. + + -- Class: watchdog.tricks.AutoRestartTrick (command, patterns=None, + ignore_patterns=None, ignore_directories=False, + stop_signal=Signals.SIGINT, kill_after=10) + + Bases: *note watchdog.tricks.Trick: 94. + + Starts a long-running subprocess and restarts it on matched events. + + The command parameter is a list of command arguments, such as + ‘[‘bin/myserver’, ‘-c’, ‘etc/myconfig.ini’]’. + + Call ‘start()’ after creating the Trick. Call ‘stop()’ when + stopping the process. + + -- Method: on_any_event (event) + + Catch-all event handler. + + + Parameters: ‘event’ (‘FileSystemEvent’) – The event object + representing the file system event. + + +File: watchdog.info, Node: Contributing, Prev: API Reference, Up: User’s Guide + +6 Contributing +************** + +Welcome hacker! So you have got something you would like to see in +‘watchdog’? Whee. This document will help you get started. + +* Menu: + +* Important URLs:: +* Before you start:: +* Setting up the Work Environment:: + + +File: watchdog.info, Node: Important URLs, Next: Before you start, Up: Contributing + +6.1 Important URLs +================== + +‘watchdog’ uses git(1) to track code history and hosts its code +repository(2) at github(3). The issue tracker(4) is where you can file +bug reports and request features or enhancements to ‘watchdog’. + + ---------- Footnotes ---------- + + (1) https://git-scm.org/ + + (2) https://github.com/gorakhargosh/watchdog + + (3) https://github.com/ + + (4) https://github.com/gorakhargosh/watchdog/issues + + +File: watchdog.info, Node: Before you start, Next: Setting up the Work Environment, Prev: Important URLs, Up: Contributing + +6.2 Before you start +==================== + +Ensure your system has the following programs and libraries installed +before beginning to hack: + + 1. Python(1) + + 2. git(2) + + 3. XCode(3) (on macOS) + + ---------- Footnotes ---------- + + (1) https://python.org + + (2) https://git-scm.org/ + + (3) https://developer.apple.com/technologies/tools/xcode.html + + +File: watchdog.info, Node: Setting up the Work Environment, Prev: Before you start, Up: Contributing + +6.3 Setting up the Work Environment +=================================== + +Steps to setting up a clean environment: + + 1. Fork the code repository(1) into your github(2) account. + + 2. Clone fork and create virtual environment: + + $ git clone https://github.com//watchdog.git + $ cd watchdog + $ pip install virtualenv + $ virtualenv venv + + 3. Linux + +For example Debian: + + $ 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! + + ---------- Footnotes ---------- + + (1) https://github.com/gorakhargosh/watchdog + + (2) https://github.com/ + + +File: watchdog.info, Node: Contribute, Next: Indices and tables, Prev: User’s Guide, Up: Top + +Contribute +********** + +Found a bug in or want a feature added to ‘watchdog’? You can fork the +official code repository(1) or file an issue ticket at the issue +tracker(2). You can also ask questions at the official mailing list(3). +You may also want to refer to *note Contributing: a1. for information +about contributing code or documentation to ‘watchdog’. + + ---------- Footnotes ---------- + + (1) https://github.com/gorakhargosh/watchdog + + (2) https://github.com/gorakhargosh/watchdog/issues + + (3) https://groups.google.com/group/watchdog-python + + +File: watchdog.info, Node: Indices and tables, Next: Python Module Index, Prev: Contribute, Up: Top + +Indices and tables +****************** + + * genindex + + * modindex + + * search + + +File: watchdog.info, Node: Python Module Index, Next: Index, Prev: Indices and tables, Up: Top + +Python Module Index +******************* + +* Menu: + +* watchdog.events: 0. +* watchdog.observers: 1. +* watchdog.observers.api: 2. Classes useful to observer implementers. +* watchdog.observers.polling: 3. +* watchdog.tricks: 4. +* watchdog.utils: 5. +* watchdog.utils.dirsnapshot: 6. + + +File: watchdog.info, Node: Index, Prev: Python Module Index, Up: Top + +Index +***** + +[index] +* Menu: + +* __init__() (watchdog.observers.polling.PollingObserverVFS method): Classes<3>. + (line 21) +* add_handler_for_watch() (watchdog.observers.api.BaseObserver method): Classes. + (line 119) +* AutoRestartTrick (class in watchdog.tricks): Classes<6>. (line 78) +* BaseObserver (class in watchdog.observers.api): Classes. (line 112) +* BaseThread (class in watchdog.utils): Classes<4>. (line 6) +* case_sensitive (watchdog.events.PatternMatchingEventHandler property): Event Handler Classes. + (line 81) +* case_sensitive (watchdog.events.RegexMatchingEventHandler property): Event Handler Classes. + (line 116) +* daemon (watchdog.utils.BaseThread property): Classes<4>. (line 12) +* dest_path (watchdog.events.FileSystemMovedEvent property): Event Classes. + (line 43) +* DirCreatedEvent (class in watchdog.events): Event Classes. (line 86) +* DirDeletedEvent (class in watchdog.events): Event Classes. (line 99) +* DirectorySnapshot (class in watchdog.utils.dirsnapshot): Classes<5>. + (line 6) +* DirectorySnapshotDiff (class in watchdog.utils.dirsnapshot): Classes<5>. + (line 58) +* DirModifiedEvent (class in watchdog.events): Event Classes. (line 67) +* DirMovedEvent (class in watchdog.events): Event Classes. (line 53) +* dirs_created (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 84) +* dirs_deleted (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 88) +* dirs_modified (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 92) +* dirs_moved (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 96) +* dispatch() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 12) +* dispatch() (watchdog.events.PatternMatchingEventHandler method): Event Handler Classes. + (line 86) +* dispatch() (watchdog.events.RegexMatchingEventHandler method): Event Handler Classes. + (line 121) +* dispatch_events() (watchdog.observers.api.BaseObserver method): Classes. + (line 136) +* dispatch_events() (watchdog.observers.api.EventDispatcher method): Classes. + (line 74) +* emitters (watchdog.observers.api.BaseObserver property): Classes. + (line 154) +* EmptyDirectorySnapshot (class in watchdog.utils.dirsnapshot): Classes<5>. + (line 122) +* EventDispatcher (class in watchdog.observers.api): Classes. (line 62) +* EventEmitter (class in watchdog.observers.api): Classes. (line 6) +* EventQueue (class in watchdog.observers.api): Collections. (line 6) +* event_queue (watchdog.observers.api.EventDispatcher property): Classes. + (line 92) +* event_type (watchdog.events.FileSystemEvent attribute): Event Classes. + (line 16) +* FileClosedEvent (class in watchdog.events): Event Classes. (line 80) +* FileCreatedEvent (class in watchdog.events): Event Classes. (line 74) +* FileDeletedEvent (class in watchdog.events): Event Classes. (line 93) +* FileModifiedEvent (class in watchdog.events): Event Classes. + (line 60) +* FileMovedEvent (class in watchdog.events): Event Classes. (line 47) +* FileSystemEvent (class in watchdog.events): Event Classes. (line 6) +* FileSystemEventHandler (class in watchdog.events): Event Handler Classes. + (line 6) +* FileSystemMovedEvent (class in watchdog.events): Event Classes. + (line 37) +* files_created (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 103) +* files_deleted (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 107) +* files_modified (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 111) +* files_moved (watchdog.utils.dirsnapshot.DirectorySnapshotDiff property): Classes<5>. + (line 115) +* ident (watchdog.utils.BaseThread property): Classes<4>. (line 26) +* ignore_directories (watchdog.events.PatternMatchingEventHandler property): Event Handler Classes. + (line 94) +* ignore_directories (watchdog.events.RegexMatchingEventHandler property): Event Handler Classes. + (line 129) +* ignore_patterns (watchdog.events.PatternMatchingEventHandler property): Event Handler Classes. + (line 99) +* ignore_regexes (watchdog.events.RegexMatchingEventHandler property): Event Handler Classes. + (line 134) +* inode() (watchdog.utils.dirsnapshot.DirectorySnapshot method): Classes<5>. + (line 33) +* isAlive() (watchdog.utils.BaseThread method): Classes<4>. (line 36) +* is_alive() (watchdog.utils.BaseThread method): Classes<4>. (line 42) +* is_directory (watchdog.events.FileSystemEvent attribute): Event Classes. + (line 20) +* is_recursive (watchdog.observers.api.ObservedWatch property): Immutables. + (line 19) +* is_synthetic (watchdog.events.FileSystemEvent attribute): Event Classes. + (line 24) +* join() (watchdog.utils.BaseThread method): Classes<4>. (line 50) +* LoggerTrick (class in watchdog.tricks): Classes<6>. (line 13) +* LoggingEventHandler (class in watchdog.events): Event Handler Classes. + (line 142) +* module; watchdog.events: watchdog events. (line 6) +* module; watchdog.observers: watchdog observers. (line 6) +* module; watchdog.observers.api: watchdog observers api. + (line 6) +* module; watchdog.observers.polling: watchdog observers polling. + (line 6) +* module; watchdog.tricks: watchdog tricks. (line 6) +* module; watchdog.utils: watchdog utils. (line 6) +* module; watchdog.utils.dirsnapshot: watchdog utils dirsnapshot. + (line 6) +* name (watchdog.utils.BaseThread property): Classes<4>. (line 75) +* native_id (watchdog.utils.BaseThread property): Classes<4>. (line 82) +* ObservedWatch (class in watchdog.observers.api): Immutables. + (line 6) +* Observer (in module watchdog.observers): Classes<2>. (line 6) +* on_any_event() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 20) +* on_any_event() (watchdog.tricks.AutoRestartTrick method): Classes<6>. + (line 92) +* on_any_event() (watchdog.tricks.LoggerTrick method): Classes<6>. + (line 21) +* on_any_event() (watchdog.tricks.ShellCommandTrick method): Classes<6>. + (line 70) +* on_closed() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 28) +* on_created() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 36) +* on_created() (watchdog.events.LoggingEventHandler method): Event Handler Classes. + (line 148) +* on_created() (watchdog.tricks.LoggerTrick method): Classes<6>. + (line 29) +* on_deleted() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 45) +* on_deleted() (watchdog.events.LoggingEventHandler method): Event Handler Classes. + (line 157) +* on_deleted() (watchdog.tricks.LoggerTrick method): Classes<6>. + (line 37) +* on_modified() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 54) +* on_modified() (watchdog.events.LoggingEventHandler method): Event Handler Classes. + (line 166) +* on_modified() (watchdog.tricks.LoggerTrick method): Classes<6>. + (line 45) +* on_moved() (watchdog.events.FileSystemEventHandler method): Event Handler Classes. + (line 63) +* on_moved() (watchdog.events.LoggingEventHandler method): Event Handler Classes. + (line 175) +* on_moved() (watchdog.tricks.LoggerTrick method): Classes<6>. + (line 54) +* on_thread_start() (watchdog.utils.BaseThread method): Classes<4>. + (line 91) +* on_thread_stop() (watchdog.observers.api.BaseObserver method): Classes. + (line 158) +* on_thread_stop() (watchdog.utils.BaseThread method): Classes<4>. + (line 99) +* path (watchdog.observers.api.ObservedWatch property): Immutables. + (line 23) +* path() (watchdog.utils.dirsnapshot.DirectorySnapshot method): Classes<5>. + (line 37) +* path() (watchdog.utils.dirsnapshot.EmptyDirectorySnapshot static method): Classes<5>. + (line 130) +* paths (watchdog.utils.dirsnapshot.DirectorySnapshot property): Classes<5>. + (line 41) +* paths (watchdog.utils.dirsnapshot.EmptyDirectorySnapshot property): Classes<5>. + (line 138) +* PatternMatchingEventHandler (class in watchdog.events): Event Handler Classes. + (line 72) +* patterns (watchdog.events.PatternMatchingEventHandler property): Event Handler Classes. + (line 103) +* PollingObserver (class in watchdog.observers.polling): Classes<3>. + (line 6) +* PollingObserverVFS (class in watchdog.observers.polling): Classes<3>. + (line 13) +* queue_event() (watchdog.observers.api.EventEmitter method): Classes. + (line 26) +* queue_events() (watchdog.observers.api.EventEmitter method): Classes. + (line 35) +* regexes (watchdog.events.RegexMatchingEventHandler property): Event Handler Classes. + (line 138) +* RegexMatchingEventHandler (class in watchdog.events): Event Handler Classes. + (line 107) +* remove_handler_for_watch() (watchdog.observers.api.BaseObserver method): Classes. + (line 166) +* run() (watchdog.observers.api.EventDispatcher method): Classes. + (line 98) +* run() (watchdog.observers.api.EventEmitter method): Classes. + (line 44) +* run() (watchdog.utils.BaseThread method): Classes<4>. (line 107) +* schedule() (watchdog.observers.api.BaseObserver method): Classes. + (line 183) +* ShellCommandTrick (class in watchdog.tricks): Classes<6>. (line 62) +* should_keep_running() (watchdog.utils.BaseThread method): Classes<4>. + (line 117) +* src_path (watchdog.events.FileSystemEvent property): Event Classes. + (line 32) +* start() (watchdog.observers.api.BaseObserver method): Classes. + (line 208) +* start() (watchdog.utils.BaseThread method): Classes<4>. (line 121) +* stat_info() (watchdog.utils.dirsnapshot.DirectorySnapshot method): Classes<5>. + (line 45) +* stop() (watchdog.utils.BaseThread method): Classes<4>. (line 132) +* timeout (watchdog.observers.api.EventDispatcher property): Classes. + (line 108) +* timeout (watchdog.observers.api.EventEmitter property): Classes. + (line 54) +* Trick (class in watchdog.tricks): Classes<6>. (line 6) +* unschedule() (watchdog.observers.api.BaseObserver method): Classes. + (line 219) +* unschedule_all() (watchdog.observers.api.BaseObserver method): Classes. + (line 228) +* watch (watchdog.observers.api.EventEmitter property): Classes. + (line 58) + + + +Tag Table: +Node: Top360 +Ref: index doc588 +Ref: 7588 +Node: Directory monitoring made easy with995 +Ref: index directory-monitoring-made-easy-with1110 +Ref: 81110 +Ref: index watchdog1110 +Ref: 91110 +Ref: index zc-buildout1110 +Ref: a1110 +Node: Easy installation1351 +Ref: index easy-installation1477 +Ref: c1477 +Ref: Easy installation-Footnote-11723 +Node: User’s Guide1764 +Ref: index user-s-guide1865 +Ref: e1865 +Node: Installation1971 +Ref: installation doc2055 +Ref: f2055 +Ref: installation id12055 +Ref: 102055 +Ref: installation installation2055 +Ref: d2055 +Node: Installing from PyPI using pip2372 +Ref: installation installing-from-pypi-using-pip2493 +Ref: 122493 +Node: Installing from source tarballs2713 +Ref: installation installing-from-source-tarballs2878 +Ref: 132878 +Node: Installing from the code repository3235 +Ref: installation installing-from-the-code-repository3382 +Ref: 143382 +Node: Dependencies3681 +Ref: installation dependencies3828 +Ref: 153828 +Ref: installation installation-dependencies3828 +Ref: 113828 +Ref: Dependencies-Footnote-15274 +Ref: Dependencies-Footnote-25340 +Node: Installing Dependencies5372 +Ref: installation installing-dependencies5446 +Ref: 165446 +Ref: Installing Dependencies-Footnote-15907 +Ref: Installing Dependencies-Footnote-25939 +Ref: Installing Dependencies-Footnote-35979 +Ref: Installing Dependencies-Footnote-46004 +Node: Supported Platforms and Caveats6036 +Ref: installation supported-platforms-and-caveats6139 +Ref: 176139 +Ref: installation bsd-unix-variants7791 +Ref: 187791 +Ref: Supported Platforms and Caveats-Footnote-19887 +Ref: Supported Platforms and Caveats-Footnote-29931 +Ref: Supported Platforms and Caveats-Footnote-39998 +Ref: Supported Platforms and Caveats-Footnote-410130 +Ref: Supported Platforms and Caveats-Footnote-510258 +Ref: Supported Platforms and Caveats-Footnote-610325 +Ref: Supported Platforms and Caveats-Footnote-710420 +Node: Quickstart10515 +Ref: quickstart doc10621 +Ref: 1910621 +Ref: quickstart id110621 +Ref: 1a10621 +Ref: quickstart quickstart10621 +Ref: b10621 +Node: A Simple Example11609 +Ref: quickstart a-simple-example11674 +Ref: 1e11674 +Node: API Reference12624 +Ref: api doc12730 +Ref: 1f12730 +Ref: api api-reference12730 +Ref: 2012730 +Node: watchdog events13087 +Ref: api module-watchdog events13185 +Ref: 013185 +Ref: api watchdog-events13185 +Ref: 2113185 +Node: Event Classes13476 +Ref: api event-classes13573 +Ref: 2213573 +Ref: api watchdog events FileSystemEvent13614 +Ref: 2313614 +Ref: api watchdog events FileSystemEvent event_type13961 +Ref: 2413961 +Ref: api watchdog events FileSystemEvent is_directory14046 +Ref: 2514046 +Ref: api watchdog events FileSystemEvent is_synthetic14159 +Ref: 2614159 +Ref: api watchdog events FileSystemEvent src_path14418 +Ref: 2714418 +Ref: api watchdog events FileSystemMovedEvent14533 +Ref: 2814533 +Ref: api watchdog events FileSystemMovedEvent dest_path14731 +Ref: 2914731 +Ref: api watchdog events FileMovedEvent14812 +Ref: 2a14812 +Ref: api watchdog events DirMovedEvent15009 +Ref: 2b15009 +Ref: api watchdog events FileModifiedEvent15215 +Ref: 2c15215 +Ref: api watchdog events DirModifiedEvent15408 +Ref: 2d15408 +Ref: api watchdog events FileCreatedEvent15605 +Ref: 2e15605 +Ref: api watchdog events FileClosedEvent15788 +Ref: 2f15788 +Ref: api watchdog events DirCreatedEvent15967 +Ref: 3015967 +Ref: api watchdog events FileDeletedEvent16159 +Ref: 3116159 +Ref: api watchdog events DirDeletedEvent16342 +Ref: 3216342 +Node: Event Handler Classes16534 +Ref: api event-handler-classes16631 +Ref: 3316631 +Ref: api watchdog events FileSystemEventHandler16688 +Ref: 1c16688 +Ref: api watchdog events FileSystemEventHandler dispatch16838 +Ref: 3416838 +Ref: api watchdog events FileSystemEventHandler on_any_event17062 +Ref: 3517062 +Ref: api watchdog events FileSystemEventHandler on_closed17269 +Ref: 3617269 +Ref: api watchdog events FileSystemEventHandler on_created17477 +Ref: 3717477 +Ref: api watchdog events FileSystemEventHandler on_deleted17733 +Ref: 3817733 +Ref: api watchdog events FileSystemEventHandler on_modified17989 +Ref: 3917989 +Ref: api watchdog events FileSystemEventHandler on_moved18253 +Ref: 3a18253 +Ref: api watchdog events PatternMatchingEventHandler18514 +Ref: 3b18514 +Ref: api watchdog events PatternMatchingEventHandler case_sensitive18823 +Ref: 3c18823 +Ref: api watchdog events PatternMatchingEventHandler dispatch18976 +Ref: 3d18976 +Ref: api watchdog events PatternMatchingEventHandler ignore_directories19200 +Ref: 3e19200 +Ref: api watchdog events PatternMatchingEventHandler ignore_patterns19340 +Ref: 3f19340 +Ref: api watchdog events PatternMatchingEventHandler patterns19440 +Ref: 4019440 +Ref: api watchdog events RegexMatchingEventHandler19532 +Ref: 4119532 +Ref: api watchdog events RegexMatchingEventHandler case_sensitive19836 +Ref: 4219836 +Ref: api watchdog events RegexMatchingEventHandler dispatch19989 +Ref: 4319989 +Ref: api watchdog events RegexMatchingEventHandler ignore_directories20213 +Ref: 4420213 +Ref: api watchdog events RegexMatchingEventHandler ignore_regexes20353 +Ref: 4520353 +Ref: api watchdog events RegexMatchingEventHandler regexes20451 +Ref: 4620451 +Ref: api watchdog events LoggingEventHandler20541 +Ref: 1d20541 +Ref: api watchdog events LoggingEventHandler on_created20702 +Ref: 4720702 +Ref: api watchdog events LoggingEventHandler on_deleted20958 +Ref: 4820958 +Ref: api watchdog events LoggingEventHandler on_modified21214 +Ref: 4921214 +Ref: api watchdog events LoggingEventHandler on_moved21478 +Ref: 4a21478 +Node: watchdog observers api21739 +Ref: api module-watchdog observers api21864 +Ref: 221864 +Ref: api watchdog-observers-api21864 +Ref: 4b21864 +Node: Immutables21980 +Ref: api immutables22071 +Ref: 4c22071 +Ref: api watchdog observers api ObservedWatch22106 +Ref: 4d22106 +Ref: api watchdog observers api ObservedWatch is_recursive22371 +Ref: 4e22371 +Ref: api watchdog observers api ObservedWatch path22475 +Ref: 4f22475 +Node: Collections22546 +Ref: api collections22653 +Ref: 5022653 +Ref: api watchdog observers api EventQueue22690 +Ref: 5122690 +Node: Classes23111 +Ref: api classes23199 +Ref: 5223199 +Ref: api watchdog observers api EventEmitter23228 +Ref: 5323228 +Ref: api watchdog observers api EventEmitter queue_event23866 +Ref: 5523866 +Ref: api watchdog observers api EventEmitter queue_events24094 +Ref: 5624094 +Ref: api watchdog observers api EventEmitter run24372 +Ref: 5724372 +Ref: api watchdog observers api EventEmitter timeout24766 +Ref: 5824766 +Ref: api watchdog observers api EventEmitter watch24842 +Ref: 5924842 +Ref: api watchdog observers api EventDispatcher24919 +Ref: 5a24919 +Ref: api watchdog observers api EventDispatcher dispatch_events25283 +Ref: 5b25283 +Ref: api watchdog observers api EventDispatcher event_queue25838 +Ref: 5c25838 +Ref: api watchdog observers api EventDispatcher run26033 +Ref: 5d26033 +Ref: api watchdog observers api EventDispatcher timeout26427 +Ref: 5e26427 +Ref: api watchdog observers api BaseObserver26493 +Ref: 5f26493 +Ref: api watchdog observers api BaseObserver add_handler_for_watch26662 +Ref: 6026662 +Ref: api watchdog observers api BaseObserver dispatch_events27282 +Ref: 6127282 +Ref: api watchdog observers api BaseObserver emitters27837 +Ref: 6227837 +Ref: api watchdog observers api BaseObserver on_thread_stop27925 +Ref: 6327925 +Ref: api watchdog observers api BaseObserver remove_handler_for_watch28154 +Ref: 6428154 +Ref: api watchdog observers api BaseObserver schedule28783 +Ref: 6528783 +Ref: api watchdog observers api BaseObserver start29701 +Ref: 6629701 +Ref: api watchdog observers api BaseObserver unschedule30054 +Ref: 6730054 +Ref: api watchdog observers api BaseObserver unschedule_all30292 +Ref: 6830292 +Node: watchdog observers30417 +Ref: api module-watchdog observers30553 +Ref: 130553 +Ref: api watchdog-observers30553 +Ref: 6930553 +Node: Classes<2>30851 +Ref: api id130918 +Ref: 6a30918 +Ref: api watchdog observers Observer30947 +Ref: 1b30947 +Node: watchdog observers polling32511 +Ref: api module-watchdog observers polling32639 +Ref: 332639 +Ref: api watchdog-observers-polling32639 +Ref: 6c32639 +Node: Classes<3>32935 +Ref: api id233010 +Ref: 6d33010 +Ref: api watchdog observers polling PollingObserver33039 +Ref: 6b33039 +Ref: api watchdog observers polling PollingObserverVFS33261 +Ref: 6e33261 +Ref: api watchdog observers polling PollingObserverVFS __init__33511 +Ref: 6f33511 +Node: watchdog utils33903 +Ref: api module-watchdog utils34039 +Ref: 534039 +Ref: api watchdog-utils34039 +Ref: 7034039 +Node: Classes<4>34298 +Ref: api id334361 +Ref: 7134361 +Ref: api watchdog utils BaseThread34390 +Ref: 5434390 +Ref: api watchdog utils BaseThread daemon34520 +Ref: 7234520 +Ref: api watchdog utils BaseThread ident35028 +Ref: 7335028 +Ref: api watchdog utils BaseThread isAlive35392 +Ref: 7435392 +Ref: api watchdog utils BaseThread is_alive35530 +Ref: 7535530 +Ref: api watchdog utils BaseThread join35815 +Ref: 7635815 +Ref: api watchdog utils BaseThread name36941 +Ref: 7736941 +Ref: api watchdog utils BaseThread native_id37158 +Ref: 7837158 +Ref: api watchdog utils BaseThread on_thread_start37443 +Ref: 7937443 +Ref: api watchdog utils BaseThread on_thread_stop37715 +Ref: 7b37715 +Ref: api watchdog utils BaseThread run37953 +Ref: 7d37953 +Ref: api watchdog utils BaseThread should_keep_running38347 +Ref: 7e38347 +Ref: api watchdog utils BaseThread start38454 +Ref: 7a38454 +Ref: api watchdog utils BaseThread stop38807 +Ref: 7c38807 +Node: watchdog utils dirsnapshot38872 +Ref: api module-watchdog utils dirsnapshot38997 +Ref: 638997 +Ref: api watchdog-utils-dirsnapshot38997 +Ref: 7f38997 +Node: Classes<5>39763 +Ref: api id439838 +Ref: 8039838 +Ref: api watchdog utils dirsnapshot DirectorySnapshot39867 +Ref: 8139867 +Ref: api watchdog utils dirsnapshot DirectorySnapshot inode40803 +Ref: 8240803 +Ref: api watchdog utils dirsnapshot DirectorySnapshot path40869 +Ref: 8340869 +Ref: api watchdog utils dirsnapshot DirectorySnapshot paths40970 +Ref: 8440970 +Ref: api watchdog utils dirsnapshot DirectorySnapshot stat_info41052 +Ref: 8541052 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff41499 +Ref: 8641499 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff dirs_created42595 +Ref: 8742595 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff dirs_deleted42678 +Ref: 8842678 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff dirs_modified42761 +Ref: 8942761 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff dirs_moved42846 +Ref: 8a42846 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff files_created43063 +Ref: 8b43063 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff files_deleted43141 +Ref: 8c43141 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff files_modified43219 +Ref: 8d43219 +Ref: api watchdog utils dirsnapshot DirectorySnapshotDiff files_moved43299 +Ref: 8e43299 +Ref: api watchdog utils dirsnapshot EmptyDirectorySnapshot43511 +Ref: 8f43511 +Ref: api watchdog utils dirsnapshot EmptyDirectorySnapshot path43792 +Ref: 9043792 +Ref: api watchdog utils dirsnapshot EmptyDirectorySnapshot paths43997 +Ref: 9143997 +Node: watchdog tricks44235 +Ref: api module-watchdog tricks44337 +Ref: 444337 +Ref: api watchdog-tricks44337 +Ref: 9244337 +Node: Classes<6>44592 +Ref: api id544656 +Ref: 9344656 +Ref: api watchdog tricks Trick44685 +Ref: 9444685 +Ref: api watchdog tricks LoggerTrick44929 +Ref: 9544929 +Ref: api watchdog tricks LoggerTrick on_any_event45170 +Ref: 9645170 +Ref: api watchdog tricks LoggerTrick on_created45372 +Ref: 9745372 +Ref: api watchdog tricks LoggerTrick on_deleted45608 +Ref: 9845608 +Ref: api watchdog tricks LoggerTrick on_modified45844 +Ref: 9945844 +Ref: api watchdog tricks LoggerTrick on_moved46098 +Ref: 9a46098 +Ref: api watchdog tricks ShellCommandTrick46339 +Ref: 9b46339 +Ref: api watchdog tricks ShellCommandTrick on_any_event46647 +Ref: 9c46647 +Ref: api watchdog tricks AutoRestartTrick46849 +Ref: 9d46849 +Ref: api watchdog tricks AutoRestartTrick on_any_event47387 +Ref: 9e47387 +Node: Contributing47589 +Ref: hacking doc47676 +Ref: 9f47676 +Ref: hacking contributing47676 +Ref: a047676 +Ref: hacking hacking47676 +Ref: a147676 +Node: Important URLs47927 +Ref: hacking important-urls48017 +Ref: a248017 +Ref: Important URLs-Footnote-148301 +Ref: Important URLs-Footnote-248330 +Ref: Important URLs-Footnote-348379 +Ref: Important URLs-Footnote-448407 +Node: Before you start48463 +Ref: hacking before-you-start48593 +Ref: a348593 +Ref: Before you start-Footnote-148824 +Ref: Before you start-Footnote-248851 +Ref: Before you start-Footnote-348880 +Node: Setting up the Work Environment48946 +Ref: hacking setting-up-the-work-environment49053 +Ref: a449053 +Ref: Setting up the Work Environment-Footnote-149915 +Ref: Setting up the Work Environment-Footnote-249964 +Node: Contribute49992 +Ref: index contribute50094 +Ref: a550094 +Ref: Contribute-Footnote-150498 +Ref: Contribute-Footnote-250547 +Ref: Contribute-Footnote-350603 +Node: Indices and tables50659 +Ref: index indices-and-tables50766 +Ref: a650766 +Node: Python Module Index50848 +Node: Index51227 + +End Tag Table + + +Local Variables: +coding: utf-8 +End: