difflib.md
1> **Источник:** https://python-all.ru/3.15/library/difflib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `difflib` – Средства для вычисления различий89**Исходный код:** [Lib/difflib.py](https://python-all.ru/src/3.15/Lib/difflib.py)1011---1213Этот модуль предоставляет классы и функции для сравнения последовательностей. Он может использоваться, например, для сравнения файлов и может выдавать информацию о различиях файлов в различных форматах, включая HTML, контекстные и унифицированные различия. Для сравнения каталогов и файлов см. также модуль [`filecmp`](https://python-all.ru/3.15/library/filecmp.html#module-filecmp).1415#### `class difflib.SequenceMatcher`1617Это гибкий класс для сравнения пар последовательностей любого типа, при условии, что элементы последовательностей [хешируемы](https://python-all.ru/3.15/glossary.html#term-hashable). Базовый алгоритм предшествует и немного сложнее, чем алгоритм, опубликованный в конце 1980-х годов Рэтклиффом и Обершелпом под гиперболическим названием «gestalt pattern matching». Идея заключается в нахождении самой длинной непрерывной совпадающей подпоследовательности, не содержащей «мусорных» элементов; эти «мусорные» элементы – те, которые в некотором смысле неинтересны, например, пустые строки или пробелы. (Обработка мусора является расширением алгоритма Рэтклиффа и Обершелпа.) Та же идея затем рекурсивно применяется к частям последовательностей слева и справа от совпадающей подпоследовательности. Это не даёт минимальных последовательностей редактирования, но, как правило, даёт совпадения, которые «выглядят правильно» для человека.1819**Время выполнения:** Базовый алгоритм Рэтклиффа-Обершелпа имеет кубическое время в худшем случае и квадратичное время в ожидаемом. [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher) имеет квадратичное время для худшего случая, а поведение в ожидаемом случае сложным образом зависит от того, сколько элементов у последовательностей общих; время в лучшем случае линейно.2021**Автоматическая эвристика мусора:** [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher) поддерживает эвристику, которая автоматически помечает определённые элементы последовательности как мусор. Эвристика подсчитывает, сколько раз каждый отдельный элемент появляется в последовательности. Если дубликаты элемента (после первого) составляют более 1% последовательности и длина последовательности не менее 200 элементов, этот элемент помечается как «популярный» и считается мусором для целей сопоставления последовательностей. Эту эвристику можно отключить, установив аргумент `autojunk` в значение `False` при создании `SequenceMatcher`.2223Изменено в версии 3.2: Добавлен параметр *autojunk*.2425#### `class difflib.Differ`2627Это класс для сравнения последовательностей строк текста и создания человекочитаемых различий или дельт. Differ использует [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher) как для сравнения последовательностей строк, так и для сравнения последовательностей символов внутри похожих (близко совпадающих) строк.2829Каждая строка дельты `Differ` начинается с двухбуквенного кода:3031| Код | Значение |32| --- | --- |33| `'- '` | строка, уникальная для последовательности 1 |34| `'+ '` | строка, уникальная для последовательности 2 |35| `' '` | строка, общая для обеих последовательностей |36| `'? '` | строка, отсутствующая в каждой входной последовательности |3738Строки, начинающиеся с ‘`?`’, пытаются направить взгляд на различия внутри строк и не присутствуют ни в одной из входных последовательностей. Эти строки могут сбивать с толку, если последовательности содержат пробельные символы, такие как пробелы, табуляции или разрывы строк.3940#### `class difflib.HtmlDiff`4142Этот класс можно использовать для создания HTML-таблицы (или полного HTML-файла, содержащего таблицу), отображающей поочередное сравнение текста строка за строкой с подсветкой изменений между строками и внутри строк. Таблица может быть создана в режиме полных или контекстных различий.4344Конструктор этого класса:4546#### `__init__(tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK)`4748Инициализирует экземпляр `HtmlDiff`.4950*tabsize* – необязательный именованный аргумент для задания шага табуляции; по умолчанию равен `8`.5152*wrapcolumn* – необязательный именованный аргумент, задающий номер столбца, в котором строки разбиваются и переносятся; по умолчанию равен `None`, что означает отсутствие переноса строк.5354*linejunk* и *charjunk* – необязательные именованные аргументы, передаваемые в [`ndiff()`](https://python-all.ru/3.15/library/difflib.html#difflib.ndiff) (используется `HtmlDiff` для создания поочередного HTML-сравнения). См. документацию `ndiff()` для получения значений по умолчанию и описаний аргументов.5556Следующие методы являются открытыми:5758#### `make_file(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5, *, charset='utf-8')`5960Сравнивает *fromlines* и *tolines* (списки строк) и возвращает строку, содержащую полный HTML-файл с таблицей, отображающей построчные различия с подсветкой изменений между строками и внутри строк.6162*fromdesc* и *todesc* – необязательные именованные аргументы для задания строк заголовков столбцов исходного и целевого файлов (оба по умолчанию равны пустой строке).6364*context* и *numlines* – необязательные именованные аргументы. Установите *context* в `True`, чтобы показывать контекстные различия; в противном случае по умолчанию используется `False` для отображения полных файлов. *numlines* по умолчанию равен `5`. Когда *context* равен `True`, *numlines* управляет количеством строк контекста, окружающих подсветку различий. Когда *context* равен `False`, *numlines* управляет количеством строк, показываемых перед подсветкой различий при использовании гиперссылок «далее» (установка в ноль приведёт к тому, что гиперссылки «далее» будут размещать следующую подсветку различий в верхней части браузера без предшествующего контекста).6566> **Примечание**67>68> *fromdesc* и *todesc* интерпретируются как неэкранированный HTML и должны быть правильно экранированы при получении ввода из ненадёжных источников.6970Изменено в версии 3.5: *charset* добавлен аргумент, задаваемый только по ключевому слову. Кодировка по умолчанию HTML-документа изменилась с `'ISO-8859-1'` на `'utf-8'`.7172#### `make_table(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5)`7374Сравнивает *fromlines* и *tolines* (списки строк) и возвращает строку, которая представляет собой полную HTML-таблицу с построчным отображением различий, выделяя изменения между строками и внутри строк.7576Аргументы этого метода такие же, как у метода [`make_file()`](https://python-all.ru/3.15/library/difflib.html#difflib.HtmlDiff.make_file) .7778#### `difflib.context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')`7980Сравнивает *a* и *b* (списки строк); возвращает дельту ([генератор](https://python-all.ru/3.15/glossary.html#term-generator), порождающий строки дельты) в формате контекстного diff.8182Контекстные диффы – это компактный способ показать только изменённые строки плюс несколько строк контекста. Изменения отображаются в стиле «до/после». Количество строк контекста задаётся параметром *n*, по умолчанию – три.8384По умолчанию управляющие строки diff (те, что содержат `***` или `---`) создаются с завершающим переводом строки. Это удобно, так как входные данные, созданные с помощью [`io.IOBase.readlines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.readlines), дают diff, подходящие для использования с [`io.IOBase.writelines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.writelines), поскольку и входные, и выходные данные имеют завершающие переводы строк.8586Для входных данных, не имеющих завершающего перевода строки, установите аргумент *lineterm* равным `""`, чтобы выходные данные были полностью без символов новой строки.8788Формат контекстного diff обычно содержит заголовок с именами файлов и временем изменения. Любые или все из них могут быть заданы строками для *fromfile*, *tofile*, *fromfiledate* и *tofiledate*. Время изменения обычно указывается в формате ISO 8601. Если не указано, строки по умолчанию пусты.8990```python91>>> import sys92>>> from difflib import *93>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']94>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']95>>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py',96... tofile='after.py'))97*** before.py98--- after.py99***************100*** 1,4 ****101! bacon102! eggs103! ham104 guido105--- 1,4 ----106! python107! eggy108! hamster109 guido110```111112Смотрите [Интерфейс командной строки для difflib](https://python-all.ru/3.15/library/difflib.html#difflib-interface) для более подробного примера.113114#### `difflib.get_close_matches(word, possibilities, n=3, cutoff=0.6)`115116Возвращает список наилучших «достаточно хороших» совпадений. *word* – это последовательность, для которой требуются близкие совпадения (обычно строка), а *possibilities* – список последовательностей, с которыми нужно сопоставлять *word* (обычно список строк).117118Необязательный аргумент *n* (по умолчанию `3`) – максимальное количество близких совпадений, которые нужно вернуть; *n* должно быть больше `0`.119120Необязательный аргумент *cutoff* (по умолчанию `0.6`) – число с плавающей точкой в диапазоне \[0, 1\]. Варианты, которые набирают меньше этого порога сходства с *word*, игнорируются.121122Наилучшие (не более *n*) совпадения из возможных вариантов возвращаются в виде списка, отсортированного по мере сходства: сначала самые похожие.123124```python125>>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])126['apple', 'ape']127>>> import keyword128>>> get_close_matches('wheel', keyword.kwlist)129['while']130>>> get_close_matches('pineapple', keyword.kwlist)131[]132>>> get_close_matches('accept', keyword.kwlist)133['except']134```135136#### `difflib.ndiff(a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)`137138Сравнивает *a* и *b* (списки строк); возвращает дельту в стиле [`Differ`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ) ([генератор](https://python-all.ru/3.15/glossary.html#term-generator), порождающий строки дельты).139140Необязательные именованные параметры *linejunk* и *charjunk* – это функции фильтрации (или `None`):141142*linejunk*: функция, которая принимает один строковый аргумент и возвращает истину, если строка является мусором, и ложь в противном случае. По умолчанию – `None`. Также существует функция уровня модуля [`IS_LINE_JUNK()`](https://python-all.ru/3.15/library/difflib.html#difflib.IS_LINE_JUNK), которая отфильтровывает строки без видимых символов, за исключением не более одного символа решётки (`'#'`) – однако базовый класс [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher) выполняет динамический анализ того, какие строки настолько часто встречаются, что являются шумом, и это обычно работает лучше, чем использование этой функции.143144*charjunk*: функция, которая принимает символ (строку длиной 1) и возвращает истину, если символ является мусором, и ложь в противном случае. По умолчанию – функция уровня модуля [`IS_CHARACTER_JUNK()`](https://python-all.ru/3.15/library/difflib.html#difflib.IS_CHARACTER_JUNK), которая отфильтровывает пробельные символы (пробел или табуляция; включать сюда перевод строки – плохая идея!).145146```python147>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),148... 'ore\ntree\nemu\n'.splitlines(keepends=True))149>>> print(''.join(diff), end="")150- one151? ^152+ ore153? ^154- two155- three156? -157+ tree158+ emu159```160161#### `difflib.restore(sequence, which)`162163Возвращает одну из двух последовательностей, породивших дельту.164165По заданной *sequence*, полученной с помощью [`Differ.compare()`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ.compare) или [`ndiff()`](https://python-all.ru/3.15/library/difflib.html#difflib.ndiff), извлекает строки, относящиеся к файлу 1 или 2 (параметр *which*), удаляя префиксы строк.166167Пример:168169```python170>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),171... 'ore\ntree\nemu\n'.splitlines(keepends=True))172>>> diff = list(diff) # материализовать сгенерированную дельту в список173>>> print(''.join(restore(diff, 1)), end="")174one175two176three177>>> print(''.join(restore(diff, 2)), end="")178ore179tree180emu181```182183#### `difflib.unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n', *, color=False)`184185Сравнивает *a* и *b* (списки строк); возвращает дельту ([генератор](https://python-all.ru/3.15/glossary.html#term-generator), порождающий строки дельты) в формате unified diff.186187Унифицированный дифф – это компактный способ показать только изменённые строки плюс несколько строк контекста. Изменения отображаются встроенным стилем (вместо отдельных блоков «до/после»). Количество строк контекста задаётся параметром *n*, который по умолчанию равен трём.188189По умолчанию управляющие строки diff (те, что содержат `---`, `+++` или `@@`) создаются с завершающим переводом строки. Это удобно, так как входные данные, созданные с помощью [`io.IOBase.readlines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.readlines), дают diff, подходящие для использования с [`io.IOBase.writelines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.writelines), поскольку и входные, и выходные данные имеют завершающие переводы строк.190191Для входных данных, не имеющих завершающего перевода строки, установите аргумент *lineterm* равным `""`, чтобы выходные данные были полностью без символов новой строки.192193Установите *color* в `True` чтобы включить цветной вывод, аналогично **git diff --color**. Даже если эта опция включена, её можно [контролировать с помощью переменных окружения](https://python-all.ru/3.15/using/cmdline.html#using-on-controlling-color).194195Формат unified diff обычно содержит заголовок с именами файлов и временем изменения. Любые или все из них могут быть заданы строками для *fromfile*, *tofile*, *fromfiledate* и *tofiledate*. Время изменения обычно указывается в формате ISO 8601. Если не указано, строки по умолчанию пусты.196197```python198>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']199>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']200>>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py'))201--- before.py202+++ after.py203@@ -1,4 +1,4 @@204-bacon205-eggs206-ham207+python208+eggy209+hamster210 guido211```212213Смотрите [Интерфейс командной строки для difflib](https://python-all.ru/3.15/library/difflib.html#difflib-interface) для более подробного примера.214215Изменено в версии 3.15: Добавлен параметр *color*.216217#### `difflib.diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')`218219Сравнивает *a* и *b* (списки объектов bytes) с помощью *dfunc*; возвращает последовательность строк дельты (тоже bytes) в формате, возвращаемом *dfunc*. *dfunc* должен быть вызываемым объектом, обычно [`unified_diff()`](https://python-all.ru/3.15/library/difflib.html#difflib.unified_diff) или [`context_diff()`](https://python-all.ru/3.15/library/difflib.html#difflib.context_diff).220221Позволяет сравнивать данные с неизвестной или несовместимой кодировкой. Все входные данные, кроме *n*, должны быть объектами bytes, а не str. Работает путём без потерь преобразования всех входных данных (кроме *n*) в str и вызова `dfunc(a, b, fromfile, tofile, fromfiledate, tofiledate, n, lineterm)`. Затем вывод *dfunc* снова преобразуется в bytes, поэтому получаемые строки дельты имеют те же неизвестные или несовместимые кодировки, что и *a* и *b*.222223Добавлено в версии 3.5.224225#### `difflib.IS_LINE_JUNK(line)`226227Возвращает `True` для строк, которые можно игнорировать. Строка *line* считается игнорируемой, если *line* пуста или содержит только `'#'`, в противном случае она не игнорируется. Используется как значение по умолчанию для параметра *linejunk* в [`ndiff()`](https://python-all.ru/3.15/library/difflib.html#difflib.ndiff) в старых версиях.228229#### `difflib.IS_CHARACTER_JUNK(ch)`230231Возвращает `True` для символов, которые можно игнорировать. Символ *ch* считается игнорируемым, если *ch* является пробелом или табуляцией, в противном случае он не игнорируется. Используется как значение по умолчанию для параметра *charjunk* в [`ndiff()`](https://python-all.ru/3.15/library/difflib.html#difflib.ndiff).232233> **См. также**234>235> **[Сопоставление с образцом: гештальт-подход](https://python-all.ru/3.15/library/difflib.html)**236>237> Обсуждение аналогичного алгоритма Джона У. Рэтклиффа и Д. Э. Мецнера. Опубликовано в журнале Dr. Dobb’s Journal в июле 1988 года.238239## Объекты SequenceMatcher240241Класс [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher) имеет следующий конструктор:242243#### `class difflib.SequenceMatcher(isjunk=None, a='', b='', autojunk=True)`244245Необязательный аргумент *isjunk* должен быть `None` (значение по умолчанию) или функцией с одним аргументом, которая принимает элемент последовательности и возвращает true, если и только если элемент является «мусором» (junk) и его следует игнорировать. Передача `None` для *isjunk* эквивалентна передаче `lambda x: False`; иными словами, никакие элементы не игнорируются. Например, передайте:246247```python248lambda x: x in " \t"249```250251если строки сравниваются как последовательности символов и не требуется выравнивание по пробелам или табуляциям.252253Необязательные аргументы *a* и *b* – это последовательности для сравнения; обе по умолчанию равны пустым строкам. Элементы обеих последовательностей должны быть [хэшируемыми](https://python-all.ru/3.15/glossary.html#term-hashable) (hashable).254255Необязательный аргумент *autojunk* можно использовать для отключения автоматической эвристики мусора.256257Изменено в версии 3.2: Добавлен параметр *autojunk*.258259Объекты SequenceMatcher имеют три атрибута данных: *bjunk* – это множество элементов *b*, для которых *isjunk* равно `True`; *bpopular* – это множество не-мусорных элементов, считающихся популярными по эвристике (если она не отключена); *b2j* – это словарь, отображающий оставшиеся элементы *b* в список позиций, где они встречаются. Все три сбрасываются при каждом сбросе *b* с помощью [`set_seqs()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.set_seqs) или [`set_seq2()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.set_seq2).260261Добавлено в версии 3.2: Атрибуты *bjunk* и *bpopular*.262263Объекты `SequenceMatcher` имеют следующие методы:264265#### `set_seqs(a, b)`266267Устанавливает две последовательности для сравнения.268269`SequenceMatcher` вычисляет и кеширует подробную информацию о второй последовательности, поэтому если требуется сравнить одну последовательность с множеством других, используйте [`set_seq2()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.set_seq2) для однократной установки общей последовательности и вызывайте [`set_seq1()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.set_seq1) многократно, по одному разу для каждой из остальных последовательностей.270271#### `set_seq1(a)`272273Устанавливает первую последовательность для сравнения. Вторая последовательность для сравнения не изменяется.274275#### `set_seq2(b)`276277Устанавливает вторую последовательность для сравнения. Первая последовательность для сравнения не изменяется.278279#### `find_longest_match(alo=0, ahi=None, blo=0, bhi=None)`280281Находит самый длинный совпадающий блок в `a[alo:ahi]` и `b[blo:bhi]`.282283Если *isjunk* был опущен или равен `None`, `find_longest_match()` возвращает `(i, j, k)` такое, что `a[i:i+k]` равно `b[j:j+k]`, где `alo <= i <= i+k <= ahi` и `blo <= j <= j+k <= bhi`. Для всех `(i', j', k')`, удовлетворяющих этим условиям, дополнительные условия `k >= k'`, `i <= i'`, и если `i == i'`, `j <= j'` также выполняются. Другими словами, среди всех максимальных совпадающих блоков возвращается тот, который начинается раньше всего в *a*, а среди тех максимальных блоков, которые начинаются раньше всего в *a*, возвращается тот, который начинается раньше всего в *b*.284285```python286>>> s = SequenceMatcher(None, " abcd", "abcd abcd")287>>> s.find_longest_match(0, 5, 0, 9)288Match(a=0, b=4, size=5)289```290291Если *isjunk* был указан, сначала определяется самый длинный совпадающий блок, как описано выше, но с дополнительным ограничением: в блоке не должно быть мусорных элементов. Затем этот блок расширяется как можно дальше за счёт сопоставления (только) мусорных элементов с обеих сторон. Таким образом, результирующий блок никогда не совпадает по мусору, за исключением случаев, когда один и тот же мусор оказывается смежным с интересным совпадением.292293Вот тот же пример, что и ранее, но теперь пробелы считаются мусором. Это не позволяет `' abcd'` совпадать с `' abcd'` в хвосте второй последовательности напрямую. Вместо этого может совпасть только `'abcd'`, и он совпадает с самым левым `'abcd'` во второй последовательности:294295```python296>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")297>>> s.find_longest_match(0, 5, 0, 9)298Match(a=1, b=0, size=4)299```300301Если ни один блок не совпадает, возвращается `(alo, blo, 0)`.302303Этот метод возвращает [именованный кортеж](https://python-all.ru/3.15/glossary.html#term-named-tuple) `Match(a, b, size)`.304305Изменено в версии 3.9: Добавлены аргументы по умолчанию.306307#### `get_matching_blocks()`308309Возвращает список троек, описывающих непересекающиеся совпадающие подпоследовательности. Каждая тройка имеет вид `(i, j, n)` и означает, что `a[i:i+n] == b[j:j+n]`. Тройки монотонно возрастают по *i* и *j*.310311Последняя тройка фиктивная и имеет значение `(len(a), len(b), 0)`. Это единственная тройка с `n == 0`. Если `(i, j, n)` и `(i', j', n')` являются соседними тройками в списке, и вторая не является последней тройкой в списке, то `i+n < i'` или `j+n < j'`; другими словами, соседние тройки всегда описывают несмежные равные блоки.312313```pycon314>>> s = SequenceMatcher(None, "abxcd", "abcd")315>>> s.get_matching_blocks()316[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]317```318319#### `get_opcodes()`320321Возвращает список 5-кортежей, описывающих, как преобразовать *a* в *b*. Каждый кортеж имеет вид `(tag, i1, i2, j1, j2)`. Первый кортеж содержит `i1 == j1 == 0`, а остальные кортежи имеют *i1* равным *i2* из предыдущего кортежа, и, аналогично, *j1* равным предыдущему *j2*.322323Значения *tag* – это строки со следующим смыслом:324325| Значение | Значение |326| --- | --- |327| `'replace'` | `a[i1:i2]` должно быть заменено на `b[j1:j2]`. |328| `'delete'` | `a[i1:i2]` должно быть удалено. Обратите внимание, что `j1 == j2` в этом случае. |329| `'insert'` | `b[j1:j2]` должно быть вставлено в `a[i1:i1]`. Обратите внимание, что `i1 == i2` в этом случае. |330| `'equal'` | `a[i1:i2] == b[j1:j2]` (подпоследовательности равны). |331332Например:333334```python335>>> a = "qabxcd"336>>> b = "abycdf"337>>> s = SequenceMatcher(None, a, b)338>>> for tag, i1, i2, j1, j2 in s.get_opcodes():339... print('{:7} a[{}:{}] --> b[{}:{}] {!r:>8} --> {!r}'.format(340... tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2]))341delete a[0:1] --> b[0:0] 'q' --> ''342equal a[1:3] --> b[0:2] 'ab' --> 'ab'343replace a[3:4] --> b[2:3] 'x' --> 'y'344equal a[4:6] --> b[3:5] 'cd' --> 'cd'345insert a[6:6] --> b[5:6] '' --> 'f'346```347348#### `get_grouped_opcodes(n=3)`349350Возвращает [генератор](https://python-all.ru/3.15/glossary.html#term-generator) групп с не более чем *n* строками контекста.351352Начиная с групп, возвращаемых [`get_opcodes()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_opcodes), этот метод выделяет более мелкие кластеры изменений и удаляет промежуточные диапазоны, в которых нет изменений.353354Группы возвращаются в том же формате, что и [`get_opcodes()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_opcodes).355356#### `ratio()`357358Возвращает меру схожести последовательностей в виде числа с плавающей запятой в диапазоне \[0, 1\].359360Где T – общее количество элементов в обеих последовательностях, а M – количество совпадений, это 2.0\*M / T. Обратите внимание, что это `1.0`, если последовательности идентичны, и `0.0`, если у них нет ничего общего.361362Это дорого вычислять, если [`get_matching_blocks()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_matching_blocks) или [`get_opcodes()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_opcodes) ещё не были вызваны; в этом случае, возможно, стоит сначала попробовать [`quick_ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.quick_ratio) или [`real_quick_ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.real_quick_ratio), чтобы получить верхнюю границу.363364> **Примечание**365>366> Внимание: результат вызова `ratio()` может зависеть от порядка аргументов. Например:367>368> ```python369> >>> SequenceMatcher(None, 'tide', 'diet').ratio()370> 0.25371> >>> SequenceMatcher(None, 'diet', 'tide').ratio()372> 0.5373> ```374375#### `quick_ratio()`376377Возвращает верхнюю границу для [`ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.ratio) относительно быстро.378379#### `real_quick_ratio()`380381Возвращает верхнюю границу для [`ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.ratio) очень быстро.382383Три метода, возвращающих отношение совпадающих символов к общему количеству, могут давать разные результаты из-за разного уровня приближения, хотя [`quick_ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.quick_ratio) и [`real_quick_ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.real_quick_ratio) всегда не меньше, чем [`ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.ratio):384385```python386>>> s = SequenceMatcher(None, "abcd", "bcde")387>>> s.ratio()3880.75389>>> s.quick_ratio()3900.75391>>> s.real_quick_ratio()3921.0393```394395## Примеры SequenceMatcher396397В этом примере сравниваются две строки, при этом пробелы считаются «мусором»:398399```python400>>> s = SequenceMatcher(lambda x: x == " ",401... "private Thread currentThread;",402... "private volatile Thread currentThread;")403```404405[`ratio()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.ratio) возвращает число с плавающей запятой в \[0, 1\], измеряющее схожесть последовательностей. Эмпирически, значение `ratio()` больше 0,6 означает, что последовательности близки к совпадению:406407```python408>>> print(round(s.ratio(), 3))4090.866410```411412Если вас интересует только то, где последовательности совпадают, [`get_matching_blocks()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_matching_blocks) удобен:413414```python415>>> for block in s.get_matching_blocks():416... print("a[%d] and b[%d] match for %d elements" % block)417a[0] and b[0] match for 8 elements418a[8] and b[17] match for 21 elements419a[29] and b[38] match for 0 elements420```421422Обратите внимание, что последний кортеж, возвращаемый [`get_matching_blocks()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_matching_blocks), всегда фиктивный, `(len(a), len(b), 0)`, и это единственный случай, когда последний элемент кортежа (количество совпавших элементов) равен `0`.423424Если вы хотите узнать, как изменить первую последовательность на вторую, используйте [`get_opcodes()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.get_opcodes):425426```python427>>> for opcode in s.get_opcodes():428... print("%6s a[%d:%d] b[%d:%d]" % opcode)429 equal a[0:8] b[0:8]430insert a[8:8] b[8:17]431 equal a[8:29] b[17:38]432```433434> **См. также**435>436> - Функция [`get_close_matches()`](https://python-all.ru/3.15/library/difflib.html#difflib.get_close_matches) в этом модуле показывает, как простой код, построенный на [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher), может использоваться для полезной работы.437> - [Простой рецепт контроля версий](https://python-all.ru/3.15/library/difflib.html) для небольшого приложения, построенного с помощью [`SequenceMatcher`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher).438439## Объекты Differ440441Обратите внимание, что дельты, сгенерированные [`Differ`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ), не претендуют на то, чтобы быть **минимальными** различиями. Напротив, минимальные различия часто противоречат интуиции, поскольку они синхронизируются везде, где возможно, иногда случайно сопоставляя фрагменты, отстоящие на 100 страниц. Ограничение точек синхронизации смежными совпадениями сохраняет некоторое понятие локальности, ценой иногда более длинного diff.442443Класс [`Differ`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ) имеет следующий конструктор:444445#### `class difflib.Differ(linejunk=None, charjunk=None)`446447Необязательные именованные параметры *linejunk* и *charjunk* предназначены для функций фильтрации (или `None`):448449*linejunk*: функция, которая принимает один строковый аргумент и возвращает истину, если строка является мусорной. По умолчанию – `None`, то есть ни одна строка не считается мусорной.450451*charjunk*: функция, которая принимает один символьный аргумент (строку длиной 1) и возвращает истину, если символ является мусорным. По умолчанию – `None`, то есть ни один символ не считается мусорным.452453Эти функции фильтрации мусора ускоряют сопоставление для поиска различий и не приводят к игнорированию каких-либо различающихся строк или символов. Прочтите описание параметра *isjunk* метода [`find_longest_match()`](https://python-all.ru/3.15/library/difflib.html#difflib.SequenceMatcher.find_longest_match) для объяснения.454455Объекты [`Differ`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ) используются (генерируют дельты) через единственный метод:456457#### `compare(a, b)`458459Сравнивает две последовательности строк и генерирует дельту (последовательность строк).460461Каждая последовательность должна содержать отдельные однострочные строки, заканчивающиеся символами новой строки. Такие последовательности можно получить из метода [`readlines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.readlines) файлоподобных объектов. Сгенерированная дельта также состоит из строк, завершающихся новой строкой, готовых к печати как есть с помощью метода [`writelines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.writelines) файлоподобного объекта.462463## Пример Differ464465Этот пример сравнивает два текста. Сначала мы задаем тексты – последовательности отдельных однострочных строк, заканчивающихся символами новой строки (такие последовательности также можно получить из метода [`readlines()`](https://python-all.ru/3.15/library/io.html#io.IOBase.readlines) файлоподобных объектов):466467```python468>>> text1 = ''' 1. Beautiful is better than ugly.469... 2. Explicit is better than implicit.470... 3. Simple is better than complex.471... 4. Complex is better than complicated.472... '''.splitlines(keepends=True)473>>> len(text1)4744475>>> text1[0][-1]476'\n'477>>> text2 = ''' 1. Beautiful is better than ugly.478... 3. Simple is better than complex.479... 4. Complicated is better than complex.480... 5. Flat is better than nested.481... '''.splitlines(keepends=True)482```483484Затем мы создаем экземпляр объекта Differ:485486```python487>>> d = Differ()488```489490Обратите внимание, что при создании экземпляра объекта [`Differ`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ) можно передать функции для фильтрации «мусорных» строк и символов. Подробнее см. конструктор [`Differ()`](https://python-all.ru/3.15/library/difflib.html#difflib.Differ).491492Наконец, мы сравниваем два:493494```python495>>> result = list(d.compare(text1, text2))496```497498`result` – это список строк, поэтому давайте выведем его в удобочитаемом виде:499500```python501>>> from pprint import pprint502>>> pprint(result)503[' 1. Beautiful is better than ugly.\n',504 '- 2. Explicit is better than implicit.\n',505 '- 3. Simple is better than complex.\n',506 '+ 3. Simple is better than complex.\n',507 '? ++\n',508 '- 4. Complex is better than complicated.\n',509 '? ^ ---- ^\n',510 '+ 4. Complicated is better than complex.\n',511 '? ++++ ^ ^\n',512 '+ 5. Flat is better than nested.\n']513```514515В виде одной многострочной строки это выглядит так:516517```python518>>> import sys519>>> sys.stdout.writelines(result)520 1. Beautiful is better than ugly.521- 2. Explicit is better than implicit.522- 3. Simple is better than complex.523+ 3. Simple is better than complex.524? ++525- 4. Complex is better than complicated.526? ^ ---- ^527+ 4. Complicated is better than complex.528? ++++ ^ ^529+ 5. Flat is better than nested.530```531532## Интерфейс командной строки для difflib533534Этот пример показывает, как использовать difflib для создания утилиты, подобной `diff`.535536```python537""" Интерфейс командной строки для difflib.py, предоставляющий различия в четырёх форматах:538539* ndiff: выводит каждую строку и подсвечивает изменения между строками.540* context: подсвечивает кластеры изменений в формате «до/после».541* unified: подсвечивает кластеры изменений во встроенном формате.542* html: генерирует построчное сравнение с подсветкой изменений.543544"""545546import sys, os, difflib, argparse547import datetime as dt548549def file_mtime(path):550 t = dt.datetime.fromtimestamp(os.stat(path).st_mtime,551 dt.timezone.utc)552 return t.astimezone().isoformat()553554def main():555556 parser = argparse.ArgumentParser()557 parser.add_argument('-c', action='store_true', default=False,558 help='Produce a context format diff (default)')559 parser.add_argument('-u', action='store_true', default=False,560 help='Produce a unified format diff')561 parser.add_argument('-m', action='store_true', default=False,562 help='Produce HTML side by side diff '563 '(can use -c and -l in conjunction)')564 parser.add_argument('-n', action='store_true', default=False,565 help='Produce a ndiff format diff')566 parser.add_argument('-l', '--lines', type=int, default=3,567 help='Set number of context lines (default 3)')568 parser.add_argument('fromfile')569 parser.add_argument('tofile')570 options = parser.parse_args()571572 n = options.lines573 fromfile = options.fromfile574 tofile = options.tofile575576 fromdate = file_mtime(fromfile)577 todate = file_mtime(tofile)578 with open(fromfile) as ff:579 fromlines = ff.readlines()580 with open(tofile) as tf:581 tolines = tf.readlines()582583 if options.u:584 diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)585 elif options.n:586 diff = difflib.ndiff(fromlines, tolines)587 elif options.m:588 diff = difflib.HtmlDiff().make_file(fromlines,tolines,fromfile,tofile,context=options.c,numlines=n)589 else:590 diff = difflib.context_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)591592 sys.stdout.writelines(diff)593594if __name__ == '__main__':595 main()596```597598## Пример ndiff599600Этот пример показывает, как использовать [`difflib.ndiff()`](https://python-all.ru/3.15/library/difflib.html#difflib.ndiff).601602```python603"""ndiff [-q] file1 file2604 или605ndiff (-r1 | -r2) < ndiff_output > file1_or_file2606607Выводит в stdout понятный человеку отчёт о различиях файлов. Отмечаются как меж-608строчные, так и внутристрочные различия. Во второй форме воссоздаёт file1609(-r1) или file2 (-r2) в stdout на основе отчёта ndiff со stdin.610611В первой форме, если не указан -q ("quiet"), первые две строки612вывода – это613614-: file1615+: file2616617Каждая следующая строка начинается с двухбуквенного кода:618619 "- " строка, уникальная для file1620 "+ " строка, уникальная для file2621 " " строка, общая для обоих файлов622 "? " строка, отсутствующая в обоих входных файлах623624Строки, начинающиеся с "? ", помогают глазу заметить внутристрочные625различия; в исходных файлах таких строк нет. Эти строки могут626сбивать с толку, если исходные файлы содержат символы табуляции.627628Первый файл можно восстановить, оставив только строки, начинающиеся с629" " " или "- ", и удалив эти двухсимвольные префиксы; используйте ndiff с -r1.630631Второй файл восстанавливается аналогично, но следует оставить только " " и632""+ "; используйте ndiff с -r2; или, в Unix, второй файл можно633восстановить, пропустив вывод через634635 sed -n '/^[+ ] /s/^..//p'636"""637638__version__ = 1, 7, 0639640import difflib, sys641642def fail(msg):643 out = sys.stderr.write644 out(msg + "\n\n")645 out(__doc__)646 return 0647648# открыть файл и вернуть файловый объект; ругать и вернуть 0, если не649# удалось открыть650def fopen(fname):651 try:652 return open(fname)653 except IOError as detail:654 return fail("couldn't open " + fname + ": " + str(detail))655656# открыть два файла и выдать diff в stdout; вернуть false при проблеме657def fcompare(f1name, f2name):658 f1 = fopen(f1name)659 f2 = fopen(f2name)660 if not f1 or not f2:661 return 0662663 a = f1.readlines(); f1.close()664 b = f2.readlines(); f2.close()665 for line in difflib.ndiff(a, b):666 print(line, end=' ')667668 return 1669670# разобрать args (обычно sys.argv[1:]) и сравнить;671# вернуть false при проблеме672673def main(args):674 import getopt675 try:676 opts, args = getopt.getopt(args, "qr:")677 except getopt.error as detail:678 return fail(str(detail))679 noisy = 1680 qseen = rseen = 0681 for opt, val in opts:682 if opt == "-q":683 qseen = 1684 noisy = 0685 elif opt == "-r":686 rseen = 1687 whichfile = val688 if qseen and rseen:689 return fail("can't specify both -q and -r")690 if rseen:691 if args:692 return fail("no args allowed with -r option")693 if whichfile in ("1", "2"):694 restore(whichfile)695 return 1696 return fail("-r value must be 1 or 2")697 if len(args) != 2:698 return fail("need 2 filename args")699 f1name, f2name = args700 if noisy:701 print('-:', f1name)702 print('+:', f2name)703 return fcompare(f1name, f2name)704705# прочитать вывод ndiff со stdin и вывести file1 (which=='1') или706# file2 (which=='2') в stdout707708def restore(which):709 restored = difflib.restore(sys.stdin.readlines(), which)710 sys.stdout.writelines(restored)711712if __name__ == '__main__':713 main(sys.argv[1:])714```715