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