difflib.md
1> **Источник:** https://python-all.ru/3.0/library/difflib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `difflib` – Вспомогательные средства для вычисления различий89Этот модуль предоставляет классы и функции для сравнения последовательностей. Его можно использовать, например, для сравнения файлов, и он может выводить информацию о различиях в различных форматах, включая HTML, контекстные и объединённые диффы. Для сравнения каталогов и файлов смотрите также модуль [`filecmp`](https://python-all.ru/3.0/library/filecmp.html#module-filecmp).1011#### `[difflib.SequenceMatcher]class difflib.SequenceMatcher`1213Это гибкий класс для сравнения пар последовательностей любого типа, при условии, что элементы последовательностей являются [*хэшируемыми*](https://python-all.ru/3.0/glossary.html#term-hashable). Базовый алгоритм предшествует алгоритму, опубликованному в конце 1980-х годов Рэтклиффом и Обершелпом под громким названием «гештальт-сопоставление шаблонов», и немного сложнее его. Идея заключается в поиске самой длинной непрерывной совпадающей подпоследовательности, не содержащей «мусорных» элементов (алгоритм Рэтклиффа и Обершелпа не учитывает мусор). Затем эта же идея рекурсивно применяется к частям последовательностей слева и справа от совпадающей подпоследовательности. Это не даёт минимальных последовательностей редактирования, но обычно даёт совпадения, которые «выглядят правильно» для человека.1415**Время выполнения:** Базовый алгоритм Рэтклиффа-Обершелпа имеет кубическую сложность в худшем случае и квадратичную в среднем. [`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) имеет квадратичную сложность в худшем случае, а поведение в среднем зависит сложным образом от того, сколько элементов у последовательностей общих; в лучшем случае сложность линейная.1617#### `[difflib.Differ]class difflib.Differ`1819Это класс для сравнения последовательностей текстовых строк и создания различий или дельт, понятных человеку. Differ использует [`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) как для сравнения последовательностей строк, так и для сравнения последовательностей символов внутри похожих (почти совпадающих) строк.2021Каждая строка дельты, созданной [`Differ`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ), начинается с двухбуквенного кода:2223| Код | Значение |24| --- | --- |25| `'- '` | строка, уникальная для последовательности 1 |26| `'+ '` | строка, уникальная для последовательности 2 |27| `' '` | строка, общая для обеих последовательностей |28| `'? '` | строка, отсутствующая в каждой входной последовательности |2930Строки, начинающиеся с ‘`?`‘, пытаются привлечь внимание к внутристрочным различиям и отсутствовали в обеих входных последовательностях. Эти строки могут сбивать с толку, если последовательности содержат символы табуляции.3132#### `[difflib.HtmlDiff]class difflib.HtmlDiff`3334Этот класс можно использовать для создания HTML-таблицы (или полного HTML-файла, содержащего таблицу), отображающей поочередное сравнение текста строка за строкой с подсветкой изменений между строками и внутри строк. Таблица может быть создана в режиме полных или контекстных различий.3536Конструктор этого класса:3738#### `[difflib.HtmlDiff.__init__]__init__([tabsize][, wrapcolumn][, linejunk][, charjunk])`3940Инициализирует экземпляр [`HtmlDiff`](https://python-all.ru/3.0/library/difflib.html#difflib.HtmlDiff).4142*tabsize* – необязательный именованный аргумент для задания шага табуляции; по умолчанию равен `8`.4344*wrapcolumn* – необязательный именованный аргумент, задающий номер столбца, в котором строки разбиваются и переносятся; по умолчанию `None`, то есть строки не переносятся.4546*linejunk* и *charjunk* – это необязательные именованные аргументы, передаваемые в `ndiff()` (используются [`HtmlDiff`](https://python-all.ru/3.0/library/difflib.html#difflib.HtmlDiff) для создания параллельного HTML-представления различий). См. документацию `ndiff()` для получения значений по умолчанию и описаний аргументов.4748Следующие методы являются открытыми:4950#### `[difflib.HtmlDiff.make_file]make_file(fromlines, tolines[, fromdesc][, todesc][, context][, numlines])`5152Сравнивает *fromlines* и *tolines* (списки строк) и возвращает строку, содержащую полный HTML-файл с таблицей, отображающей построчные различия с подсветкой изменений между строками и внутри строк.5354*fromdesc* и *todesc* – необязательные именованные аргументы для задания строк заголовков столбцов исходного и целевого файлов (оба по умолчанию равны пустой строке).5556*context* и *numlines* – необязательные именованные аргументы. Установите *context* в значение `True`, чтобы показывать контекстные различия, иначе по умолчанию `False`, показывающее полные файлы. *numlines* по умолчанию равен `5`. Когда *context* равно `True`, *numlines* управляет количеством строк контекста, окружающих подсветку различий. Когда *context* равно `False`, *numlines* управляет количеством строк, показываемых перед подсветкой различий при использовании гиперссылок «далее» (установка нуля приведёт к тому, что гиперссылка «далее» будет помещать следующую подсветку различий в верхнюю часть браузера без предшествующего контекста).5758#### `[difflib.HtmlDiff.make_table]make_table(fromlines, tolines[, fromdesc][, todesc][, context][, numlines])`5960Сравнивает *fromlines* и *tolines* (списки строк) и возвращает строку, которая представляет собой полную HTML-таблицу с построчным отображением различий, выделяя изменения между строками и внутри строк.6162Аргументы этого метода такие же, как у метода [`make_file()`](https://python-all.ru/3.0/library/difflib.html#difflib.HtmlDiff.make_file).6364`Tools/scripts/diff.py` – это интерфейс командной строки для этого класса, содержащий хороший пример его использования.6566#### `[difflib.context_diff]difflib.context_diff(a, b[, fromfile][, tofile][, fromfiledate][, tofiledate][, n][, lineterm])`6768Сравнивает *a* и *b* (списки строк); возвращает дельту ([*генератор*](https://python-all.ru/3.0/glossary.html#term-generator), порождающий строки дельты) в формате контекстного diff.6970Контекстные диффы – это компактный способ показать только изменённые строки плюс несколько строк контекста. Изменения отображаются в стиле «до/после». Количество строк контекста задаётся параметром *n*, по умолчанию – три.7172По умолчанию управляющие строки diff (те, что с `***` или `---`) создаются\\nс завершающим переводом строки. Это полезно, поскольку входные данные, полученные из\\n[`file.readlines()`](https://python-all.ru/3.0/library/stdtypes.html#file.readlines), дают различия, пригодные для использования с\\n[`file.writelines()`](https://python-all.ru/3.0/library/stdtypes.html#file.writelines), так как и входные, и выходные данные содержат завершающие\\nпереводы строк.7374Для входных данных, не имеющих завершающего перевода строки, установите аргумент *lineterm* равным `""`, чтобы выходные данные были полностью без символов новой строки.7576Формат контекстной разницы обычно содержит заголовок с именами файлов и временем изменения. Любой из них или все они могут быть заданы строками для *fromfile*, *tofile*, *fromfiledate* и *tofiledate*. Время изменения обычно выражается в формате, возвращаемом функцией [`time.ctime()`](https://python-all.ru/3.0/library/time.html#time.ctime). Если не указано, строки по умолчанию являются пустыми.7778```python79>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']80>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']81>>> for line in context_diff(s1, s2, fromfile='before.py', tofile='after.py'):82... sys.stdout.write(line) # doctest: +NORMALIZE_WHITESPACE83*** before.py84--- after.py85***************86*** 1,4 ****87! bacon88! eggs89! ham90 guido91--- 1,4 ----92! python93! eggy94! hamster95 guido96```9798Смотрите [*Интерфейс командной строки для difflib*](https://python-all.ru/3.0/library/difflib.html#difflib-interface) для более подробного примера.99100#### `[difflib.get_close_matches]difflib.get_close_matches(word, possibilities[, n][, cutoff])`101102Возвращает список наилучших «достаточно хороших» совпадений. *word* – это последовательность, для которой требуются близкие совпадения (обычно строка), а *possibilities* – список последовательностей, с которыми нужно сопоставлять *word* (обычно список строк).103104Необязательный аргумент *n* (по умолчанию `3`) – максимальное количество близких совпадений, которые нужно вернуть; *n* должно быть больше `0`.105106Необязательный аргумент *cutoff* (по умолчанию `0.6`) – число с плавающей точкой в диапазоне \[0, 1\]. Варианты, которые набирают меньше этого порога сходства с *word*, игнорируются.107108Наилучшие (не более *n*) совпадения из возможных вариантов возвращаются в виде списка, отсортированного по мере сходства: сначала самые похожие.109110```python111>>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])112['apple', 'ape']113>>> import keyword114>>> get_close_matches('wheel', keyword.kwlist)115['while']116>>> get_close_matches('apple', keyword.kwlist)117[]118>>> get_close_matches('accept', keyword.kwlist)119['except']120```121122#### `[difflib.ndiff]difflib.ndiff(a, b[, linejunk][, charjunk])`123124Сравнивает *a* и *b* (списки строк); возвращает дельту в стиле [`Differ`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ) ([*генератор*](https://python-all.ru/3.0/glossary.html#term-generator), порождающий строки дельты).125126Необязательные именованные параметры *linejunk* и *charjunk* предназначены для функций фильтрации (или `None`):127128*linejunk*: Функция, которая принимает один строковый аргумент и возвращает true, если строка является мусором, и false в противном случае. По умолчанию `None`. Также существует функция уровня модуля [`IS_LINE_JUNK()`](https://python-all.ru/3.0/library/difflib.html#difflib.IS_LINE_JUNK), которая отфильтровывает строки без видимых символов, за исключением не более одного символа решётки (`'#'`) – однако базовый класс [`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) выполняет динамический анализ того, какие строки настолько часты, что составляют шум, и это обычно работает лучше, чем использование этой функции.129130*charjunk*: Функция, которая принимает символ (строку длины 1) и возвращает истину, если символ является мусором, и ложь в противном случае. По умолчанию – функция уровня модуля [`IS_CHARACTER_JUNK()`](https://python-all.ru/3.0/library/difflib.html#difflib.IS_CHARACTER_JUNK), которая отфильтровывает пробельные символы (пробел или табуляцию; примечание: не стоит включать сюда символ новой строки!).131132`Tools/scripts/ndiff.py` – это интерфейс командной строки для этой функции.133134```python135>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(1),136... 'ore\ntree\nemu\n'.splitlines(1))137>>> print(''.join(diff), end="")138- one139? ^140+ ore141? ^142- two143- three144? -145+ tree146+ emu147```148149#### `[difflib.restore]difflib.restore(sequence, which)`150151Возвращает одну из двух последовательностей, породивших дельту.152153Принимает *sequence*, созданный с помощью [`Differ.compare()`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ.compare) или [`ndiff()`](https://python-all.ru/3.0/library/difflib.html#difflib.ndiff), извлекает строки, относящиеся к файлу 1 или 2 (параметр *which*), удаляя префиксы строк.154155Пример:156157```python158>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(1),159... 'ore\ntree\nemu\n'.splitlines(1))160>>> diff = list(diff) # материализовать сгенерированную дельту в список161>>> print(''.join(restore(diff, 1)), end="")162one163two164three165>>> print(''.join(restore(diff, 2)), end="")166ore167tree168emu169```170171#### `[difflib.unified_diff]difflib.unified_diff(a, b[, fromfile][, tofile][, fromfiledate][, tofiledate][, n][, lineterm])`172173Сравнивает *a* и *b* (списки строк); возвращает дельту ([*генератор*](https://python-all.ru/3.0/glossary.html#term-generator), порождающий строки дельты) в формате unified diff.174175Унифицированные различия – это компактный способ показа только изменённых строк плюс несколько строк контекста. Изменения отображаются встроенным стилем (вместо отдельных блоков «до» и «после»). Количество строк контекста задаётся параметром *n*, по умолчанию равным трём.176177По умолчанию управляющие строки diff (те, что с `---`, `+++` или `@@`) создаются\\nс завершающим переводом строки. Это полезно, поскольку входные данные, полученные из\\n[`file.readlines()`](https://python-all.ru/3.0/library/stdtypes.html#file.readlines), дают различия, пригодные для использования с\\n[`file.writelines()`](https://python-all.ru/3.0/library/stdtypes.html#file.writelines), так как и входные, и выходные данные содержат завершающие\\nпереводы строк.178179Для входных данных, не имеющих завершающего перевода строки, установите аргумент *lineterm* равным `""`, чтобы выходные данные были полностью без символов новой строки.180181Формат контекстной разницы обычно содержит заголовок с именами файлов и временем изменения. Любой из них или все они могут быть заданы строками для *fromfile*, *tofile*, *fromfiledate* и *tofiledate*. Время изменения обычно выражается в формате, возвращаемом функцией [`time.ctime()`](https://python-all.ru/3.0/library/time.html#time.ctime). Если не указано, строки по умолчанию являются пустыми.182183```python184>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']185>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']186>>> for line in unified_diff(s1, s2, fromfile='before.py', tofile='after.py'):187... sys.stdout.write(line) # doctest: +NORMALIZE_WHITESPACE188--- before.py189+++ after.py190@@ -1,4 +1,4 @@191-bacon192-eggs193-ham194+python195+eggy196+hamster197 guido198```199200Смотрите [*Интерфейс командной строки для difflib*](https://python-all.ru/3.0/library/difflib.html#difflib-interface) для более подробного примера.201202#### `[difflib.IS_LINE_JUNK]difflib.IS_LINE_JUNK(line)`203204Возвращает True для строк, которые можно игнорировать. Строка205206*line*207208игнорируется, если209210*line*211212пуста или содержит только213214`'#'`215216, иначе не игнорируется. В старых версиях используется как значение по умолчанию для параметра217218*linejunk*219220в221222[`ndiff()`](https://python-all.ru/3.0/library/difflib.html#difflib.ndiff)223224.225226#### `[difflib.IS_CHARACTER_JUNK]difflib.IS_CHARACTER_JUNK(ch)`227228Возвращает True для игнорируемых символов. Символ229230*ch*231232игнорируется, если233234*ch*235236является пробелом или табуляцией, иначе не игнорируется. Используется как значение по умолчанию для параметра237238*charjunk*239240в241242[`ndiff()`](https://python-all.ru/3.0/library/difflib.html#difflib.ndiff)243244.245246> **См. также**247>248> **[Сопоставление с образцом: гештальт-подход](https://python-all.ru/3.0/library/difflib.html)**249>250> Обсуждение похожего алгоритма Джона У. Рэтклиффа и Д. Э. Мецнера. Оно было опубликовано в251>252> [Dr. Dobb’s Journal](https://python-all.ru/3.0/library/difflib.html)253>254> в июле 1988 года.255256## Объекты SequenceMatcher257258Класс [`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) имеет следующий конструктор:259260#### `class difflib.SequenceMatcher([isjunk[, a[, b]]])`261262Необязательный аргумент *isjunk* должен быть `None` (по умолчанию) или функцией с одним аргументом, которая принимает элемент последовательности и возвращает True тогда и только тогда, когда элемент является «мусором» и должен игнорироваться. Передача `None` в качестве *isjunk* эквивалентна передаче `lambda x: 0`; иными словами, ни один элемент не игнорируется. Например, передайте:263264```python265lambda x: x in " \t"266```267268если строки сравниваются как последовательности символов и не требуется выравнивание по пробелам или табуляциям.269270Необязательные аргументы *a* и *b* – это последовательности для сравнения; обе по умолчанию равны пустым строкам. Элементы обеих последовательностей должны быть [*хэшируемыми*](https://python-all.ru/3.0/glossary.html#term-hashable) (hashable).271272Объекты [`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) имеют следующие методы:273274#### `[difflib.SequenceMatcher.set_seqs]set_seqs(a, b)`275276Устанавливает две последовательности для сравнения.277278[`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) вычисляет и кеширует подробную информацию о второй последовательности, поэтому, если требуется сравнить одну последовательность с несколькими, используйте [`set_seq2()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.set_seq2) для однократного задания общей последовательности и затем многократно вызывайте [`set_seq1()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.set_seq1) – по одному разу для каждой из остальных последовательностей.279280#### `[difflib.SequenceMatcher.set_seq1]set_seq1(a)`281282Устанавливает первую последовательность для сравнения. Вторая последовательность для сравнения не изменяется.283284#### `[difflib.SequenceMatcher.set_seq2]set_seq2(b)`285286Устанавливает вторую последовательность для сравнения. Первая последовательность для сравнения не изменяется.287288#### `[difflib.SequenceMatcher.find_longest_match]find_longest_match(alo, ahi, blo, bhi)`289290Найти самый длинный совпадающий блок в `a[alo:ahi]` и `b[blo:bhi]`.291292Если *isjunk* был опущен или равен `None`, [`find_longest_match()`](https://python-all.ru/3.0/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*.293294```python295>>> s = SequenceMatcher(None, " abcd", "abcd abcd")296>>> s.find_longest_match(0, 5, 0, 9)297Match(a=0, b=4, size=5)298```299300Если *isjunk* был указан, сначала определяется самый длинный совпадающий блок, как описано выше, но с дополнительным ограничением: в блоке не должно быть мусорных элементов. Затем этот блок расширяется как можно дальше за счёт сопоставления (только) мусорных элементов с обеих сторон. Таким образом, результирующий блок никогда не совпадает по мусору, за исключением случаев, когда один и тот же мусор оказывается смежным с интересным совпадением.301302Вот тот же пример, что и раньше, но с учётом пробелов как мусора. Это не позволяет `' abcd'` напрямую совпасть с `' abcd'` в конце второй последовательности. Вместо этого совпасть может только `'abcd'`, и он совпадает с самым левым `'abcd'` во второй последовательности:303304```python305>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")306>>> s.find_longest_match(0, 5, 0, 9)307Match(a=1, b=0, size=4)308```309310Если ни один блок не совпадает, возвращается `(alo, blo, 0)`.311312Этот метод возвращает [*именованный кортеж*](https://python-all.ru/3.0/glossary.html#term-named-tuple) `Match(a, b, size)`.313314#### `[difflib.SequenceMatcher.get_matching_blocks]get_matching_blocks()`315316Возвращает список троек, описывающих совпадающие подпоследовательности. Каждая тройка имеет вид `(i, j, n)` и означает, что `a[i:i+n] == b[j:j+n]`. Тройки монотонно возрастают по *i* и *j*.317318Последняя тройка – фиктивная, её значение `(len(a), len(b), 0)`. Это единственная тройка, у которой `n == 0`. Если `(i, j, n)` и `(i', j', n')` являются соседними тройками в списке, и вторая не является последней тройкой в списке, то `i+n != i'` или `j+n != j'`; иными словами, соседние тройки всегда описывают несмежные равные блоки.319320```python321>>> s = SequenceMatcher(None, "abxcd", "abcd")322>>> s.get_matching_blocks()323[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]324```325326#### `[difflib.SequenceMatcher.get_opcodes]get_opcodes()`327328Возвращает список 5-кортежей, описывающих, как преобразовать *a* в *b*. Каждый кортеж имеет вид `(tag, i1, i2, j1, j2)`. Первый кортеж имеет `i1 == j1 == 0`, а остальные кортежи имеют *i1*, равный *i2* из предыдущего кортежа, и, аналогично, *j1* равно предыдущему *j2*.329330Значения *tag* – это строки со следующим смыслом:331332| Значение | Значение |333| --- | --- |334| `'replace'` | `a[i1:i2]` должен быть заменён на `b[j1:j2]`. |335| `'delete'` | `a[i1:i2]` должен быть удалён. Обратите внимание, что в этом случае `j1 == j2`. |336| `'insert'` | `b[j1:j2]` должен быть вставлен в `a[i1:i1]`. Обратите внимание, что в этом случае `i1 == i2`. |337| `'equal'` | `a[i1:i2] == b[j1:j2]` (подпоследовательности равны). |338339Например:340341```python342>>> a = "qabxcd"343>>> b = "abycdf"344>>> s = SequenceMatcher(None, a, b)345>>> for tag, i1, i2, j1, j2 in s.get_opcodes():346... print(("%7s a[%d:%d] (%s) b[%d:%d] (%s)" %347... (tag, i1, i2, a[i1:i2], j1, j2, b[j1:j2])))348 delete a[0:1] (q) b[0:0] ()349 equal a[1:3] (ab) b[0:2] (ab)350replace a[3:4] (x) b[2:3] (y)351 equal a[4:6] (cd) b[3:5] (cd)352 insert a[6:6] () b[5:6] (f)353```354355#### `[difflib.SequenceMatcher.get_grouped_opcodes]get_grouped_opcodes([n])`356357Возвращает [*генератор*](https://python-all.ru/3.0/glossary.html#term-generator) групп с не более чем *n* строками контекста.358359Начиная с групп, возвращаемых [`get_opcodes()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.get_opcodes), этот метод разбивает их на более мелкие кластеры изменений и удаляет промежуточные диапазоны, в которых нет изменений.360361Группы возвращаются в том же формате, что и [`get_opcodes()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.get_opcodes).362363#### `[difflib.SequenceMatcher.ratio]ratio()`364365Возвращает меру схожести последовательностей в виде числа с плавающей запятой в диапазоне \[0, 1\].366367Где T – общее количество элементов в обеих последовательностях, а M – количество совпадений, это 2.0\*M / T. Обратите внимание, что это `1.0`, если последовательности идентичны, и `0.0`, если у них нет ничего общего.368369Это дорогостоящая операция, если [`get_matching_blocks()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.get_matching_blocks) или [`get_opcodes()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.get_opcodes) ещё не были вызваны; в таком случае, возможно, стоит сначала попробовать [`quick_ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.quick_ratio) или [`real_quick_ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.real_quick_ratio), чтобы получить верхнюю границу.370371#### `[difflib.SequenceMatcher.quick_ratio]quick_ratio()`372373Возвращает верхнюю границу [`ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.ratio) относительно быстро.374375Точное определение этого значения не дано; оно лишь является верхней границей для [`ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.ratio) и вычисляется быстрее.376377#### `[difflib.SequenceMatcher.real_quick_ratio]real_quick_ratio()`378379Возвращает верхнюю границу [`ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.ratio) очень быстро.380381Точное определение этого значения не дано; оно лишь является верхней границей для [`ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.ratio) и вычисляется быстрее, чем [`ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.ratio) или [`quick_ratio()`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher.quick_ratio).382383Три метода, возвращающие отношение совпадающих символов к общему количеству, могут давать разные результаты из-за разной степени приближения, хотя `quick_ratio()` и `real_quick_ratio()` всегда не меньше, чем `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()` возвращает число с плавающей запятой в диапазоне \[0, 1\], измеряющее схожесть последовательностей. Эмпирически, значение `ratio()` больше 0,6 означает, что последовательности близки:406407```python408>>> print(round(s.ratio(), 3))4090.866410```411412Если интересует только, где последовательности совпадают, `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()`, всегда является фиктивным: `(len(a), len(b), 0)`, и это единственный случай, когда последний элемент кортежа (количество совпавших элементов) равен `0`.423424Если требуется узнать, как изменить первую последовательность, чтобы получить вторую, используйте `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Смотрите также функцию [`get_close_matches()`](https://python-all.ru/3.0/library/difflib.html#difflib.get_close_matches) в этом модуле; она показывает, как простой код на основе [`SequenceMatcher`](https://python-all.ru/3.0/library/difflib.html#difflib.SequenceMatcher) можно использовать для полезной работы.435436## Объекты Differ437438Обратите внимание, что дельты, созданные [`Differ`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ), не претендуют на то, чтобы быть **минимальными** различиями. Напротив, минимальные различия часто неочевидны, потому что они синхронизируются везде, где возможно, иногда случайно совпадая на расстоянии 100 страниц. Ограничение точек синхронизации непрерывными совпадениями сохраняет некоторое понятие локальности, ценой получения более длинного diff.439440Класс [`Differ`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ) имеет следующий конструктор:441442#### `class difflib.Differ([linejunk[, charjunk]])`443444Необязательные именованные параметры *linejunk* и *charjunk* предназначены для функций фильтрации (или `None`):445446*linejunk*: функция, которая принимает один строковый аргумент и возвращает True, если строка является мусором. По умолчанию `None`, то есть ни одна строка не считается мусором.447448*charjunk*: функция, которая принимает один символьный аргумент (строку длины 1) и возвращает True, если символ является мусором. По умолчанию `None`, то есть ни один символ не считается мусором.449450Объекты [`Differ`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ) используются (дельты создаются) с помощью одного метода:451452#### `[difflib.Differ.compare]compare(a, b)`453454Сравнивает две последовательности строк и генерирует дельту (последовательность строк).455456Каждая последовательность должна содержать отдельные однострочные строки, заканчивающиеся символами новой строки. Такие последовательности можно получить из метода `readlines()` файлоподобных объектов. Сгенерированный дельта также состоит из строк, заканчивающихся символом новой строки, готовых к выводу как есть с помощью метода `writelines()` файлоподобного объекта.457458## Пример Differ459460В этом примере сравниваются два текста. Сначала настроим тексты – последовательности отдельных однострочных строк, заканчивающихся символами новой строки (такие последовательности также можно получить из метода `readlines()` файлоподобных объектов):461462```python463>>> text1 = ''' 1. Beautiful is better than ugly.464... 2. Explicit is better than implicit.465... 3. Simple is better than complex.466... 4. Complex is better than complicated.467... '''.splitlines(1)468>>> len(text1)4694470>>> text1[0][-1]471'\n'472>>> text2 = ''' 1. Beautiful is better than ugly.473... 3. Simple is better than complex.474... 4. Complicated is better than complex.475... 5. Flat is better than nested.476... '''.splitlines(1)477```478479Затем мы создаем экземпляр объекта Differ:480481```python482>>> d = Differ()483```484485Note that when instantiating a [`Differ`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ) object we may pass functions to filter out line and character “junk.” See the [`Differ()`](https://python-all.ru/3.0/library/difflib.html#difflib.Differ) constructor for details.486487Наконец, мы сравниваем два:488489```python490>>> result = list(d.compare(text1, text2))491```492493`result` – это список строк, поэтому выведем его в отформатированном виде:494495```python496>>> from pprint import pprint497>>> pprint(result)498[' 1. Beautiful is better than ugly.\n',499 '- 2. Explicit is better than implicit.\n',500 '- 3. Simple is better than complex.\n',501 '+ 3. Simple is better than complex.\n',502 '? ++\n',503 '- 4. Complex is better than complicated.\n',504 '? ^ ---- ^\n',505 '+ 4. Complicated is better than complex.\n',506 '? ++++ ^ ^\n',507 '+ 5. Flat is better than nested.\n']508```509510В виде одной многострочной строки это выглядит так:511512```python513>>> import sys514>>> sys.stdout.writelines(result)515 1. Beautiful is better than ugly.516- 2. Explicit is better than implicit.517- 3. Simple is better than complex.518+ 3. Simple is better than complex.519? ++520- 4. Complex is better than complicated.521? ^ ---- ^522+ 4. Complicated is better than complex.523? ++++ ^ ^524+ 5. Flat is better than nested.525```526527## Интерфейс командной строки для difflib528529В этом примере показано, как использовать difflib для создания утилиты, подобной `diff`. Она также содержится в дистрибутиве исходного кода Python как `Tools/scripts/diff.py`.530531```python532""" Command line interface to difflib.py providing diffs in four formats:533534* ndiff: lists every line and highlights interline changes.535* context: highlights clusters of changes in a before/after format.536* unified: highlights clusters of changes in an inline format.537* html: generates side by side comparison with change highlights.538539"""540541import sys, os, time, difflib, optparse542543def main():544 # Configure the option parser545 usage = "usage: %prog [options] fromfile tofile"546 parser = optparse.OptionParser(usage)547 parser.add_option("-c", action="store_true", default=False,548 help='Produce a context format diff (default)')549 parser.add_option("-u", action="store_true", default=False,550 help='Produce a unified format diff')551 hlp = 'Produce HTML side by side diff (can use -c and -l in conjunction)'552 parser.add_option("-m", action="store_true", default=False, help=hlp)553 parser.add_option("-n", action="store_true", default=False,554 help='Produce a ndiff format diff')555 parser.add_option("-l", "--lines", type="int", default=3,556 help='Set number of context lines (default 3)')557 (options, args) = parser.parse_args()558559 if len(args) == 0:560 parser.print_help()561 sys.exit(1)562 if len(args) != 2:563 parser.error("need to specify both a fromfile and tofile")564565 n = options.lines566 fromfile, tofile = args # as specified in the usage string567568 # we're passing these as arguments to the diff function569 fromdate = time.ctime(os.stat(fromfile).st_mtime)570 todate = time.ctime(os.stat(tofile).st_mtime)571 fromlines = open(fromfile, 'U').readlines()572 tolines = open(tofile, 'U').readlines()573574 if options.u:575 diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile,576 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,581 tofile, context=options.c,582 numlines=n)583 else:584 diff = difflib.context_diff(fromlines, tolines, fromfile, tofile,585 fromdate, todate, n=n)586587 # we're using writelines because diff is a generator588 sys.stdout.writelines(diff)589590if __name__ == '__main__':591 main()592```593