Search.setIndex({"alltitles": {"A Simple Example": [[4, "a-simple-example"]], "API Reference": [[0, null]], "Before you start": [[1, "before-you-start"]], "Classes": [[0, "classes"], [0, "id1"], [0, "id2"], [0, "id3"], [0, "id4"], [0, "id5"]], "Collections": [[0, "collections"]], "Contribute": [[2, "contribute"]], "Contributing": [[1, null]], "Dependencies": [[3, "dependencies"]], "Directory monitoring made easy with": [[2, "directory-monitoring-made-easy-with"]], "Easy installation": [[2, "easy-installation"]], "Event Classes": [[0, "event-classes"]], "Event Handler Classes": [[0, "event-handler-classes"]], "Immutables": [[0, "immutables"]], "Important URLs": [[1, "important-urls"]], "Indices and tables": [[2, "indices-and-tables"]], "Installation": [[3, null]], "Installing from PyPI using pip": [[3, "installing-from-pypi-using-pip"]], "Installing from source tarballs": [[3, "installing-from-source-tarballs"]], "Installing from the code repository": [[3, "installing-from-the-code-repository"]], "Quickstart": [[4, null]], "Setting up the Work Environment": [[1, "setting-up-the-work-environment"]], "Supported Platforms (and Caveats)": [[3, "supported-platforms-and-caveats"]], "Typing": [[4, "typing"]], "User\u2019s Guide": [[2, "user-s-guide"]], "Watchdog": [[2, null]], "Where are the moved events? They \u2018disappeared\u2019": [[0, null]], "watchdog.events": [[0, "module-watchdog.events"]], "watchdog.observers": [[0, "module-watchdog.observers"]], "watchdog.observers.api": [[0, "module-watchdog.observers.api"]], "watchdog.observers.polling": [[0, "module-watchdog.observers.polling"]], "watchdog.tricks": [[0, "module-watchdog.tricks"]], "watchdog.utils": [[0, "module-watchdog.utils"]], "watchdog.utils.dirsnapshot": [[0, "module-watchdog.utils.dirsnapshot"]]}, "docnames": ["api", "hacking", "index", "installation", "quickstart"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "hacking.rst", "index.rst", "installation.rst", "quickstart.rst"], "indexentries": {"__init__() (watchdog.observers.polling.pollingobservervfs method)": [[0, "watchdog.observers.polling.PollingObserverVFS.__init__", false]], "add_handler_for_watch() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.add_handler_for_watch", false]], "autorestarttrick (class in watchdog.tricks)": [[0, "watchdog.tricks.AutoRestartTrick", false]], "baseobserver (class in watchdog.observers.api)": [[0, "watchdog.observers.api.BaseObserver", false]], "basethread (class in watchdog.utils)": [[0, "watchdog.utils.BaseThread", false]], "case_sensitive (watchdog.events.patternmatchingeventhandler property)": [[0, "watchdog.events.PatternMatchingEventHandler.case_sensitive", false]], "case_sensitive (watchdog.events.regexmatchingeventhandler property)": [[0, "watchdog.events.RegexMatchingEventHandler.case_sensitive", false]], "daemon (watchdog.utils.basethread property)": [[0, "watchdog.utils.BaseThread.daemon", false]], "dircreatedevent (class in watchdog.events)": [[0, "watchdog.events.DirCreatedEvent", false]], "dirdeletedevent (class in watchdog.events)": [[0, "watchdog.events.DirDeletedEvent", false]], "directorysnapshot (class in watchdog.utils.dirsnapshot)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshot", false]], "directorysnapshotdiff (class in watchdog.utils.dirsnapshot)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff", false]], "directorysnapshotdiff.contextmanager (class in watchdog.utils.dirsnapshot)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.ContextManager", false]], "dirmodifiedevent (class in watchdog.events)": [[0, "watchdog.events.DirModifiedEvent", false]], "dirmovedevent (class in watchdog.events)": [[0, "watchdog.events.DirMovedEvent", false]], "dirs_created (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.dirs_created", false]], "dirs_deleted (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.dirs_deleted", false]], "dirs_modified (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.dirs_modified", false]], "dirs_moved (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.dirs_moved", false]], "dispatch() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.dispatch", false]], "dispatch() (watchdog.events.patternmatchingeventhandler method)": [[0, "watchdog.events.PatternMatchingEventHandler.dispatch", false]], "dispatch() (watchdog.events.regexmatchingeventhandler method)": [[0, "watchdog.events.RegexMatchingEventHandler.dispatch", false]], "dispatch_events() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.dispatch_events", false]], "dispatch_events() (watchdog.observers.api.eventdispatcher method)": [[0, "watchdog.observers.api.EventDispatcher.dispatch_events", false]], "emitters (watchdog.observers.api.baseobserver property)": [[0, "watchdog.observers.api.BaseObserver.emitters", false]], "emptydirectorysnapshot (class in watchdog.utils.dirsnapshot)": [[0, "watchdog.utils.dirsnapshot.EmptyDirectorySnapshot", false]], "event_filter (watchdog.observers.api.observedwatch property)": [[0, "watchdog.observers.api.ObservedWatch.event_filter", false]], "event_queue (watchdog.observers.api.eventdispatcher property)": [[0, "watchdog.observers.api.EventDispatcher.event_queue", false]], "eventdispatcher (class in watchdog.observers.api)": [[0, "watchdog.observers.api.EventDispatcher", false]], "eventemitter (class in watchdog.observers.api)": [[0, "watchdog.observers.api.EventEmitter", false]], "eventqueue (class in watchdog.observers.api)": [[0, "watchdog.observers.api.EventQueue", false]], "fileclosedevent (class in watchdog.events)": [[0, "watchdog.events.FileClosedEvent", false]], "fileclosednowriteevent (class in watchdog.events)": [[0, "watchdog.events.FileClosedNoWriteEvent", false]], "filecreatedevent (class in watchdog.events)": [[0, "watchdog.events.FileCreatedEvent", false]], "filedeletedevent (class in watchdog.events)": [[0, "watchdog.events.FileDeletedEvent", false]], "filemodifiedevent (class in watchdog.events)": [[0, "watchdog.events.FileModifiedEvent", false]], "filemovedevent (class in watchdog.events)": [[0, "watchdog.events.FileMovedEvent", false]], "fileopenedevent (class in watchdog.events)": [[0, "watchdog.events.FileOpenedEvent", false]], "files_created (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.files_created", false]], "files_deleted (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.files_deleted", false]], "files_modified (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.files_modified", false]], "files_moved (watchdog.utils.dirsnapshot.directorysnapshotdiff property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshotDiff.files_moved", false]], "filesystemevent (class in watchdog.events)": [[0, "watchdog.events.FileSystemEvent", false]], "filesystemeventhandler (class in watchdog.events)": [[0, "watchdog.events.FileSystemEventHandler", false]], "filesystemmovedevent (class in watchdog.events)": [[0, "watchdog.events.FileSystemMovedEvent", false]], "getname() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.getName", false]], "ident (watchdog.utils.basethread property)": [[0, "watchdog.utils.BaseThread.ident", false]], "ignore_directories (watchdog.events.patternmatchingeventhandler property)": [[0, "watchdog.events.PatternMatchingEventHandler.ignore_directories", false]], "ignore_directories (watchdog.events.regexmatchingeventhandler property)": [[0, "watchdog.events.RegexMatchingEventHandler.ignore_directories", false]], "ignore_patterns (watchdog.events.patternmatchingeventhandler property)": [[0, "watchdog.events.PatternMatchingEventHandler.ignore_patterns", false]], "ignore_regexes (watchdog.events.regexmatchingeventhandler property)": [[0, "watchdog.events.RegexMatchingEventHandler.ignore_regexes", false]], "inode() (watchdog.utils.dirsnapshot.directorysnapshot method)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshot.inode", false]], "is_alive() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.is_alive", false]], "is_directory (watchdog.events.dircreatedevent attribute)": [[0, "watchdog.events.DirCreatedEvent.is_directory", false]], "is_directory (watchdog.events.dirdeletedevent attribute)": [[0, "watchdog.events.DirDeletedEvent.is_directory", false]], "is_directory (watchdog.events.dirmodifiedevent attribute)": [[0, "watchdog.events.DirModifiedEvent.is_directory", false]], "is_directory (watchdog.events.dirmovedevent attribute)": [[0, "watchdog.events.DirMovedEvent.is_directory", false]], "is_directory (watchdog.events.filesystemevent attribute)": [[0, "watchdog.events.FileSystemEvent.is_directory", false]], "is_recursive (watchdog.observers.api.observedwatch property)": [[0, "watchdog.observers.api.ObservedWatch.is_recursive", false]], "isdaemon() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.isDaemon", false]], "join() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.join", false]], "loggertrick (class in watchdog.tricks)": [[0, "watchdog.tricks.LoggerTrick", false]], "loggingeventhandler (class in watchdog.events)": [[0, "watchdog.events.LoggingEventHandler", false]], "module": [[0, "module-watchdog.events", false], [0, "module-watchdog.observers", false], [0, "module-watchdog.observers.api", false], [0, "module-watchdog.observers.polling", false], [0, "module-watchdog.tricks", false], [0, "module-watchdog.utils", false], [0, "module-watchdog.utils.dirsnapshot", false]], "name (watchdog.utils.basethread property)": [[0, "watchdog.utils.BaseThread.name", false]], "native_id (watchdog.utils.basethread property)": [[0, "watchdog.utils.BaseThread.native_id", false]], "observedwatch (class in watchdog.observers.api)": [[0, "watchdog.observers.api.ObservedWatch", false]], "observer (in module watchdog.observers)": [[0, "watchdog.observers.Observer", false]], "on_any_event() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_any_event", false]], "on_any_event() (watchdog.tricks.autorestarttrick method)": [[0, "watchdog.tricks.AutoRestartTrick.on_any_event", false]], "on_any_event() (watchdog.tricks.loggertrick method)": [[0, "watchdog.tricks.LoggerTrick.on_any_event", false]], "on_any_event() (watchdog.tricks.shellcommandtrick method)": [[0, "watchdog.tricks.ShellCommandTrick.on_any_event", false]], "on_closed() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_closed", false]], "on_closed() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_closed", false]], "on_closed_no_write() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_closed_no_write", false]], "on_closed_no_write() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_closed_no_write", false]], "on_created() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_created", false]], "on_created() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_created", false]], "on_deleted() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_deleted", false]], "on_deleted() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_deleted", false]], "on_modified() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_modified", false]], "on_modified() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_modified", false]], "on_moved() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_moved", false]], "on_moved() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_moved", false]], "on_opened() (watchdog.events.filesystemeventhandler method)": [[0, "watchdog.events.FileSystemEventHandler.on_opened", false]], "on_opened() (watchdog.events.loggingeventhandler method)": [[0, "watchdog.events.LoggingEventHandler.on_opened", false]], "on_thread_start() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.on_thread_start", false]], "on_thread_stop() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.on_thread_stop", false]], "on_thread_stop() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.on_thread_stop", false]], "path (watchdog.observers.api.observedwatch property)": [[0, "watchdog.observers.api.ObservedWatch.path", false]], "path() (watchdog.utils.dirsnapshot.directorysnapshot method)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshot.path", false]], "path() (watchdog.utils.dirsnapshot.emptydirectorysnapshot static method)": [[0, "watchdog.utils.dirsnapshot.EmptyDirectorySnapshot.path", false]], "paths (watchdog.utils.dirsnapshot.directorysnapshot property)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshot.paths", false]], "paths (watchdog.utils.dirsnapshot.emptydirectorysnapshot property)": [[0, "watchdog.utils.dirsnapshot.EmptyDirectorySnapshot.paths", false]], "patternmatchingeventhandler (class in watchdog.events)": [[0, "watchdog.events.PatternMatchingEventHandler", false]], "patterns (watchdog.events.patternmatchingeventhandler property)": [[0, "watchdog.events.PatternMatchingEventHandler.patterns", false]], "pollingobserver (class in watchdog.observers.polling)": [[0, "watchdog.observers.polling.PollingObserver", false]], "pollingobservervfs (class in watchdog.observers.polling)": [[0, "watchdog.observers.polling.PollingObserverVFS", false]], "queue_event() (watchdog.observers.api.eventemitter method)": [[0, "watchdog.observers.api.EventEmitter.queue_event", false]], "queue_events() (watchdog.observers.api.eventemitter method)": [[0, "watchdog.observers.api.EventEmitter.queue_events", false]], "regexes (watchdog.events.regexmatchingeventhandler property)": [[0, "watchdog.events.RegexMatchingEventHandler.regexes", false]], "regexmatchingeventhandler (class in watchdog.events)": [[0, "watchdog.events.RegexMatchingEventHandler", false]], "remove_handler_for_watch() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.remove_handler_for_watch", false]], "run() (watchdog.observers.api.eventdispatcher method)": [[0, "watchdog.observers.api.EventDispatcher.run", false]], "run() (watchdog.observers.api.eventemitter method)": [[0, "watchdog.observers.api.EventEmitter.run", false]], "run() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.run", false]], "schedule() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.schedule", false]], "setdaemon() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.setDaemon", false]], "setname() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.setName", false]], "shellcommandtrick (class in watchdog.tricks)": [[0, "watchdog.tricks.ShellCommandTrick", false]], "should_keep_running() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.should_keep_running", false]], "start() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.start", false]], "start() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.start", false]], "stat_info() (watchdog.utils.dirsnapshot.directorysnapshot method)": [[0, "watchdog.utils.dirsnapshot.DirectorySnapshot.stat_info", false]], "stop() (watchdog.observers.api.eventdispatcher method)": [[0, "watchdog.observers.api.EventDispatcher.stop", false]], "stop() (watchdog.utils.basethread method)": [[0, "watchdog.utils.BaseThread.stop", false]], "stop_event (watchdog.observers.api.eventdispatcher attribute)": [[0, "watchdog.observers.api.EventDispatcher.stop_event", false]], "timeout (watchdog.observers.api.eventdispatcher property)": [[0, "watchdog.observers.api.EventDispatcher.timeout", false]], "timeout (watchdog.observers.api.eventemitter property)": [[0, "watchdog.observers.api.EventEmitter.timeout", false]], "trick (class in watchdog.tricks)": [[0, "watchdog.tricks.Trick", false]], "unschedule() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.unschedule", false]], "unschedule_all() (watchdog.observers.api.baseobserver method)": [[0, "watchdog.observers.api.BaseObserver.unschedule_all", false]], "watch (watchdog.observers.api.eventemitter property)": [[0, "watchdog.observers.api.EventEmitter.watch", false]], "watchdog.events": [[0, "module-watchdog.events", false]], "watchdog.observers": [[0, "module-watchdog.observers", false]], "watchdog.observers.api": [[0, "module-watchdog.observers.api", false]], "watchdog.observers.polling": [[0, "module-watchdog.observers.polling", false]], "watchdog.tricks": [[0, "module-watchdog.tricks", false]], "watchdog.utils": [[0, "module-watchdog.utils", false]], "watchdog.utils.dirsnapshot": [[0, "module-watchdog.utils.dirsnapshot", false]]}, "objects": {"watchdog": [[0, 0, 0, "-", "events"], [0, 0, 0, "-", "observers"], [0, 0, 0, "-", "tricks"], [0, 0, 0, "-", "utils"]], "watchdog.events": [[0, 1, 1, "", "DirCreatedEvent"], [0, 1, 1, "", "DirDeletedEvent"], [0, 1, 1, "", "DirModifiedEvent"], [0, 1, 1, "", "DirMovedEvent"], [0, 1, 1, "", "FileClosedEvent"], [0, 1, 1, "", "FileClosedNoWriteEvent"], [0, 1, 1, "", "FileCreatedEvent"], [0, 1, 1, "", "FileDeletedEvent"], [0, 1, 1, "", "FileModifiedEvent"], [0, 1, 1, "", "FileMovedEvent"], [0, 1, 1, "", "FileOpenedEvent"], [0, 1, 1, "", "FileSystemEvent"], [0, 1, 1, "", "FileSystemEventHandler"], [0, 1, 1, "", "FileSystemMovedEvent"], [0, 1, 1, "", "LoggingEventHandler"], [0, 1, 1, "", "PatternMatchingEventHandler"], [0, 1, 1, "", "RegexMatchingEventHandler"]], "watchdog.events.DirCreatedEvent": [[0, 2, 1, "", "is_directory"]], "watchdog.events.DirDeletedEvent": [[0, 2, 1, "", "is_directory"]], "watchdog.events.DirModifiedEvent": [[0, 2, 1, "", "is_directory"]], "watchdog.events.DirMovedEvent": [[0, 2, 1, "", "is_directory"]], "watchdog.events.FileSystemEvent": [[0, 2, 1, "", "is_directory"]], "watchdog.events.FileSystemEventHandler": [[0, 3, 1, "", "dispatch"], [0, 3, 1, "", "on_any_event"], [0, 3, 1, "", "on_closed"], [0, 3, 1, "", "on_closed_no_write"], [0, 3, 1, "", "on_created"], [0, 3, 1, "", "on_deleted"], [0, 3, 1, "", "on_modified"], [0, 3, 1, "", "on_moved"], [0, 3, 1, "", "on_opened"]], "watchdog.events.LoggingEventHandler": [[0, 3, 1, "", "on_closed"], [0, 3, 1, "", "on_closed_no_write"], [0, 3, 1, "", "on_created"], [0, 3, 1, "", "on_deleted"], [0, 3, 1, "", "on_modified"], [0, 3, 1, "", "on_moved"], [0, 3, 1, "", "on_opened"]], "watchdog.events.PatternMatchingEventHandler": [[0, 4, 1, "", "case_sensitive"], [0, 3, 1, "", "dispatch"], [0, 4, 1, "", "ignore_directories"], [0, 4, 1, "", "ignore_patterns"], [0, 4, 1, "", "patterns"]], "watchdog.events.RegexMatchingEventHandler": [[0, 4, 1, "", "case_sensitive"], [0, 3, 1, "", "dispatch"], [0, 4, 1, "", "ignore_directories"], [0, 4, 1, "", "ignore_regexes"], [0, 4, 1, "", "regexes"]], "watchdog.observers": [[0, 2, 1, "", "Observer"], [0, 0, 0, "-", "api"], [0, 0, 0, "-", "polling"]], "watchdog.observers.api": [[0, 1, 1, "", "BaseObserver"], [0, 1, 1, "", "EventDispatcher"], [0, 1, 1, "", "EventEmitter"], [0, 1, 1, "", "EventQueue"], [0, 1, 1, "", "ObservedWatch"]], "watchdog.observers.api.BaseObserver": [[0, 3, 1, "", "add_handler_for_watch"], [0, 3, 1, "", "dispatch_events"], [0, 4, 1, "", "emitters"], [0, 3, 1, "", "on_thread_stop"], [0, 3, 1, "", "remove_handler_for_watch"], [0, 3, 1, "", "schedule"], [0, 3, 1, "", "start"], [0, 3, 1, "", "unschedule"], [0, 3, 1, "", "unschedule_all"]], "watchdog.observers.api.EventDispatcher": [[0, 3, 1, "", "dispatch_events"], [0, 4, 1, "", "event_queue"], [0, 3, 1, "", "run"], [0, 3, 1, "", "stop"], [0, 2, 1, "", "stop_event"], [0, 4, 1, "", "timeout"]], "watchdog.observers.api.EventEmitter": [[0, 3, 1, "", "queue_event"], [0, 3, 1, "", "queue_events"], [0, 3, 1, "", "run"], [0, 4, 1, "", "timeout"], [0, 4, 1, "", "watch"]], "watchdog.observers.api.ObservedWatch": [[0, 4, 1, "", "event_filter"], [0, 4, 1, "", "is_recursive"], [0, 4, 1, "", "path"]], "watchdog.observers.polling": [[0, 1, 1, "", "PollingObserver"], [0, 1, 1, "", "PollingObserverVFS"]], "watchdog.observers.polling.PollingObserverVFS": [[0, 3, 1, "", "__init__"]], "watchdog.tricks": [[0, 1, 1, "", "AutoRestartTrick"], [0, 1, 1, "", "LoggerTrick"], [0, 1, 1, "", "ShellCommandTrick"], [0, 1, 1, "", "Trick"]], "watchdog.tricks.AutoRestartTrick": [[0, 3, 1, "", "on_any_event"]], "watchdog.tricks.LoggerTrick": [[0, 3, 1, "", "on_any_event"]], "watchdog.tricks.ShellCommandTrick": [[0, 3, 1, "", "on_any_event"]], "watchdog.utils": [[0, 1, 1, "", "BaseThread"], [0, 0, 0, "-", "dirsnapshot"]], "watchdog.utils.BaseThread": [[0, 4, 1, "", "daemon"], [0, 3, 1, "", "getName"], [0, 4, 1, "", "ident"], [0, 3, 1, "", "isDaemon"], [0, 3, 1, "", "is_alive"], [0, 3, 1, "", "join"], [0, 4, 1, "", "name"], [0, 4, 1, "", "native_id"], [0, 3, 1, "", "on_thread_start"], [0, 3, 1, "", "on_thread_stop"], [0, 3, 1, "", "run"], [0, 3, 1, "", "setDaemon"], [0, 3, 1, "", "setName"], [0, 3, 1, "", "should_keep_running"], [0, 3, 1, "", "start"], [0, 3, 1, "", "stop"]], "watchdog.utils.dirsnapshot": [[0, 1, 1, "", "DirectorySnapshot"], [0, 1, 1, "", "DirectorySnapshotDiff"], [0, 1, 1, "", "EmptyDirectorySnapshot"]], "watchdog.utils.dirsnapshot.DirectorySnapshot": [[0, 3, 1, "", "inode"], [0, 3, 1, "", "path"], [0, 4, 1, "", "paths"], [0, 3, 1, "", "stat_info"]], "watchdog.utils.dirsnapshot.DirectorySnapshotDiff": [[0, 1, 1, "", "ContextManager"], [0, 4, 1, "", "dirs_created"], [0, 4, 1, "", "dirs_deleted"], [0, 4, 1, "", "dirs_modified"], [0, 4, 1, "", "dirs_moved"], [0, 4, 1, "", "files_created"], [0, 4, 1, "", "files_deleted"], [0, 4, 1, "", "files_modified"], [0, 4, 1, "", "files_moved"]], "watchdog.utils.dirsnapshot.EmptyDirectorySnapshot": [[0, 3, 1, "", "path"], [0, 4, 1, "", "paths"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property"}, "terms": {"": [0, 1, 3], "0": [0, 1, 2, 3, 4], "1": [0, 4], "10": 0, "1024": 3, "13": 0, "16384": 3, "2": [0, 3], "2011": [0, 1, 2, 3, 4], "2024": [0, 1, 2, 3, 4], "222": [0, 1, 2, 3, 4], "3": [2, 3], "4": [0, 1, 2, 3, 4], "5": [0, 1, 2, 3, 4], "6": [0, 3], "7": 0, "8192": 3, "9": [2, 3], "A": [0, 2], "As": 0, "By": [0, 4], "For": [0, 4], "If": 4, "In": [0, 4], "It": 0, "Its": 0, "On": 3, "That": 1, "The": [0, 1, 3, 4], "These": 0, "To": [3, 4], "_": 0, "__init__": 0, "abil": 3, "abl": 3, "about": [2, 3], "account": 1, "activ": [0, 1], "actual": [0, 4], "ad": [0, 2], "add": [0, 3], "add_handler_for_watch": 0, "addit": 3, "after": 0, "again": 0, "alia": 0, "aliv": 0, "all": [0, 3], "allow": [0, 3], "also": [0, 2, 3], "alwai": 0, "an": [0, 2, 3, 4], "ani": [0, 4], "annot": 4, "anoth": 0, "api": [2, 3, 4], "append": 3, "appli": 3, "approach": 3, "appropri": 0, "ar": [3, 4], "arg": 0, "argument": 0, "arrang": 0, "associ": 0, "attach": [0, 4], "attempt": 0, "attribut": 0, "author": 0, "automat": 3, "autorestarttrick": 0, "avail": [0, 3, 4], "avoid": 0, "back": 3, "base": [0, 3], "baseobserv": [0, 4], "basethread": 0, "becaus": 3, "been": 0, "befor": [0, 2, 3], "begin": 1, "behavior": 3, "being": 3, "below": [3, 4], "best": 4, "between": [0, 3], "bin": [0, 1], "block": [0, 3, 4], "book": 3, "bool": 0, "boolean": 0, "boot": 0, "boundari": 0, "break": 0, "broadcast": 0, "bsd": [0, 3], "bug": [1, 2], "built": 0, "byte": 0, "c": [0, 3, 4], "call": [0, 3, 4], "callabl": 0, "can": [0, 1, 2, 3], "cannot": 3, "captur": 0, "case": 0, "case_sensit": 0, "catch": 0, "caus": 0, "caveat": 2, "cd": [1, 3], "chang": [0, 2, 3, 4], "child": 0, "class": 4, "clean": 1, "clone": [1, 3], "close": [0, 3], "code": [0, 1, 2, 4], "com": [0, 1, 3], "combin": 0, "come": 3, "command": [0, 2, 3], "compar": [0, 3], "comparison": 0, "complet": 3, "conf": 3, "configur": 3, "consecut": 0, "consider": 0, "consol": 4, "construct": 0, "constructor": 0, "consum": 0, "contact": [0, 1, 2, 3, 4], "contain": 3, "context": 0, "contextmanag": 0, "continu": 0, "contributor": [0, 1, 2, 3, 4], "control": [0, 4], "conveni": 0, "convert": 3, "copyright": [0, 1, 2, 3, 4], "correctli": 4, "creat": [0, 1, 3, 4], "creation": 0, "cross": [0, 2], "current": [0, 3, 4], "custom": 0, "daemon": 0, "darwin": 3, "deadlock": 0, "debounce_interval_second": 0, "decid": 0, "def": 4, "default": [0, 4], "delet": [0, 3], "depend": [0, 2], "deprec": 0, "descriptor": 3, "dest_path": 0, "detach": 0, "detail": 0, "detect": [0, 4], "determin": 0, "devic": 0, "dictionari": 0, "diff": 0, "differ": [0, 3], "dircreatedev": 0, "dirdeletedev": 0, "directli": 0, "directori": [0, 3, 4], "directorysnapshot": 0, "directorysnapshotdiff": 0, "direntri": 0, "dirmodifiedev": 0, "dirmovedev": 0, "dirs_creat": 0, "dirs_delet": 0, "dirs_modifi": 0, "dirs_mov": 0, "dirsnapshot": 2, "disk": 3, "dispatch": 0, "dispatch_ev": 0, "do": [0, 3, 4], "document": [1, 2], "doe": [0, 3], "drop_during_process": 0, "e": [1, 3], "each": 0, "easili": 2, "ed": 0, "edit": 3, "either": 0, "emit": 0, "emitt": 0, "emitter_class": 0, "empti": 0, "emptydirectorysnapshot": 0, "enhanc": 1, "ensur": [1, 3, 4], "entir": [0, 4], "entri": 0, "enumer": 0, "environ": 2, "error": 0, "etc": [0, 3], "even": [0, 3], "event": [2, 3, 4], "event_filt": 0, "event_handl": [0, 4], "event_queu": 0, "eventdispatch": 0, "eventemitt": 0, "eventqueu": 0, "everi": 0, "exact": 0, "exampl": 2, "except": 0, "execut": 0, "exit": 0, "expect": 0, "f": 3, "fall": 3, "fallback": [0, 3], "fals": 0, "featur": [1, 2], "few": 4, "file": [0, 1, 2, 3, 4], "fileclosedev": 0, "fileclosednowriteev": 0, "filecreatedev": 0, "filedeletedev": 0, "filemodifiedev": 0, "filemovedev": 0, "fileopenedev": 0, "files_cr": 0, "files_delet": 0, "files_modifi": 0, "files_mov": 0, "filesystemev": [0, 4], "filesystemeventhandl": [0, 4], "filesystemmovedev": 0, "filter": 0, "final": 4, "first": 0, "float": 0, "folder": 0, "follow": [1, 3, 4], "fork": [1, 2], "found": 2, "fr": [0, 1, 2, 3, 4], "fraction": 0, "from": [0, 2, 4], "frozenset": 0, "fsevent": [0, 3], "fseventsobserv": 0, "function": [0, 3], "gener": [0, 4], "get": [0, 1, 2], "get_id": 0, "get_native_id": 0, "getnam": 0, "git": [1, 3], "github": [1, 3], "given": 0, "googl": 0, "gorakhargosh": [1, 3], "got": 1, "guidelin": 3, "gz": 3, "ha": [0, 1], "hack": 1, "hacker": 1, "handl": 0, "handler": 4, "happen": 0, "happi": 1, "hard": 3, "have": [0, 1], "help": [1, 2], "henc": 0, "here": [0, 4], "hinder": 3, "histori": 1, "hold": 4, "host": 1, "how": 3, "http": [1, 3], "i": [0, 1, 3, 4], "id": 0, "ident": 0, "identif": 0, "identifi": 0, "ignor": 0, "ignore_devic": 0, "ignore_directori": 0, "ignore_pattern": 0, "ignore_regex": 0, "immedi": 0, "implement": [0, 3, 4], "import": [0, 2, 4], "includ": [0, 3], "independ": [0, 3], "index": 2, "indic": 0, "inform": [0, 2, 3], "inherit": 0, "ini": 0, "initi": 0, "inod": 0, "inotifi": [0, 3], "inotifyobserv": 0, "insert": 0, "instal": 1, "instanc": [0, 4], "instead": 0, "int": 0, "integ": 0, "integr": 0, "intend": 0, "interv": 0, "invok": 0, "is_al": 0, "is_directori": 0, "is_recurs": 0, "is_synthet": 0, "isdaemon": 0, "isdir": 0, "issu": [1, 2], "item": 0, "iter": 0, "its": [0, 1, 3], "job": 3, "join": [0, 4], "just": 0, "keep": 3, "kei": 0, "kernel": [0, 3], "keyword": 0, "kill_aft": 0, "kind": 0, "kqueue": [0, 3], "kqueueobserv": 0, "kwarg": 0, "later": 3, "least": 3, "left": 0, "librari": [1, 2, 3], "like": 1, "limit": 3, "linux": [0, 1, 3], "list": [0, 3], "listdir": 0, "lock": 3, "log": 0, "logger": 0, "loggertrick": 0, "loggingeventhandl": 0, "long": 0, "m": [1, 2, 3], "maco": [0, 1, 3], "made": 0, "mai": [0, 2, 3], "main": [0, 4], "maintain": 3, "manag": 0, "mangalapilli": [0, 1, 2, 3, 4], "mani": [0, 3], "match": 0, "max_user_watch": 3, "maximum": 3, "maxsiz": 0, "mean": 4, "method": 0, "micka\u00ebl": [0, 1, 2, 3, 4], "microsoft": 0, "mock": 0, "mode": 3, "modif": 0, "modifi": 0, "modul": [0, 2], "monitor": [0, 3, 4], "more": [0, 2, 3], "most": [0, 3], "move": 3, "movement": [0, 3], "mtime": 0, "much": 3, "multipl": 0, "must": 0, "my_func": 4, "myconfig": 0, "myeventhandl": 4, "myserv": 0, "n": 3, "name": 0, "nativ": [0, 3], "native_id": 0, "need": [0, 2, 3], "neg": 0, "new": 3, "non": [0, 3], "none": [0, 4], "nonzero": 0, "normal": 0, "note": [0, 3, 4], "now": 1, "number": [0, 3], "o": [0, 3], "ob": 4, "object": [0, 3], "observ": [2, 4], "observedwatch": 0, "obtain": 0, "occur": 0, "offici": 2, "on_any_ev": [0, 4], "on_clos": 0, "on_closed_no_writ": 0, "on_creat": 0, "on_delet": 0, "on_modifi": 0, "on_mov": 0, "on_open": 0, "on_thread_start": 0, "on_thread_stop": 0, "onc": 0, "one": [0, 3], "onli": [0, 3], "open": [0, 3], "oper": [0, 3], "option": 0, "order": [0, 3, 4], "org": 3, "other": 0, "otherwis": 0, "our": 4, "out": 0, "over": 3, "overrid": 0, "own": 4, "packag": 3, "page": 2, "paramet": 0, "part": 0, "partit": 0, "pass": [0, 4], "path": [0, 4], "pathlib": 0, "pattern": 0, "patternmatchingeventhandl": 0, "per": [0, 3], "perform": 3, "period": [0, 3], "pick": 0, "pip": [1, 2], "platform": [0, 2, 4], "point": 0, "poll": [2, 3], "polling_interv": 0, "pollingobserv": 0, "pollingobservervf": 0, "popul": 0, "possibl": 3, "prefer": 3, "present": [0, 4], "press": 4, "presum": 0, "print": 4, "problem": 0, "process": [0, 3], "produc": 0, "profil": 3, "program": [0, 1, 3, 4], "properti": 0, "provid": 3, "purepath": 0, "purpos": 0, "pypi": 2, "python": [0, 1, 2, 3], "pyyaml": 3, "queu": 0, "queue": [0, 3], "queue_ev": 0, "quicker": 0, "quickli": 2, "quickstart": 2, "rais": 0, "re": [0, 1], "read": [0, 3], "read_directory_chang": 0, "readdirectorychangesw": 3, "readi": 1, "receiv": 0, "recurs": [0, 3, 4], "recycl": 0, "ref": 0, "refer": 2, "regex": 0, "regexmatchingeventhandl": 0, "remov": 0, "remove_handler_for_watch": 0, "renam": [0, 3], "report": [0, 1, 3], "repositori": [1, 2], "repres": 0, "request": [0, 1], "requir": [0, 3], "respect": 0, "respons": [0, 2], "restart": 0, "restart_on_command_exit": 0, "return": [0, 3], "right": 0, "row": 3, "run": [0, 2], "runtimeerror": 0, "safe": 0, "same": [0, 3], "scan": 3, "scandir": 0, "schedul": [0, 4], "schoentgen": [0, 1, 2, 3, 4], "script": 1, "search": 2, "second": 0, "see": [0, 1, 2, 3], "self": 4, "semant": 0, "sensit": 0, "separ": 0, "sequenti": 0, "set": [0, 2, 3], "setdaemon": 0, "setnam": 0, "setup": 1, "shell": [0, 2], "shell_command": 0, "shellcommandtrick": 0, "should": [0, 3, 4], "should_keep_run": 0, "sigint": 0, "signal": 0, "simpl": [0, 2], "simpli": 4, "sinc": 3, "singl": 0, "skip": 0, "skiprepeatsqueu": 0, "sleep": 4, "snapshot": [0, 3], "so": [0, 1], "someth": [1, 4], "sourc": [0, 2], "special": 0, "specif": 0, "specifi": 0, "src_path": 0, "st_dev": 0, "st_ino": 0, "st_mode": 0, "st_mtime": 0, "standard": 0, "start": [0, 2, 4], "stat": 0, "stat_info": 0, "stat_result": 0, "static": 0, "step": 1, "still": 0, "stop": [0, 4], "stop_ev": 0, "stop_sign": 0, "stoppabl": 0, "str": 0, "string": 0, "structur": 0, "sub": [0, 4], "subclass": [0, 4], "subdirectori": 0, "subject": 0, "subprocess": 0, "success": 0, "successfulli": 3, "suitabl": 3, "support": 2, "sure": 0, "synchron": 3, "synopsi": 0, "synthes": 0, "sysctl": 3, "system": [0, 1, 2, 3, 4], "t": 0, "take": 0, "taken": 0, "tar": 3, "tarbal": 2, "target": 0, "termin": 0, "than": 0, "them": [0, 3, 4], "therefor": 0, "thereof": 0, "thi": [0, 1, 3], "think": 0, "those": 3, "thread": [0, 4], "through": 0, "thu": [0, 3], "ticket": 2, "tiger": [0, 1, 2, 3, 4], "time": [0, 4], "timeout": 0, "togeth": 0, "tool": 2, "track": 1, "tracker": [1, 2], "travers": [0, 4], "tree": [0, 3, 4], "tri": 3, "trick": 2, "trigger": 0, "true": [0, 4], "try": 4, "tupl": 0, "two": [0, 3], "type": [0, 2], "u": [2, 3], "uid": 0, "ulimit": 3, "underli": 3, "unhandl": 0, "uniqu": 0, "unix": 3, "unknown": 0, "unless": 0, "unmodifi": 0, "unmount": 3, "unschedul": 0, "unschedule_al": 0, "until": 0, "up": [0, 2], "url": 2, "us": [0, 1, 2, 4], "usag": 3, "user": 3, "util": [2, 3], "valu": [0, 3], "variabl": 4, "variant": 3, "venv": 1, "version": 3, "virtual": 1, "vista": 3, "volum": 3, "w": 3, "wa": 0, "wai": 3, "wait": [0, 4], "wait_for_process": 0, "want": 2, "watch": [0, 3], "watchdog": [1, 3, 4], "watchmedo": 3, "we": 4, "welcom": 1, "well": 3, "were": 0, "weren": 0, "wget": 3, "what": 4, "whee": 1, "when": [0, 3], "where": 1, "whether": [0, 3], "which": [0, 3, 4], "whichev": 3, "while": 4, "whose": 0, "window": [0, 1, 3], "windowsapiobserv": 0, "within": 3, "without": [3, 4], "work": [0, 2, 3], "would": [0, 1], "write": 0, "x": 3, "xcode": [1, 3], "ye": 3, "yesudeep": [0, 1, 2, 3, 4], "you": [0, 2, 3, 4], "your": [0, 1, 3, 4], "zxvf": 3}, "titles": ["API Reference", "Contributing", "Watchdog", "Installation", "Quickstart"], "titleterms": {"": 2, "A": 4, "api": 0, "ar": 0, "befor": 1, "caveat": 3, "class": 0, "code": 3, "collect": 0, "contribut": [1, 2], "depend": 3, "directori": 2, "dirsnapshot": 0, "disappear": 0, "easi": 2, "environ": 1, "event": 0, "exampl": 4, "from": 3, "guid": 2, "handler": 0, "immut": 0, "import": 1, "indic": 2, "instal": [2, 3], "made": 2, "monitor": 2, "move": 0, "observ": 0, "pip": 3, "platform": 3, "poll": 0, "pypi": 3, "quickstart": 4, "refer": 0, "repositori": 3, "set": 1, "simpl": 4, "sourc": 3, "start": 1, "support": 3, "tabl": 2, "tarbal": 3, "thei": 0, "trick": 0, "type": 4, "up": 1, "url": 1, "us": 3, "user": 2, "util": 0, "watchdog": [0, 2], "where": 0, "work": 1, "you": 1}})