difflib.md
1> **Источник:** https://python-all.ru/3.7/library/difflib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`difflib`](https://python-all.ru/3.7/library/difflib.html#module-difflib) – Средства для вычисления различий89**Исходный код:** [Lib/difflib.py](https://python-all.ru/src/3.7/Lib/difflib.py)1011---1213Этот модуль предоставляет классы и функции для сравнения последовательностей. Его можно использовать, например, для сравнения файлов, и он может создавать информацию о различиях в различных форматах, включая HTML, контекстные и объединённые различия. Для сравнения каталогов и файлов см. также модуль [`filecmp`](https://python-all.ru/3.7/library/filecmp.html#module-filecmp).1415#### `class difflib.SequenceMatcher`1617Это гибкий класс для сравнения пар последовательностей любого типа, при условии, что элементы последовательностей [хешируемы](https://python-all.ru/3.7/glossary.html#term-hashable). Базовый алгоритм предшествует и немного сложнее, чем алгоритм, опубликованный в конце 1980-х годов Рэтклиффом и Обершелпом под гиперболическим названием «gestalt pattern matching». Идея заключается в нахождении самой длинной непрерывной совпадающей подпоследовательности, не содержащей «мусорных» элементов; эти «мусорные» элементы – те, которые в некотором смысле неинтересны, например, пустые строки или пробелы. (Обработка мусора является расширением алгоритма Рэтклиффа и Обершелпа.) Та же идея затем рекурсивно применяется к частям последовательностей слева и справа от совпадающей подпоследовательности. Это не даёт минимальных последовательностей редактирования, но, как правило, даёт совпадения, которые «выглядят правильно» для человека.1819**Время выполнения:** Базовый алгоритм Рэтклиффа-Обершелпа имеет кубическое время в худшем случае и квадратичное время в ожидаемом. [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) имеет квадратичное время для худшего случая, а поведение в ожидаемом случае сложным образом зависит от того, сколько элементов у последовательностей общих; время в лучшем случае линейно.2021**Автоматическая эвристика мусора:** [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) поддерживает эвристику, которая автоматически помечает определённые элементы последовательности как мусор. Эвристика подсчитывает, сколько раз каждый отдельный элемент появляется в последовательности. Если дубликаты элемента (после первого) составляют более 1% последовательности и длина последовательности не менее 200 элементов, этот элемент помечается как «популярный» и считается мусором для целей сопоставления последовательностей. Эту эвристику можно отключить, установив аргумент `autojunk` в значение `False` при создании [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher).2223Новое в версии 3.2: Параметр *autojunk*.2425#### `class difflib.Differ`2627Это класс для сравнения последовательностей строк текста и создания человекочитаемых различий или дельт. Differ использует [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) как для сравнения последовательностей строк, так и для сравнения последовательностей символов внутри похожих (близко совпадающих) строк.2829Каждая строка дельты [`Differ`](https://python-all.ru/3.7/library/difflib.html#difflib.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`](https://python-all.ru/3.7/library/difflib.html#difflib.HtmlDiff).4950*tabsize* – необязательный именованный аргумент для задания шага табуляции; по умолчанию равен `8`.5152*wrapcolumn* – необязательный именованный аргумент, задающий номер столбца, в котором строки разбиваются и переносятся; по умолчанию равен `None`, что означает отсутствие переноса строк.5354*linejunk* и *charjunk* – необязательные именованные аргументы, передаваемые в [`ndiff()`](https://python-all.ru/3.7/library/difflib.html#difflib.ndiff) (используется [`HtmlDiff`](https://python-all.ru/3.7/library/difflib.html#difflib.HtmlDiff) для создания поочередного HTML-сравнения). См. документацию [`ndiff()`](https://python-all.ru/3.7/library/difflib.html#difflib.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Изменено в версии 3.5: *charset* добавлен аргумент, задаваемый только по ключевому слову. Кодировка по умолчанию HTML-документа изменилась с `'ISO-8859-1'` на `'utf-8'`.6768#### `make_table(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5)`6970Сравнивает *fromlines* и *tolines* (списки строк) и возвращает строку, которая представляет собой полную HTML-таблицу с построчным отображением различий, выделяя изменения между строками и внутри строк.7172Аргументы этого метода такие же, как у метода [`make_file()`](https://python-all.ru/3.7/library/difflib.html#difflib.HtmlDiff.make_file) .7374`Tools/scripts/diff.py` – это интерфейс командной строки для данного класса и содержит хороший пример его использования.7576#### `difflib.context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')`7778Сравнивает *a* и *b* (списки строк); возвращает дельту ([генератор](https://python-all.ru/3.7/glossary.html#term-generator), порождающий строки дельты) в формате контекстного diff.7980Контекстные диффы – это компактный способ показать только изменённые строки плюс несколько строк контекста. Изменения отображаются в стиле «до/после». Количество строк контекста задаётся параметром *n*, по умолчанию – три.8182По умолчанию управляющие строки diff (те, что содержат `***` или `---`) создаются с завершающим переводом строки. Это удобно, так как входные данные, созданные с помощью [`io.IOBase.readlines()`](https://python-all.ru/3.7/library/io.html#io.IOBase.readlines), дают diff, подходящие для использования с [`io.IOBase.writelines()`](https://python-all.ru/3.7/library/io.html#io.IOBase.writelines), поскольку и входные, и выходные данные имеют завершающие переводы строк.8384Для входных данных, не имеющих завершающего перевода строки, установите аргумент *lineterm* равным `""`, чтобы выходные данные были полностью без символов новой строки.8586Формат контекстного diff обычно содержит заголовок с именами файлов и временем изменения. Любые или все из них могут быть заданы строками для *fromfile*, *tofile*, *fromfiledate* и *tofiledate*. Время изменения обычно указывается в формате ISO 8601. Если не указано, строки по умолчанию пусты.8788```python89>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']90>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']91>>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py', tofile='after.py'))92*** before.py93--- after.py94***************95*** 1,4 ****96! bacon97! eggs98! ham99 guido100--- 1,4 ----101! python102! eggy103! hamster104 guido105```106107Смотрите [Интерфейс командной строки для difflib](https://python-all.ru/3.7/library/difflib.html#difflib-interface) для более подробного примера.108109#### `difflib.get_close_matches(word, possibilities, n=3, cutoff=0.6)`110111Возвращает список наилучших «достаточно хороших» совпадений. *word* – это последовательность, для которой требуются близкие совпадения (обычно строка), а *possibilities* – список последовательностей, с которыми нужно сопоставлять *word* (обычно список строк).112113Необязательный аргумент *n* (по умолчанию `3`) – максимальное количество близких совпадений, которые нужно вернуть; *n* должно быть больше `0`.114115Необязательный аргумент *cutoff* (по умолчанию `0.6`) – число с плавающей точкой в диапазоне \[0, 1\]. Варианты, которые набирают меньше этого порога сходства с *word*, игнорируются.116117Наилучшие (не более *n*) совпадения из возможных вариантов возвращаются в виде списка, отсортированного по мере сходства: сначала самые похожие.118119```python120>>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])121['apple', 'ape']122>>> import keyword123>>> get_close_matches('wheel', keyword.kwlist)124['while']125>>> get_close_matches('pineapple', keyword.kwlist)126[]127>>> get_close_matches('accept', keyword.kwlist)128['except']129```130131#### `difflib.ndiff(a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)`132133Сравнивает *a* и *b* (списки строк); возвращает дельту в стиле [`Differ`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ) ([генератор](https://python-all.ru/3.7/glossary.html#term-generator), порождающий строки дельты).134135Необязательные именованные параметры *linejunk* и *charjunk* – это функции фильтрации (или `None`):136137*linejunk*: функция, которая принимает один строковый аргумент и возвращает true, если строка является мусором, или false в противном случае. Значение по умолчанию – `None`. Также существует функция уровня модуля [`IS_LINE_JUNK()`](https://python-all.ru/3.7/library/difflib.html#difflib.IS_LINE_JUNK), которая отфильтровывает строки без видимых символов, за исключением не более одного символа решётки (`'#'`). Однако базовый класс [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) выполняет динамический анализ того, какие строки встречаются настолько часто, что создают шум, и это обычно работает лучше, чем использование этой функции.138139*charjunk*: функция, которая принимает символ (строку длиной 1) и возвращает истину, если символ является мусором, и ложь в противном случае. По умолчанию – функция уровня модуля [`IS_CHARACTER_JUNK()`](https://python-all.ru/3.7/library/difflib.html#difflib.IS_CHARACTER_JUNK), которая отфильтровывает пробельные символы (пробел или табуляция; включать сюда перевод строки – плохая идея!).140141`Tools/scripts/ndiff.py` – это интерфейс командной строки для этой функции.142143```python144>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),145... 'ore\ntree\nemu\n'.splitlines(keepends=True))146>>> print(''.join(diff), end="")147- one148? ^149+ ore150? ^151- two152- three153? -154+ tree155+ emu156```157158#### `difflib.restore(sequence, which)`159160Возвращает одну из двух последовательностей, породивших дельту.161162По заданной *sequence*, полученной с помощью [`Differ.compare()`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ.compare) или [`ndiff()`](https://python-all.ru/3.7/library/difflib.html#difflib.ndiff), извлекает строки, относящиеся к файлу 1 или 2 (параметр *which*), удаляя префиксы строк.163164Пример:165166```python167>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),168... 'ore\ntree\nemu\n'.splitlines(keepends=True))169>>> diff = list(diff) # материализовать сгенерированную дельту в список170>>> print(''.join(restore(diff, 1)), end="")171one172two173three174>>> print(''.join(restore(diff, 2)), end="")175ore176tree177emu178```179180#### `difflib.unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')`181182Сравнивает *a* и *b* (списки строк); возвращает дельту ([генератор](https://python-all.ru/3.7/glossary.html#term-generator), порождающий строки дельты) в формате unified diff.183184Унифицированный дифф – это компактный способ показать только изменённые строки плюс несколько строк контекста. Изменения отображаются встроенным стилем (вместо отдельных блоков «до/после»). Количество строк контекста задаётся параметром *n*, который по умолчанию равен трём.185186По умолчанию управляющие строки diff (те, что содержат `---`, `+++` или `@@`) создаются с завершающим переводом строки. Это удобно, так как входные данные, созданные с помощью [`io.IOBase.readlines()`](https://python-all.ru/3.7/library/io.html#io.IOBase.readlines), дают diff, подходящие для использования с [`io.IOBase.writelines()`](https://python-all.ru/3.7/library/io.html#io.IOBase.writelines), поскольку и входные, и выходные данные имеют завершающие переводы строк.187188Для входных данных, не имеющих завершающего перевода строки, установите аргумент *lineterm* равным `""`, чтобы выходные данные были полностью без символов новой строки.189190Формат контекстного diff обычно содержит заголовок с именами файлов и временем изменения. Любые или все из них могут быть заданы строками для *fromfile*, *tofile*, *fromfiledate* и *tofiledate*. Время изменения обычно указывается в формате ISO 8601. Если не указано, строки по умолчанию пусты.191192```python193>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']194>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']195>>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py'))196--- before.py197+++ after.py198@@ -1,4 +1,4 @@199-bacon200-eggs201-ham202+python203+eggy204+hamster205 guido206```207208Смотрите [Интерфейс командной строки для difflib](https://python-all.ru/3.7/library/difflib.html#difflib-interface) для более подробного примера.209210#### `difflib.diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')`211212Сравнивает *a* и *b* (списки объектов bytes) с помощью *dfunc*; возвращает последовательность строк дельты (тоже bytes) в формате, возвращаемом *dfunc*. *dfunc* должен быть вызываемым объектом, обычно [`unified_diff()`](https://python-all.ru/3.7/library/difflib.html#difflib.unified_diff) или [`context_diff()`](https://python-all.ru/3.7/library/difflib.html#difflib.context_diff).213214Позволяет сравнивать данные с неизвестной или несовместимой кодировкой. Все входные данные, кроме *n*, должны быть объектами bytes, а не str. Работает путём без потерь преобразования всех входных данных (кроме *n*) в str и вызова `dfunc(a, b, fromfile, tofile, fromfiledate, tofiledate, n, lineterm)`. Затем вывод *dfunc* снова преобразуется в bytes, поэтому получаемые строки дельты имеют те же неизвестные или несовместимые кодировки, что и *a* и *b*.215216Новое в версии 3.5.217218#### `difflib.IS_LINE_JUNK(line)`219220Возвращает `True` для строк, которые можно игнорировать. Строка *line* считается игнорируемой, если *line* пуста или содержит только `'#'`, в противном случае она не игнорируется. Используется как значение по умолчанию для параметра *linejunk* в [`ndiff()`](https://python-all.ru/3.7/library/difflib.html#difflib.ndiff) в старых версиях.221222#### `difflib.IS_CHARACTER_JUNK(ch)`223224Возвращает `True` для символов, которые можно игнорировать. Символ *ch* считается игнорируемым, если *ch* является пробелом или табуляцией, в противном случае он не игнорируется. Используется как значение по умолчанию для параметра *charjunk* в [`ndiff()`](https://python-all.ru/3.7/library/difflib.html#difflib.ndiff).225226> **См. также**227>228> **[Сопоставление с образцом: гештальт-подход](https://python-all.ru/3.7/library/difflib.html)**229>230> Обсуждение похожего алгоритма Джона У. Рэтклиффа и Д. Э. Мецнера. Оно было опубликовано в [Dr. Dobb’s Journal](https://python-all.ru/3.7/library/difflib.html) в июле 1988 года.231232## Объекты SequenceMatcher233234Класс [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) имеет следующий конструктор:235236#### `class difflib.SequenceMatcher(isjunk=None, a='', b='', autojunk=True)`237238Необязательный аргумент *isjunk* должен быть `None` (значение по умолчанию) или функцией с одним аргументом, которая принимает элемент последовательности и возвращает true, если и только если элемент является «мусором» (junk) и его следует игнорировать. Передача `None` для *isjunk* эквивалентна передаче `lambda x: False`; иными словами, никакие элементы не игнорируются. Например, передайте:239240```python241lambda x: x in " \t"242```243244если строки сравниваются как последовательности символов и не требуется выравнивание по пробелам или табуляциям.245246Необязательные аргументы *a* и *b* – это последовательности для сравнения; обе по умолчанию равны пустым строкам. Элементы обеих последовательностей должны быть [хэшируемыми](https://python-all.ru/3.7/glossary.html#term-hashable) (hashable).247248Необязательный аргумент *autojunk* можно использовать для отключения автоматической эвристики мусора.249250Новое в версии 3.2: Параметр *autojunk*.251252Объекты SequenceMatcher имеют три атрибута данных: *bjunk* – это множество элементов *b*, для которых *isjunk* равно `True`; *bpopular* – это множество не-мусорных элементов, считающихся популярными по эвристике (если она не отключена); *b2j* – это словарь, отображающий оставшиеся элементы *b* в список позиций, где они встречаются. Все три сбрасываются при каждом сбросе *b* с помощью [`set_seqs()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.set_seqs) или [`set_seq2()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.set_seq2).253254Новое в версии 3.2: Атрибуты *bjunk* и *bpopular*.255256Объекты [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) имеют следующие методы:257258#### `set_seqs(a, b)`259260Устанавливает две последовательности для сравнения.261262[`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher) вычисляет и кеширует подробную информацию о второй последовательности, поэтому если требуется сравнить одну последовательность с множеством других, используйте [`set_seq2()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.set_seq2) для однократной установки общей последовательности и вызывайте [`set_seq1()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.set_seq1) многократно, по одному разу для каждой из остальных последовательностей.263264#### `set_seq1(a)`265266Устанавливает первую последовательность для сравнения. Вторая последовательность для сравнения не изменяется.267268#### `set_seq2(b)`269270Устанавливает вторую последовательность для сравнения. Первая последовательность для сравнения не изменяется.271272#### `find_longest_match(alo, ahi, blo, bhi)`273274Находит самый длинный совпадающий блок в `a[alo:ahi]` и `b[blo:bhi]`.275276Если *isjunk* был опущен или равен `None`, [`find_longest_match()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.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*.277278```python279>>> s = SequenceMatcher(None, " abcd", "abcd abcd")280>>> s.find_longest_match(0, 5, 0, 9)281Match(a=0, b=4, size=5)282```283284Если *isjunk* был указан, сначала определяется самый длинный совпадающий блок, как описано выше, но с дополнительным ограничением: в блоке не должно быть мусорных элементов. Затем этот блок расширяется как можно дальше за счёт сопоставления (только) мусорных элементов с обеих сторон. Таким образом, результирующий блок никогда не совпадает по мусору, за исключением случаев, когда один и тот же мусор оказывается смежным с интересным совпадением.285286Вот тот же пример, что и ранее, но теперь пробелы считаются мусором. Это не позволяет `' abcd'` совпадать с `' abcd'` в хвосте второй последовательности напрямую. Вместо этого может совпасть только `'abcd'`, и он совпадает с самым левым `'abcd'` во второй последовательности:287288```python289>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")290>>> s.find_longest_match(0, 5, 0, 9)291Match(a=1, b=0, size=4)292```293294Если ни один блок не совпадает, возвращается `(alo, blo, 0)`.295296Этот метод возвращает [именованный кортеж](https://python-all.ru/3.7/glossary.html#term-named-tuple) `Match(a, b, size)`.297298#### `get_matching_blocks()`299300Возвращает список троек, описывающих непересекающиеся совпадающие подпоследовательности. Каждая тройка имеет вид `(i, j, n)` и означает, что `a[i:i+n] == b[j:j+n]`. Тройки монотонно возрастают по *i* и *j*.301302Последняя тройка фиктивная и имеет значение `(len(a), len(b), 0)`. Это единственная тройка с `n == 0`. Если `(i, j, n)` и `(i', j', n')` являются соседними тройками в списке, и вторая не является последней тройкой в списке, то `i+n < i'` или `j+n < j'`; другими словами, соседние тройки всегда описывают несмежные равные блоки.303304```pycon305>>> s = SequenceMatcher(None, "abxcd", "abcd")306>>> s.get_matching_blocks()307[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]308```309310#### `get_opcodes()`311312Возвращает список 5-кортежей, описывающих, как преобразовать *a* в *b*. Каждый кортеж имеет вид `(tag, i1, i2, j1, j2)`. Первый кортеж содержит `i1 == j1 == 0`, а остальные кортежи имеют *i1* равным *i2* из предыдущего кортежа, и, аналогично, *j1* равным предыдущему *j2*.313314Значения *tag* – это строки со следующим смыслом:315316| Значение | Значение |317| --- | --- |318| `'replace'` | `a[i1:i2]` должно быть заменено на `b[j1:j2]`. |319| `'delete'` | `a[i1:i2]` должно быть удалено. Обратите внимание, что `j1 == j2` в этом случае. |320| `'insert'` | `b[j1:j2]` должно быть вставлено в `a[i1:i1]`. Обратите внимание, что `i1 == i2` в этом случае. |321| `'equal'` | `a[i1:i2] == b[j1:j2]` (подпоследовательности равны). |322323Например:324325```python326>>> a = "qabxcd"327>>> b = "abycdf"328>>> s = SequenceMatcher(None, a, b)329>>> for tag, i1, i2, j1, j2 in s.get_opcodes():330... print('{:7} a[{}:{}] --> b[{}:{}] {!r:>8} --> {!r}'.format(331... tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2]))332delete a[0:1] --> b[0:0] 'q' --> ''333equal a[1:3] --> b[0:2] 'ab' --> 'ab'334replace a[3:4] --> b[2:3] 'x' --> 'y'335equal a[4:6] --> b[3:5] 'cd' --> 'cd'336insert a[6:6] --> b[5:6] '' --> 'f'337```338339#### `get_grouped_opcodes(n=3)`340341Возвращает [генератор](https://python-all.ru/3.7/glossary.html#term-generator) групп с не более чем *n* строками контекста.342343Начиная с групп, возвращаемых [`get_opcodes()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.get_opcodes), этот метод выделяет более мелкие кластеры изменений и удаляет промежуточные диапазоны, в которых нет изменений.344345Группы возвращаются в том же формате, что и [`get_opcodes()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.get_opcodes).346347#### `ratio()`348349Возвращает меру схожести последовательностей в виде числа с плавающей запятой в диапазоне \[0, 1\].350351Где T – общее количество элементов в обеих последовательностях, а M – количество совпадений, это 2.0\*M / T. Обратите внимание, что это `1.0`, если последовательности идентичны, и `0.0`, если у них нет ничего общего.352353Это дорого вычислять, если [`get_matching_blocks()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.get_matching_blocks) или [`get_opcodes()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.get_opcodes) ещё не были вызваны; в этом случае, возможно, стоит сначала попробовать [`quick_ratio()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.quick_ratio) или [`real_quick_ratio()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.real_quick_ratio), чтобы получить верхнюю границу.354355> **Примечание**356>357> Внимание: результат вызова [`ratio()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.ratio) может зависеть от порядка аргументов. Например:358>359> ```python360> >>> SequenceMatcher(None, 'tide', 'diet').ratio()361> 0.25362> >>> SequenceMatcher(None, 'diet', 'tide').ratio()363> 0.5364> ```365366#### `quick_ratio()`367368Возвращает верхнюю границу для [`ratio()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.ratio) относительно быстро.369370#### `real_quick_ratio()`371372Возвращает верхнюю границу для [`ratio()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.ratio) очень быстро.373374Три метода, возвращающие отношение совпадающих символов к общему количеству, могут давать разные результаты из-за разного уровня приближения, хотя `quick_ratio()` и `real_quick_ratio()` всегда не меньше, чем `ratio()`:375376```python377>>> s = SequenceMatcher(None, "abcd", "bcde")378>>> s.ratio()3790.75380>>> s.quick_ratio()3810.75382>>> s.real_quick_ratio()3831.0384```385386## Примеры SequenceMatcher387388В этом примере сравниваются две строки, при этом пробелы считаются «мусором»:389390```python391>>> s = SequenceMatcher(lambda x: x == " ",392... "private Thread currentThread;",393... "private volatile Thread currentThread;")394```395396`ratio()` возвращает число с плавающей запятой в \[0, 1\], измеряющее схожесть последовательностей. Эмпирически, значение `ratio()` больше 0,6 означает, что последовательности близки к совпадению:397398```python399>>> print(round(s.ratio(), 3))4000.866401```402403Если вас интересует только то, где последовательности совпадают, `get_matching_blocks()` удобен:404405```python406>>> for block in s.get_matching_blocks():407... print("a[%d] and b[%d] match for %d elements" % block)408a[0] and b[0] match for 8 elements409a[8] and b[17] match for 21 elements410a[29] and b[38] match for 0 elements411```412413Обратите внимание, что последний кортеж, возвращаемый `get_matching_blocks()`, всегда является фиктивным, `(len(a), len(b), 0)`, и это единственный случай, когда последний элемент кортежа (количество совпавших элементов) равен `0`.414415Если вы хотите узнать, как изменить первую последовательность на вторую, используйте `get_opcodes()`:416417```python418>>> for opcode in s.get_opcodes():419... print("%6s a[%d:%d] b[%d:%d]" % opcode)420 equal a[0:8] b[0:8]421insert a[8:8] b[8:17]422 equal a[8:29] b[17:38]423```424425> **См. также**426>427> - Функция [`get_close_matches()`](https://python-all.ru/3.7/library/difflib.html#difflib.get_close_matches) в этом модуле показывает, как простой код, построенный на [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher), может использоваться для полезной работы.428> - [Простой рецепт контроля версий](https://python-all.ru/3.7/library/difflib.html) для небольшого приложения, построенного с помощью [`SequenceMatcher`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher).429430## Объекты Differ431432Обратите внимание, что дельты, сгенерированные [`Differ`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ), не претендуют на то, чтобы быть **минимальными** различиями. Напротив, минимальные различия часто противоречат интуиции, поскольку они синхронизируются везде, где возможно, иногда случайно сопоставляя фрагменты, отстоящие на 100 страниц. Ограничение точек синхронизации смежными совпадениями сохраняет некоторое понятие локальности, ценой иногда более длинного diff.433434Класс [`Differ`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ) имеет следующий конструктор:435436#### `class difflib.Differ(linejunk=None, charjunk=None)`437438Необязательные именованные параметры *linejunk* и *charjunk* предназначены для функций фильтрации (или `None`):439440*linejunk*: функция, которая принимает один строковый аргумент и возвращает истину, если строка является мусорной. По умолчанию – `None`, то есть ни одна строка не считается мусорной.441442*charjunk*: функция, которая принимает один символьный аргумент (строку длиной 1) и возвращает истину, если символ является мусорным. По умолчанию – `None`, то есть ни один символ не считается мусорным.443444Эти функции фильтрации мусора ускоряют сопоставление для поиска различий и не приводят к игнорированию каких-либо различающихся строк или символов. Прочтите описание параметра *isjunk* метода [`find_longest_match()`](https://python-all.ru/3.7/library/difflib.html#difflib.SequenceMatcher.find_longest_match) для объяснения.445446Объекты [`Differ`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ) используются (генерируют дельты) через единственный метод:447448#### `compare(a, b)`449450Сравнивает две последовательности строк и генерирует дельту (последовательность строк).451452Каждая последовательность должна содержать отдельные однострочные строки, заканчивающиеся символами новой строки. Такие последовательности можно получить из метода [`readlines()`](https://python-all.ru/3.7/library/io.html#io.IOBase.readlines) файлоподобных объектов. Сгенерированная дельта также состоит из строк, завершающихся новой строкой, готовых к печати как есть с помощью метода [`writelines()`](https://python-all.ru/3.7/library/io.html#io.IOBase.writelines) файлоподобного объекта.453454## Пример Differ455456Этот пример сравнивает два текста. Сначала мы задаем тексты – последовательности отдельных однострочных строк, заканчивающихся символами новой строки (такие последовательности также можно получить из метода `readlines()` файлоподобных объектов):457458```python459>>> text1 = ''' 1. Beautiful is better than ugly.460... 2. Explicit is better than implicit.461... 3. Simple is better than complex.462... 4. Complex is better than complicated.463... '''.splitlines(keepends=True)464>>> len(text1)4654466>>> text1[0][-1]467'\n'468>>> text2 = ''' 1. Beautiful is better than ugly.469... 3. Simple is better than complex.470... 4. Complicated is better than complex.471... 5. Flat is better than nested.472... '''.splitlines(keepends=True)473```474475Затем мы создаем экземпляр объекта Differ:476477```python478>>> d = Differ()479```480481Обратите внимание, что при создании экземпляра объекта [`Differ`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ) можно передать функции для фильтрации «мусорных» строк и символов. Подробнее см. конструктор [`Differ()`](https://python-all.ru/3.7/library/difflib.html#difflib.Differ).482483Наконец, мы сравниваем два:484485```python486>>> result = list(d.compare(text1, text2))487```488489`result` – это список строк, поэтому давайте выведем его в удобочитаемом виде:490491```python492>>> from pprint import pprint493>>> pprint(result)494[' 1. Beautiful is better than ugly.\n',495 '- 2. Explicit is better than implicit.\n',496 '- 3. Simple is better than complex.\n',497 '+ 3. Simple is better than complex.\n',498 '? ++\n',499 '- 4. Complex is better than complicated.\n',500 '? ^ ---- ^\n',501 '+ 4. Complicated is better than complex.\n',502 '? ++++ ^ ^\n',503 '+ 5. Flat is better than nested.\n']504```505506В виде одной многострочной строки это выглядит так:507508```python509>>> import sys510>>> sys.stdout.writelines(result)511 1. Beautiful is better than ugly.512- 2. Explicit is better than implicit.513- 3. Simple is better than complex.514+ 3. Simple is better than complex.515? ++516- 4. Complex is better than complicated.517? ^ ---- ^518+ 4. Complicated is better than complex.519? ++++ ^ ^520+ 5. Flat is better than nested.521```522523## Интерфейс командной строки для difflib524525В этом примере показано, как использовать difflib для создания утилиты, подобной `diff`. Он также включён в дистрибутив исходного кода Python, как `Tools/scripts/diff.py`.526527```python528#!/usr/bin/env python3529""" Интерфейс командной строки для difflib.py, выводящий разницу в четырёх форматах:530531* ndiff: выводит каждую строку и подсвечивает изменения между строками.532* context: подсвечивает кластеры изменений в формате «до/после».533* unified: подсвечивает кластеры изменений во встроенном формате.534* html: генерирует построчное сравнение с подсветкой изменений.535536"""537538import sys, os, difflib, argparse539from datetime import datetime, timezone540541def file_mtime(path):542 t = datetime.fromtimestamp(os.stat(path).st_mtime,543 timezone.utc)544 return t.astimezone().isoformat()545546def main():547548 parser = argparse.ArgumentParser()549 parser.add_argument('-c', action='store_true', default=False,550 help='Produce a context format diff (default)')551 parser.add_argument('-u', action='store_true', default=False,552 help='Produce a unified format diff')553 parser.add_argument('-m', action='store_true', default=False,554 help='Produce HTML side by side diff '555 '(can use -c and -l in conjunction)')556 parser.add_argument('-n', action='store_true', default=False,557 help='Produce a ndiff format diff')558 parser.add_argument('-l', '--lines', type=int, default=3,559 help='Set number of context lines (default 3)')560 parser.add_argument('fromfile')561 parser.add_argument('tofile')562 options = parser.parse_args()563564 n = options.lines565 fromfile = options.fromfile566 tofile = options.tofile567568 fromdate = file_mtime(fromfile)569 todate = file_mtime(tofile)570 with open(fromfile) as ff:571 fromlines = ff.readlines()572 with open(tofile) as tf:573 tolines = tf.readlines()574575 if options.u:576 diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)577 elif options.n:578 diff = difflib.ndiff(fromlines, tolines)579 elif options.m:580 diff = difflib.HtmlDiff().make_file(fromlines,tolines,fromfile,tofile,context=options.c,numlines=n)581 else:582 diff = difflib.context_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)583584 sys.stdout.writelines(diff)585586if __name__ == '__main__':587 main()588```589