filecmp — Сравнение файлов и каталогов

Исходный код: Lib/filecmp.py

Модуль filecmp определяет функции для сравнения файлов и каталогов с различными вариантами компромисса между временем и точностью. Для сравнения файлов также см. модуль difflib.

Модуль filecmp определяет следующие функции:

filecmp.cmp(f1, f2, shallow=True)

Сравнивает файлы с именами f1 и f2, возвращая True, если они кажутся равными, и False в противном случае.

Если shallow имеет значение True, файлы с идентичными сигнатурами os.stat() считаются равными. В противном случае сравнивается содержимое файлов.

Обратите внимание, что из этой функции не вызываются внешние программы, что обеспечивает её переносимость и эффективность.

Эта функция использует кэш для предыдущих сравнений и результатов, при этом записи в кэше аннулируются, если информация os.stat() для файла изменяется. Весь кэш можно очистить с помощью clear_cache().

filecmp.cmpfiles(dir1, dir2, common, shallow=True)

Сравнивает файлы в двух каталогах dir1 и dir2, имена которых заданы в common.

Возвращает три списка имён файлов: match, mismatch, errors. match содержит список совпадающих файлов, mismatch содержит имена файлов, которые не совпадают, а errors содержит имена файлов, которые не удалось сравнить. Файлы перечисляются в errors, если они отсутствуют в одном из каталогов, у пользователя нет разрешения на чтение, или сравнение не удалось по какой-либо другой причине.

Параметр shallow имеет то же значение и то же значение по умолчанию, что и для filecmp.cmp().

Например, cmpfiles('a', 'b', ['c', 'd/e']) сравнит a/c с b/c и a/d/e с b/d/e. 'c' и 'd/e' будут находиться в одном из трёх возвращённых списков.

filecmp.clear_cache()

Очистить кэш filecmp. Это может быть полезно, если файл сравнивается сразу после его изменения, и это изменение находится в пределах разрешения по времени последнего изменения на уровне файловой системы.

Введено в версии 3.4.

11.5.1. Класс dircmp

class filecmp.dircmp(a, b, ignore=None, hide=None)

Создаёт новый объект сравнения каталогов для сравнения каталогов a и b. ignore — список имён для игнорирования, по умолчанию — filecmp.DEFAULT_IGNORES. hide — список имён для скрытия, по умолчанию — [os.curdir, os.pardir].

Класс dircmp сравнивает файлы путём выполнения сравнений shallow, как описано для filecmp.cmp().

Класс dircmp предоставляет следующие методы:

report()

Выводит (в sys.stdout) сравнение между a и b.

report_partial_closure()

Выводит сравнение между a и b и общими непосредственными подкаталогами.

report_full_closure()

Выводит сравнение между a и b и общими подкаталогами (рекурсивно).

Класс dircmp предоставляет ряд интересных атрибутов, которые можно использовать для получения различной информации о сравниваемых древовидных структурах каталогов.

Обратите внимание, что все атрибуты вычисляются лениво с помощью механизмов __getattr__(), поэтому нет штрафа за производительность, если используются только лёгкие для вычисления атрибуты.

left

Каталог a.

right

Каталог b.

left_list

Файлы и подкаталоги в a, отфильтрованные по hide и ignore.

right_list

Файлы и подкаталоги в b, отфильтрованные по hide и ignore.

common

Файлы и подкаталоги, присутствующие как в a, так и в b.

left_only

Файлы и подкаталоги, присутствующие только в a.

right_only

Файлы и подкаталоги, присутствующие только в b.

common_dirs

Подкаталоги, присутствующие как в a, так и в b.

common_files

Файлы, присутствующие как в a, так и в b.

common_funny

Имена, присутствующие как в a, так и в b, но с разными типами в каталогах или имена, для которых os.stat() возвращает ошибку.

same_files

Файлы, которые идентичны как в a, так и в b, используя оператор сравнения файлов класса.

diff_files

Файлы, присутствующие как в a, так и в b, но имеющие разное содержимое согласно оператору сравнения файлов класса.

funny_files

Файлы, присутствующие как в a, так и в b, но не удалось сравнить.

subdirs

Словарь, сопоставляющий имена в common_dirs с объектами dircmp.

filecmp.DEFAULT_IGNORES

Введено в версии 3.4.

Список каталогов, игнорируемых по умолчанию классом dircmp.

Вот упрощённый пример использования атрибута subdirs для рекурсивного поиска общих файлов, отличающихся в двух каталогах:

>>> from filecmp import dircmp
>>> def print_diff_files(dcmp):
...     for name in dcmp.diff_files:
...         print("diff_file %s found in %s and %s" % (name, dcmp.left,
...               dcmp.right))
...     for sub_dcmp in dcmp.subdirs.values():
...         print_diff_files(sub_dcmp)
...
>>> dcmp = dircmp('dir1', 'dir2') 
>>> print_diff_files(dcmp)