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.

Объекты dircmp

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

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

Класс dircmp сравнивает файлы, выполняя поверхностные сравнения, как описано для 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)