| Server IP : 54.37.205.81 / Your IP : 216.73.216.76 Web Server : nginx/1.22.1 System : Linux vps-249481fa 6.1.0-50-cloud-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.176-1 (2026-07-02) x86_64 User : debian ( 1000) PHP Version : 8.2.32 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /usr/share/doc/python3-watchdog/html/ |
Upload File : |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Watchdog — watchdog 2.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pyramid.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">watchdog 2.2.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Watchdog</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="watchdog">
<h1>Watchdog<a class="headerlink" href="#watchdog" title="Permalink to this heading">¶</a></h1>
<p>Python API library and shell utilities to monitor file system events.</p>
<p>Works on 3.6+.</p>
<p>If you want to use Python 2.6, you should stick with watchdog < 0.10.0.</p>
<p>If you want to use Python 2.7, 3.4 or 3.5, you should stick with watchdog < 1.0.0.</p>
<section id="directory-monitoring-made-easy-with">
<h2>Directory monitoring made easy with<a class="headerlink" href="#directory-monitoring-made-easy-with" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>A cross-platform API.</p></li>
<li><p>A shell tool to run commands in response to directory changes.</p></li>
</ul>
<p>Get started quickly with a simple example in <a class="reference internal" href="quickstart.html#quickstart"><span class="std std-ref">Quickstart</span></a>.</p>
</section>
<section id="easy-installation">
<h2>Easy installation<a class="headerlink" href="#easy-installation" title="Permalink to this heading">¶</a></h2>
<p>You can use <a class="reference external" href="https://pypi.python.org/pypi/pip">pip</a> to install <code class="docutils literal notranslate"><span class="pre">watchdog</span></code> quickly and easily:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m pip install -U watchdog
</pre></div>
</div>
<p>Need more help with installing? See <a class="reference internal" href="installation.html#installation"><span class="std std-ref">Installation</span></a>.</p>
</section>
</section>
<section id="user-s-guide">
<h1>User’s Guide<a class="headerlink" href="#user-s-guide" title="Permalink to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-pypi-using-pip">Installing from PyPI using pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-source-tarballs">Installing from source tarballs</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-the-code-repository">Installing from the code repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#supported-platforms-and-caveats">Supported Platforms (and Caveats)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#a-simple-example">A Simple Example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.events"><cite>watchdog.events</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.observers.api"><cite>watchdog.observers.api</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.observers"><cite>watchdog.observers</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.observers.polling"><cite>watchdog.observers.polling</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.utils"><cite>watchdog.utils</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.utils.dirsnapshot"><cite>watchdog.utils.dirsnapshot</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-watchdog.tricks"><cite>watchdog.tricks</cite></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hacking.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hacking.html#important-urls">Important URLs</a></li>
<li class="toctree-l2"><a class="reference internal" href="hacking.html#before-you-start">Before you start</a></li>
<li class="toctree-l2"><a class="reference internal" href="hacking.html#setting-up-the-work-environment">Setting up the Work Environment</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="contribute">
<h1>Contribute<a class="headerlink" href="#contribute" title="Permalink to this heading">¶</a></h1>
<p>Found a bug in or want a feature added to <code class="docutils literal notranslate"><span class="pre">watchdog</span></code>?
You can fork the official <a class="reference external" href="https://github.com/gorakhargosh/watchdog">code repository</a> or file an issue ticket
at the <a class="reference external" href="https://github.com/gorakhargosh/watchdog/issues">issue tracker</a>. You can also ask questions at the official
<a class="reference external" href="https://groups.google.com/group/watchdog-python">mailing list</a>. You may also want to refer to <a class="reference internal" href="hacking.html#hacking"><span class="std std-ref">Contributing</span></a> for information
about contributing code or documentation to <code class="docutils literal notranslate"><span class="pre">watchdog</span></code>.</p>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Watchdog</a><ul>
<li><a class="reference internal" href="#directory-monitoring-made-easy-with">Directory monitoring made easy with</a></li>
<li><a class="reference internal" href="#easy-installation">Easy installation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#user-s-guide">User’s Guide</a></li>
<li><a class="reference internal" href="#contribute">Contribute</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">watchdog 2.2.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Watchdog</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010-2023, Yesudeep Mangalapilly and contributors.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>