gorakhargosh/watchdog là dự án mã nguồn mở trên GitHub, viết chủ yếu bằng Python, với 7.5k sao. Python library and shell utilities to monitor filesystem events.
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Please see the help information for these commands by typing:
.. code-block:: bash
watchmedo [command] --help
About watchmedo Tricks
``watchmedo`` can read ``tricks.yaml`` files and execute tricks within them in
response to file system events. Tricks are actually event handlers that
subclass ``watchdog.tricks.Trick`` and are written by plugin authors. Trick
classes are augmented with a few additional features that regular event handlers
don't need.
An example ``tricks.yaml`` file:
.. code-block:: yaml
tricks:
- watchdog.tricks.LoggerTrick:
patterns: ["**/*.py", "**/*.js"]
- watchmedo_webtricks.GoogleClosureTrick:
patterns: ['**/*.js']
hash_names: true
mappings_format: json # json|yaml|python
mappings_module: app/javascript_mappings
suffix: .min.js
compilation_level: advanced # simple|advanced
source_directory: app/static/js/
destination_directory: app/public/js/
files:
index-page:
- app/static/js/vendor/jquery*.js
- app/static/js/base.js
- app/static/js/index-page.js
about-page:
- app/static/js/vendor/jquery*.js
- app/static/js/base.js
- app/static/js/about-page/**/*.js
The directory containing the ``tricks.yaml`` file will be monitored. Each trick
class is initialized with its corresponding keys in the ``tricks.yaml`` file as
arguments and events are fed to an instance of this class as they arrive.
Installation
------------
Install from PyPI using ``pip``:
.. code-block:: bash
$ python -m pip install -U watchdog
# or to install the watchmedo utility:
$ python -m pip install -U 'watchdog[watchmedo]'
Install from source:
.. code-block:: bash
$ python -m pip install -e .
# or to install the watchmedo utility:
$ python -m pip install -e '.[watchmedo]'
Documentation
-------------
You can browse the latest release documentation_ online.
Contribute
----------
Fork the `repository`_ on GitHub and send a pull request, or file an issue
ticket at the `issue tracker`_. For general help and questions use
`stackoverflow`_ with tag `python-watchdog`.
Create and activate your virtual environment, then::
python -m pip install tox
python -m tox [-q] [-e ENV]
If you are making a substantial change, add an entry to the "Unreleased" section
of the `changelog`_.
Supported Platforms
-------------------
* Linux 2.6 (inotify)
* macOS (FSEvents, kqueue)
* FreeBSD/BSD (kqueue)
* Windows (ReadDirectoryChangesW with I/O completion ports;
ReadDirectoryChangesW worker threads)
* OS-independent (polling the disk for directory snapshots and comparing them
periodically; slow and not recommended)
Note that when using watchdog with kqueue, you need the
number of file descriptors allowed to be opened by programs
running on your system to be increased to more than the
number of files that you will be monitoring. The easiest way
to do that is to edit your ``~/.profile`` file and add
a line similar to::
ulimit -n 1024
or::
ulimit -n unlimited
This is an inherent problem with kqueue because it uses
file descriptors to monitor files. That plus the enormous
amount of bookkeeping that watchdog needs to do in order
to monitor file descriptors just makes this a painful way
to monitor files and directories. In essence, kqueue is
not a very scalable way to monitor a deeply nested
directory of files and directories with a large number of
files.
Free threaded support
---------------------
`watchdog` has support for being built and run under free-threaded CPython. However, a full thread safety audit has not been completed, in particular this affects the `macOS FSEvents` interface.
About using watchdog with editors like Vim
------------------------------------------
Vim does not modify files unless directed to do so.
It creates backup files and then swaps them in to replace
the files you are editing on the disk. This means that
if you use Vim to edit your files, the on-modified events
for those files will not be triggered by watchdog.
You may need to configure Vim appropriately to disable
this feature.
About using watchdog with CIFS
------------------------------
When you want to watch changes in CIFS, you need to explicitly tell watchdog to
use ``PollingObserver``, that is, instead of letting watchdog decide an
appropriate observer like in the example above, do::
from watchdog.observers.polling import PollingObserver as Observer
Dependencies
------------
1. Python 3.11 or above.
2. XCode_ (only on macOS when installing from sources)
3. PyYAML_ (only for ``watchmedo``)
Applications Using Watchdog
----------------------------
* `Watchdog.app`_ — A macOS application for monitoring file changes in
selected directories. Built with the OMC engine, it provides a graphical
interface for observing directories.
The Apple-notarized app is read to use and does not require additional installations.
Licensing
---------
Watchdog is licensed under the terms of the `Apache License, version 2.0`_.
- Copyright 2018-2026 Mickaël Schoentgen & contributors
- Copyright 2014-2018 Thomas Amland & contributors
- Copyright 2012-2014 Google, Inc.
- Copyright 2011-2012 Yesudeep Mangalapilly
Project `source code`_ is available at Github. Please report bugs and file
enhancement requests at the `issue tracker`_.
Why Watchdog?
-------------
Too many people tried to do the same thing and none did what I needed Python
to do:
* pnotify_
* `unison fsmonitor`_
* fsmonitor_
* guard_
* pyinotify_
* `inotify-tools`_
* jnotify_
* treewatcher_
* `file.monitor`_
* pyfilesystem_
.. links:
.. _Yesudeep Mangalapilly: [email protected]
.. _source code: https://github.com/gorakhargosh/watchdog
.. _issue tracker: https://github.com/gorakhargosh/watchdog/issues
.. _Apache License, version 2.0: https://www.apache.org/licenses/LICENSE-2.0
.. _documentation: https://python-watchdog.readthedocs.io/en/latest/
.. _stackoverflow: https://stackoverflow.com/questions/tagged/python-watchdog
.. _repository: https://github.com/gorakhargosh/watchdog
.. _issue tracker: https://github.com/gorakhargosh/watchdog/issues
.. _changelog: https://github.com/gorakhargosh/watchdog/blob/master/changelog.rst
.. _PyYAML: https://www.pyyaml.org/
.. _XCode: https://developer.apple.com/technologies/tools/xcode.html
.. _Watchdog.app: https://github.com/abra-code/WatchdogApp
.. _pnotify: http://mark.heily.com/pnotify
.. _unison fsmonitor: https://webdav.seas.upenn.edu/viewvc/unison/trunk/src/fsmonitor.py?view=markup&pathrev=471
.. _fsmonitor: https://github.com/shaurz/fsmonitor
.. _guard: https://github.com/guard/guard
.. _pyinotify: https://github.com/seb-m/pyinotify
.. _inotify-tools: https://github.com/rvoicilas/inotify-tools
.. _jnotify: http://jnotify.sourceforge.net/
.. _treewatcher: https://github.com/jbd/treewatcher
.. _file.monitor: https://github.com/pke/file.monitor
.. _pyfilesystem: https://github.com/PyFilesystem/pyfilesystem
.. |PyPI Version| image:: https://img.shields.io/pypi/v/watchdog.svg
:target: https://pypi.python.org/pypi/watchdog/
.. |PyPI Status| image:: https://img.shields.io/pypi/status/watchdog.svg
:target: https://pypi.python.org/pypi/watchdog/
.. |PyPI Python Versions| image:: https://img.shields.io/pypi/pyversions/watchdog.svg
:target: https://pypi.python.org/pypi/watchdog/
.. |Github Build Status| image:: https://github.com/gorakhargosh/watchdog/workflows/Tests/badge.svg
:target: https://github.com/gorakhargosh/watchdog/actions?query=workflow%3ATests
.. |Documentation Status| image:: https://img.shields.io/readthedocs/python-watchdog.svg
:target: https://python-watchdog.readthedocs.io/en/latest/
.. |GitHub License| image:: https://img.shields.io/github/license/gorakhargosh/watchdog.svg
:target: https://github.com/gorakhargosh/watchdog/blob/master/LICENSE
.. |Patreon| image:: https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white
:target: https://www.patreon.com/mschoentgen
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/gorakhargosh/watchdog là nguồn chính thức.
gorakhargosh/watchdog có phải mã nguồn mở không?
Có — gorakhargosh/watchdog phát hành theo license Apache-2.0, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/gorakhargosh/watchdog.
gorakhargosh/watchdog có trang demo không?
Dự án có trang chủ ở http://packages.python.org/watchdog/. Tab "Readme" ở trang này thường có ảnh chụp và hướng dẫn bắt đầu nhanh.
gorakhargosh/watchdog dùng license gì?
gorakhargosh/watchdog phát hành theo license Apache-2.0. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
gorakhargosh/watchdog là gì?
gorakhargosh/watchdog (gorakhargosh/watchdog) là dự án Python trên GitHub. Theo mô tả gốc: Python library and shell utilities to monitor filesystem events.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về watchdog?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về watchdog.