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. Это может быть полезно, если файл сравнивается очень быстро после его изменения, что попадает в разрешение mtime подлежащей файловой системы.

Добавлена в версии 3.4.

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)