cmpy 0.2

# cmpy
[](https://pypi.python.org/pypi/cmpy/)
[](https://pypi.python.org/pypi/cmpy/)
[](https://pypi.python.org/pypi/cmpy/)

用于检测目录和文件差异的简单实用程序。

### 安装

您可以使用pip安装cmpy

```
pip install cmpy
```

### 概览

在`cmpy`中，文件和目录的比较分别由`FCompare`和`DCompare`类处理。文件
也可以使用静态方法`shallow_fcmp()`和`deep_fcmp()`进行比较。正如名称所暗示的，前者执行
浅层比较（较宽松的比较，更快，资源消耗更少），而后者执行深层比较
（严格比较，较慢，资源消耗更多）。

有关比较方法和类的更多信息，请参阅`cmpy.py`中的文档字符串。

### 使用

#### 比较文件

```python
实例化两个文件之间的文件比较对象
f = FCompare('foo/bar', 'bar/foo')

比较文件（返回True或False）
f.compare()
```

可以提供可选参数

```python
执行浅比较（默认行为）
f = FCompare('foo/bar', 'bar/foo', shallow=True)

执行深比较
f = FCompare('foo/bar', 'bar/foo', shallow=False)

更改默认缓冲区大小（用于深比较）。默认为2**10字节
f = FCompare('foo/bar', 'bar/foo', buffer_size=2**8)
```

也可以在不实例化对象的情况下比较文件

```python
浅比较
shallow_fcmp('foo/bar', 'bar/foo')

深比较
deep_fcmp('foo/bar', 'bar/foo')

指定缓冲区大小的深比较
deep_fcmp('foo/bar', 'bar/foo', 2**8)
```

#### 比较目录

```python
实例化两个目录之间的目录比较对象
d = DCompare('foo/bar/', 'bar/foo/')

比较目录（返回True或False）
d.compare()
```

可以提供可选参数

```python
执行浅比较（默认行为）
d = DCompare('foo/bar/', 'bar/foo/', shallow=True)

执行深比较
d = DCompare('foo/bar/', 'bar/foo/', shallow=False)

更改默认缓冲区大小（用于深比较）。默认为2**10字节
d = DCompare('foo/bar/', 'bar/foo/', buffer_size=2**8)

非递归地进行比较
d = DCompare('foo/bar/', 'bar/foo/', recursive=False)

递归地进行比较（默认行为）
d = DCompare('foo/bar/', 'bar/foo/', recursive=True)
```

`DCompare`类具有各种属性

```python
d = DCompare('foo/bar/', 'bar/foo/')

第一个目录中的文件名称
d.dir1_files

第一个目录中的目录名称
d.dir1_directories

第一个目录中的条目名称
d.dir1_contents

第二个目录中的文件名称
d.dir2_files

第二个目录中的目录名称
d.dir2_directories

第二个目录中的条目名称
d.dir2_contents

第一个目录中不在第二个目录中的条目名称
d.dir1_unique

第二个目录中不在第一个目录中的条目名称
d.dir2_unique

两个目录中都找到的条目名称
d.common
```