pydica-watchdog 0.6.2

API使用示例

一个简单的程序，使用watchdog监控作为命令行参数指定的目录，并记录生成的事件

import sys
import time
import logging
from watchdog.observers import Observer
from watchdog.events import LoggingEventHandler

if __name__ == "__main__":
    logging.basicConfig(level=logging.INFO,
                        format='%(asctime)s - %(message)s',
                        datefmt='%Y-%m-%d %H:%M:%S')
    path = sys.argv[1] if len(sys.argv) > 1 else '.'
    event_handler = LoggingEventHandler()
    observer = Observer()
    observer.schedule(event_handler, path, recursive=True)
    observer.start()
    try:
        while True:
            time.sleep(1)
    except KeyboardInterrupt:
        observer.stop()
    observer.join()

Shell实用工具

Watchdog附带了一个名为watchmedo的实用脚本。请在shell提示符下输入watchmedo --help以了解更多关于此工具的信息。

以下是如何递归地记录当前目录的事件，这些事件仅与*.py和*.txt文件相关，同时忽略所有目录事件

watchmedo log \
    --patterns="*.py;*.txt" \
    --ignore-directories \
    --recursive \
    .

您可以使用shell-command子命令在响应事件时执行shell命令

watchmedo shell-command \
    --patterns="*.py;*.txt" \
    --recursive \
    --command='echo "${watch_src_path}"' \
    .

请通过输入来查看这些命令的帮助信息

watchmedo [command] --help

watchmount shell-command \
    --patterns="*.py;*.txt" \
    --recursive \
    --command='echo "${watch_src_path}"' \
    .

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

安装

使用 pip 从 PyPI 安装

pip install watchdog

使用 easy_install 从 PyPI 安装

easy_install watchdog

从源代码安装

python setup.py install

brew install libyaml

sudo aptitude install libyaml-dev

文档

您可以在网上浏览最新版本的 文档。

支持的平台

• Linux 2.6 (inotify)

• Mac OS X (FSEvents, kqueue)

• FreeBSD/BSD (kqueue)

• Windows (ReadDirectoryChangesW 与 I/O 完成端口；ReadDirectoryChangesW 工作线程)

• 与操作系统无关（轮询磁盘以获取目录快照并定期比较；速度慢，不推荐使用）

请注意，当使用 watchdog 与 kqueue 一起时，您需要将系统上运行的程序允许打开的文件描述符数量增加到要监控的文件数量以上。最简单的方法是编辑您的 ~/.profile 文件并添加类似以下的一行

ulimit -n 1024

这是 kqueue 的固有问题，因为它使用文件描述符来监控文件。再加上 watchdog 需要执行的大量账本工作，以便监控文件描述符，这使监控文件和目录变得非常痛苦。本质上，kqueue 不是监控大量文件和目录的深层嵌套目录的好方法。

关于使用 watchdog 与 Vim 等编辑器一起使用的问题

vim在未明确指示的情况下不会修改文件。它会创建备份文件，然后将其交换以替换磁盘上正在编辑的文件。这意味着如果您使用vim编辑文件，这些文件的修改事件不会被watchdog触发。您可能需要适当配置vim来禁用此功能。

依赖项

1. Python 2.5或更高版本。

2. pathtools

3. select_backport（Python2.5/2.6在BSD/Mac OS X上的kqueue替代品）

4. XCode（仅在Mac OS X上）

5. PyYAML（仅用于watchmedo脚本）

6. argh（仅用于watchmedo脚本）

许可

Watchdog根据Apache License，版本2.0条款授权。

版权所有2011 Yesudeep Mangalapilly。

版权所有2012 Google，Inc。

项目源代码可在GitHub上获得。源代码。请在问题跟踪器中报告错误并提交增强请求。

为什么选择Watchdog？

太多人试图做同样的事情，但没有一个人能做我想让Python做的事情

• pnotify

• unison fsmonitor

• fsmonitor

• guard

• pyinotify

• inotify-tools

• jnotify

• treewalker

• file.monitor

• pyfilesystem