wxwatcher 1.8.0

A file change monitor that pushes notifications via WeChat

wxwatcher

文件变更监控工具：检测到变化时，通过微信推送通知。

特性

• 两阶段扫描：先 stat 快速检测，仅对疑似变化文件计算 SHA256
• 自动忽略 .git、__pycache__、.venv 等常见目录
• 支持按扩展名过滤、自定义忽略规则
• 分批推送，避免消息过长
• CLI 参数 / 环境变量 / 配置文件 / 默认值四层配置
• 忽略规则支持通配符（*.log）和正则（regex:\.tmp\d+$）
• 日志自动写入 ~/.wxwatcher/file_watcher.log

安装

pip install wxwatcher

如需使用 YAML 配置文件：

pip install wxwatcher[config]

快速开始

监控当前目录

wxwatcher

监控指定目录

wxwatcher /path/to/watch

查看帮助

$ wxwatcher --help
usage: wxwatcher [-h] [-v] [-i INTERVAL] [--push-url PUSH_URL]
                 [--to-user TO_USER] [--max-batch MAX_BATCH]
                 [--ext EXT] [--ignore IGNORE] [--log-file LOG_FILE]
                 [--verbose] [--quiet] [--knowly-url KNOWLY_URL]
                 [--no-knowly] [--config CONFIG] [--no-config]
                 [dir]

文件变更监控工具，检测到变化时通过微信推送通知

positional arguments:
  dir                   监控目录（默认当前目录）

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -i INTERVAL, --interval INTERVAL
                        轮询间隔（秒，默认 30）
  --push-url PUSH_URL   推送 API 地址
  --to-user TO_USER     接收人（默认 @all）
  --max-batch MAX_BATCH
                        单批最大变更数（默认 50）
  --ext EXT             仅监控指定扩展名（逗号分隔，如 py,md）
  --ignore IGNORE       忽略的目录/文件名（逗号分隔，如 dist,build）
  --log-file LOG_FILE   日志文件路径
  --verbose             输出 DEBUG 级别日志
  --quiet               仅输出 WARNING 及以上
  --knowly-url KNOWLY_URL
                        Knowly 上传 API 地址
  --no-knowly           禁用上传到 Knowly
  --config CONFIG       配置文件路径（默认自动搜索）
  --no-config           跳过配置文件加载

配置

优先级：CLI 参数 > 环境变量 > 配置文件 > 默认值

YAML 配置文件

搜索顺序：

1. 当前目录及父目录中的 .wxwatcher.yml 或 wxwatcher.yml
2. ~/.wxwatcher/config.yml
3. ~/.config/wxwatcher/config.yml

使用 --config <path> 指定具体文件，或 --no-config 跳过配置文件加载。

示例 .wxwatcher.yml：

push_url: "https://api.example.com/push"
poll_interval: 15
to_user: "@all"
ignore:
  - "*.log"
  - "regex:\\.tmp\\d+$"
  - dist
  - build
ext:
  - py
  - md
log_file: "~/.wxwatcher/wxwatcher.log"

环境变量

环境变量	说明	默认值
WXWATCHER_DIR	监控目录	当前目录
WXWATCHER_INTERVAL	轮询间隔（秒）	30
WXWATCHER_PUSH_URL	推送 API 地址	必须配置
WXWATCHER_TO_USER	接收人	@all
WXWATCHER_MAX_BATCH	单批最大变更数	50
WXWATCHER_LOG_FILE	日志文件路径	~/.wxwatcher/file_watcher.log
WXWATCHER_IGNORE	额外忽略模式（逗号分隔）	无
WXWATCHER_EXT	仅监控扩展名（逗号分隔）	全部

忽略规则

--ignore 和环境变量 WXWATCHER_IGNORE 支持三种模式：

类型	示例	说明
精确匹配	.git, node_modules	文件名或路径段完全匹配
通配符	*.log, ~*, tmp_*_backup	含 *?[] 自动识别为 fnmatch
正则	regex:\.tmp\d+$	以 regex: 前缀，匹配文件名或完整路径

也可通过 CLI 参数控制（优先级高于环境变量）：

参数	说明
--ignore	忽略的目录/文件名（逗号分隔，如 dist,build）
--verbose	输出 DEBUG 级别日志
--quiet	仅输出 WARNING 及以上

示例

export WXWATCHER_DIR=/data
export WXWATCHER_INTERVAL=10
export WXWATCHER_PUSH_URL=https://api.example.com/push
export WXWATCHER_IGNORE="node_modules,.idea"
wxwatcher

只监控特定文件类型：

export WXWATCHER_EXT="py,txt,md"
wxwatcher

systemd 服务

将 wxwatcher.service 复制到 systemd 目录：

sudo cp wxwatcher.service /etc/systemd/system/

配置环境变量（推送地址等）：

sudo mkdir -p /etc/wxwatcher
echo 'WXWATCHER_PUSH_URL=https://...' | sudo tee /etc/wxwatcher/environment

也可将 YAML 配置文件放在 ~/.wxwatcher/config.yml，服务启动时会自动加载。

启用并启动：

sudo systemctl daemon-reload
sudo systemctl enable --now wxwatcher
sudo journalctl -u wxwatcher -f

工作原理

每轮轮询（默认 30s）
  │
  ├─ fast_scan()          # os.walk + os.stat，不读文件内容
  │
  ├─ 对比 mtime / size    # 快速筛选疑似变化文件
  │
  ├─ sha256_file()        # 仅对疑似文件计算 hash，确认内容真正改变
  │
  └─ send_wechat()        # 分批推送到微信

大目录下性能表现良好：5000+ 文件的目录，每轮仅需毫秒级扫描，变化文件少时几乎零磁盘 IO。

推送消息示例

文件监控已启动
──────────
监控目录: project
文件数量: 1203
启动时间: 02:30:00
──────────
By: 苑广山的文件监控助手

文件变更  02:35:00
──────────
1. [新增] config.py (+2.1KB)
2. [修改] README.md (+120B)
3. [删除] old_file.txt
──────────
By: 苑广山的文件监控助手

开发

git clone https://github.com/yuanguangshan/wxwatcher.git
cd wxwatcher
pip install -e ".[dev]"
pytest

构建发行包：

python -m build

常见问题

Q: 需要安装 inotify 吗？
A: 不需要。wxwatcher 使用轮询方式，跨平台兼容，无需系统级通知服务。

Q: 可以推送其他消息平台吗？
A: 当前仅支持微信推送接口。可以通过 --push-url 指定兼容该接口的其他服务。

Q: 大量文件时会不会很卡？
A: 不会。采用两阶段扫描，每轮只读元数据，仅疑似变化文件才计算 hash。

Q: 如何停止监控？
A: Ctrl+C 即可安全退出，程序会打印退出日志。

依赖

• Python >= 3.9
• httpx
• pyyaml（可选，仅在使用 YAML 配置文件时需要）

License

MIT