Sniffer 项目技术文档

1. 安装指南

1.1 安装 Sniffer

要安装 sniffer，请在终端中运行以下命令：

pip install sniffer

1.2 安装依赖库

根据你的操作系统，安装相应的文件系统监控库以提高性能：

• Linux: 安装 pyinotify

  pip install pyinotify
  

• Windows: 安装 pywin32

  pip install pywin32
  

• Mac OS X 10.5+: 安装 MacFSEvents

  pip install MacFSEvents
  

1.3 可选依赖库

如果你需要额外的通知支持，可以安装以下库：

• Growl 支持 (Mac OS X): 安装 gntp

  pip install gntp
  

• 原生 OS X 通知 (Mac OS X 10.9.4+): 安装 osxnotify 和 libosxnotify

  pip install osxnotify
  pip install libosxnotify
  

• LibNotify 支持 (Linux): 安装 py-notify

  pip install py-notify
  

2. 项目的使用说明

2.1 基本使用

安装完成后，在项目目录中运行以下命令：

sniffer

sniffer 会自动检测代码变化并重新运行测试。你可以使用 sniffer --help 查看所有可用选项。

2.2 传递 Nose 参数

你可以通过 -x 前缀传递 Nose 参数，例如：

sniffer -x--with-doctest

2.3 高级用法

如果你不想使用 Nose，可以在当前工作目录中创建一个 scent.py 文件，自定义 sniffer 的行为。例如：

from sniffer.api import *
import os, termstyle

pass_fg_color = termstyle.green
pass_bg_color = termstyle.bg_default
fail_fg_color = termstyle.red
fail_bg_color = termstyle.bg_default

watch_paths = ['.', 'tests/']

@file_validator
def py_files(filename):
    return filename.endswith('.py') and not os.path.basename(filename).startswith('.')

@runnable
def execute_nose(*args):
    import nose
    return nose.run(argv=list(args))

3. 项目API使用文档

3.1 API 概述

sniffer 提供了一个小型的 API，允许用户自定义文件验证和测试执行。主要 API 包括：

• file_validator: 用于定义文件验证函数，决定哪些文件变化会触发测试。
• runnable: 用于定义测试执行函数，决定如何运行测试。
• select_runnable: 用于选择特定的 runnable 函数。

3.2 示例

以下是一个使用 file_validator 和 runnable 的示例：

@file_validator
def py_files(filename):
    return filename.endswith('.py') and not os.path.basename(filename).startswith('.')

@runnable
def execute_nose(*args):
    import nose
    return nose.run(argv=list(args))

4. 项目安装方式

4.1 通过 pip 安装

最简单的安装方式是通过 pip 安装：

pip install sniffer

4.2 手动安装

你也可以从 GitHub 下载源码并手动安装：

git clone https://github.com/jeffh/sniffer.git
cd sniffer
python setup.py install

4.3 依赖库安装

根据你的操作系统，安装相应的依赖库以提高性能。

---

通过以上步骤，你应该能够顺利安装并使用 sniffer 项目。如果在使用过程中遇到问题，可以参考项目的 GitHub Wiki 或提交 Issue。