Python 常用函数之diff

引言

在编程过程中，我们经常需要比较两个对象之间的差异。Python 提供了一些常用的函数和库来进行比较和查找差异的操作，其中一个重要的函数就是diff。本文将详细介绍diff函数及其相关功能。

什么是diff

Diff，全称为 Difference，是一个用于比较文本文件或目录以找出差异的工具。它能够比较两个文件或目录之间的差异，并以易读的方式展示出来。在编程领域，diff 也可以用于比较代码的差异，是代码版本控制中常用的一种工具。

Python 中的diff函数

在 Python 中，diff 函数可以通过使用第三方库 difflib 来实现。difflib 提供了多个函数来计算差异，其中最常用的函数就是 Differ 类的 compare 方法。

difflib.Differ.compare方法

compare 方法用于比较两个字符串或序列之间的差异并返回差异结果。它的定义如下：

def compare(self, a, b):
    """
    Compare two sequences of lines; generate the resulting delta.

    Each sequence must contain individual single-line strings ending with
    newlines. Such sequences can be obtained from the `readlines()` method
    of file-like objects. The delta generated also consists of newline-terminated strings, ready to be printed as-is via the `writelines()` method of a file-like object.

    Example:

    >>> for line in Differ().compare('one\ntwo\nthree\n'.splitlines(keepends=True),
    ...                              'ore\ntree\nemu\n'.splitlines(keepends=True)):
    ...     sys.stdout.write(line)
    - one
    ?  ^
    + ore
    ?  ^
    - two
    - three
    ?  -
    + tree
    + emu
    """
    pass

compare 方法返回一个生成器对象，通过迭代生成差异结果中的每一行。这些差异结果以易读的格式显示，其中以-表示被删除的行，以+表示被添加的行。

以下是一个示例代码，演示如何使用 compare 方法：

import difflib

text1 = '''hello
world
goodbye'''
text2 = '''hello
python
goodbye'''

d = difflib.Differ()
diff = d.compare(text1.splitlines(keepends=True), text2.splitlines(keepends=True))

for line in diff:
    print(line)

输出结果：

  hello
- world
?    -
+ python
  goodbye

在上面的示例中，我们首先定义了两个字符串 text1 和 text2，然后使用 splitlines(keepends=True) 将其分割为带换行符的行列表。接下来，我们创建了一个 Differ 对象 d，并通过 d.compare 方法比较 text1 和 text2 的差异。最后，我们通过迭代差异结果并打印每一行来展示差异。

比较文件差异

除了比较字符串差异，difflib 还可以用于比较文件之间的差异。Differ 类的 compare 方法可以接受文件对象作为输入参数，如下所示：

def compare(self, a, b):
    """
    Compare two sequences of lines; generate the resulting delta.

    Each sequence must contain individual single-line strings ending with
    newlines. Such sequences can be obtained from the `readlines()` method
    of file-like objects. The delta generated also consists of newline-terminated strings, ready to be printed as-is via the `writelines()` method of a file-like object.

    ...
    """
    pass

以下是一个示例代码，演示如何比较两个文件之间的差异：

import difflib

file1 = 'file1.txt'
file2 = 'file2.txt'

d = difflib.Differ()

with open(file1) as f1, open(file2) as f2:
    diff = d.compare(f1.readlines(), f2.readlines())

    for line in diff:
        print(line)

在上面的示例中，我们首先定义了两个文件名 file1 和 file2。然后，我们使用 open 函数打开这两个文件，并通过 f1.readlines() 和 f2.readlines() 函数获取每个文件的行列表。接下来，我们创建了一个 Differ 对象 d，并使用 d.compare 方法比较 file1 和 file2 之间的差异。最后，我们通过迭代差异结果并打印每一行来展示差异。

比较目录差异

除了比较文件差异，difflib 还可以用于比较目录之间的差异。Differ 类的 compare 方法同样也可以接受目录对象作为输入参数，其定义如下：

def compare(self, a, b):
    """
    Compare two sequences of lines; generate the resulting delta.

    Each sequence must contain individual single-line strings ending with
    newlines. Such sequences can be obtained from the `readlines()` method
    of file-like objects. The delta generated also consists of newline-terminated strings, ready to be printed as-is via the `writelines()` method of a file-like object.

    ...
    """
    pass

以下是一个示例代码，演示如何比较两个目录之间的差异：

import difflib

dir1 = '/path/to/dir1'
dir2 = '/path/to/dir2'

d = difflib.Differ()

diff = d.compare(os.listdir(dir1), os.listdir(dir2))

for line in diff:
    print(line)

在上面的示例中，我们首先定义了两个目录路径 dir1 和 dir2。然后，我们使用 os.listdir 函数获取这两个目录中的文件列表，并通过 difflib.Differ 创建了一个 Differ 对象 d。接下来，我们使用 d.compare 方法比较 dir1 和 dir2 之间的差异。最后，我们通过迭代差异结果并打印每一行来展示差异。