`html.parser.md`

280 строк · 17.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/library/html.parser.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`html.parser`](https://python-all.ru/3.10/library/html.parser.html#module-html.parser) – Простой парсер HTML и XHTML89**Исходный код:** [Lib/html/parser.py](https://python-all.ru/src/3.10/Lib/html/parser.py)1011---1213Этот модуль определяет класс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser), который служит основой для разбора текстовых файлов в форматах HTML (HyperText Mark-up Language) и XHTML.1415#### `class html.parser.HTMLParser(*, convert_charrefs=True, scripting=False)`1617Создаёт экземпляр парсера, способный разбирать некорректную разметку.1819Если *convert\_charrefs* равно true (по умолчанию), все символьные ссылки (кроме тех, что внутри элементов `script` и `style`) автоматически преобразуются в соответствующие символы Unicode.2021Если *scripting* равно false (по умолчанию), содержимое элемента `noscript` разбирается как обычно; если true, оно возвращается как есть без разбора.2223Экземпляр [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) получает HTML-данные и вызывает методы-обработчики при обнаружении открывающих тегов, закрывающих тегов, текста, комментариев и других элементов разметки. Пользователь должен создать подкласс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) и переопределить его методы для реализации нужного поведения.2425Этот парсер не проверяет, соответствуют ли закрывающие теги открывающим, и не вызывает обработчик закрывающего тега для элементов, которые неявно закрываются при закрытии внешнего элемента.2627Изменено в версии 3.4: Добавлен аргумент *convert\_charrefs*.2829Изменено в версии 3.5: Значением по умолчанию для аргумента *convert\_charrefs* теперь является `True`.3031Изменено в версии 3.10.20: Добавлен параметр *scripting*.3233## Пример приложения парсера HTML3435В качестве простого примера ниже показан парсер HTML, использующий класс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) для вывода открывающих тегов, закрывающих тегов и данных по мере их обнаружения:3637```python38from html.parser import HTMLParser3940class MyHTMLParser(HTMLParser):41    def handle_starttag(self, tag, attrs):42        print("Encountered a start tag:", tag)4344    def handle_endtag(self, tag):45        print("Encountered an end tag :", tag)4647    def handle_data(self, data):48        print("Encountered some data  :", data)4950parser = MyHTMLParser()51parser.feed('<html><head><title>Test</title></head>'52            '<body><h1>Parse me!</h1></body></html>')53```5455Результат будет таким:5657```text58Encountered a start tag: html59Encountered a start tag: head60Encountered a start tag: title61Encountered some data  : Test62Encountered an end tag : title63Encountered an end tag : head64Encountered a start tag: body65Encountered a start tag: h166Encountered some data  : Parse me!67Encountered an end tag : h168Encountered an end tag : body69Encountered an end tag : html70```7172## [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) Методы7374Экземпляры [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) имеют следующие методы:7576#### `HTMLParser.feed(data)`7778Передаёт текст парсеру. Текст обрабатывается постольку, поскольку состоит из полных элементов; неполные данные буферизуются до тех пор, пока не будут переданы новые данные или не будет вызван [`close()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.close). Аргумент *data* должен быть [`str`](https://python-all.ru/3.10/library/stdtypes.html#str).7980#### `HTMLParser.close()`8182Принудительно обрабатывает все буферизованные данные так, как если бы за ними следовал маркер конца файла. Этот метод может быть переопределён в производном классе для дополнительной обработки в конце входных данных, но переопределённая версия всегда должна вызывать метод [`close()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.close) базового класса [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser).8384#### `HTMLParser.reset()`8586Сбрасывает экземпляр. Теряет все необработанные данные. Вызывается неявно при создании экземпляра.8788#### `HTMLParser.getpos()`8990Возвращает номер текущей строки и смещение.9192#### `HTMLParser.get_starttag_text()`9394Возвращает текст самого последнего открытого начального тега. Обычно это не требуется для структурированной обработки, но может пригодиться при работе с HTML «как есть» или при повторной генерации входных данных с минимальными изменениями (пробелы между атрибутами можно сохранить и т.д.).9596Следующие методы вызываются при обнаружении данных или элементов разметки, и их предполагается переопределять в подклассе. Реализации базового класса ничего не делают (кроме [`handle_startendtag()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.handle_startendtag)):9798#### `HTMLParser.handle_starttag(tag, attrs)`99100Этот метод вызывается для обработки открывающего тега элемента (например, `<div id="main">`).101102Аргумент *tag* – это имя тега, приведённое к нижнему регистру. Аргумент *attrs* – это список пар `(name, value)`, содержащих атрибуты, найденные внутри угловых скобок тега `<>`. Имя *name* будет приведено к нижнему регистру, кавычки в значении *value* удалены, а символьные и сущностные ссылки заменены.103104Например, для тега `<A HREF="https://www.cwi.nl/">` этот метод будет вызван как `handle_starttag('a', [('href', 'https://www.cwi.nl/')])`.105106Все ссылки на сущности из [`html.entities`](https://python-all.ru/3.10/library/html.entities.html#module-html.entities) заменяются в значениях атрибутов.107108#### `HTMLParser.handle_endtag(tag)`109110Этот метод вызывается для обработки закрывающего тега элемента (например, `</div>`).111112Аргумент *tag* – это имя тега, приведённое к нижнему регистру.113114#### `HTMLParser.handle_startendtag(tag, attrs)`115116Аналогично [`handle_starttag()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.handle_starttag), но вызывается, когда парсер встречает пустой тег в стиле XHTML (`<img ... />`). Этот метод может быть переопределён подклассами, которым требуется эта конкретная лексическая информация; реализация по умолчанию просто вызывает [`handle_starttag()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.handle_starttag) и [`handle_endtag()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.handle_endtag).117118#### `HTMLParser.handle_data(data)`119120Этот метод вызывается для обработки произвольных данных (например, текстовых узлов и содержимого элементов, таких как `script` и `style`).121122#### `HTMLParser.handle_entityref(name)`123124Этот метод вызывается для обработки именованной символьной ссылки вида `&name;` (например, `&gt;`), где *name* – это ссылка на общую сущность (например, `'gt'`). Этот метод вызывается только если *convert\_charrefs* имеет значение false.125126#### `HTMLParser.handle_charref(name)`127128Этот метод вызывается для обработки десятичных и шестнадцатеричных числовых символьных ссылок вида `&#NNN;` и `&#xNNN;`. Например, десятичный эквивалент для `&gt;` – это `&#62;`, а шестнадцатеричный – `&#x3E;`; в этом случае метод получит `'62'` или `'x3E'`. Этот метод вызывается только если *convert\_charrefs* имеет значение false.129130#### `HTMLParser.handle_comment(data)`131132Этот метод вызывается, когда встречается комментарий (например, `<!--comment-->`).133134Например, комментарий `<!-- comment -->` приведёт к вызову этого метода с аргументом `' comment '`.135136Содержимое условных комментариев Internet Explorer (condcoms) также будет передано этому методу, поэтому для `<!--[if IE 9]>IE9-specific content<![endif]-->` этот метод получит `'[if IE 9]>IE9-specific content<![endif]'`.137138#### `HTMLParser.handle_decl(decl)`139140Этот метод вызывается для обработки объявления типа документа HTML (например, `<!DOCTYPE html>`).141142Параметр *decl* будет содержать всё содержимое объявления внутри разметки `<!...>` (например, `'DOCTYPE html'`).143144#### `HTMLParser.handle_pi(data)`145146Метод, вызываемый при обнаружении инструкции обработки. Параметр *data* будет содержать всю инструкцию обработки. Например, для инструкции обработки `<?proc color='red'>` этот метод будет вызван как `handle_pi("proc color='red'")`. Он предназначен для переопределения в производном классе; реализация базового класса ничего не делает.147148> **Примечание**149>150> Класс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) использует синтаксические правила SGML для инструкций обработки. Инструкция обработки XHTML с завершающим `'?'` приведёт к тому, что `'?'` будет включено в *data*.151152#### `HTMLParser.unknown_decl(data)`153154Этот метод вызывается, когда парсер считывает нераспознанное объявление.155156Параметр *data* будет содержать всё содержимое объявления внутри разметки `<![...]>`. Иногда его полезно переопределять в производном классе. Реализация базового класса ничего не делает.157158## Примеры159160Следующий класс реализует парсер, который будет использоваться для иллюстрации дополнительных примеров:161162```python163from html.parser import HTMLParser164from html.entities import name2codepoint165166class MyHTMLParser(HTMLParser):167    def handle_starttag(self, tag, attrs):168        print("Start tag:", tag)169        for attr in attrs:170            print("     attr:", attr)171172    def handle_endtag(self, tag):173        print("End tag  :", tag)174175    def handle_data(self, data):176        print("Data     :", data)177178    def handle_comment(self, data):179        print("Comment  :", data)180181    def handle_entityref(self, name):182        c = chr(name2codepoint[name])183        print("Named ent:", c)184185    def handle_charref(self, name):186        if name.startswith('x'):187            c = chr(int(name[1:], 16))188        else:189            c = chr(int(name))190        print("Num ent  :", c)191192    def handle_decl(self, data):193        print("Decl     :", data)194195parser = MyHTMLParser()196```197198Разбор объявления типа документа:199200```python201>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '202...             '"http://www.w3.org/TR/html4/strict.dtd">')203Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"204```205206Разбор элемента с несколькими атрибутами и заголовком:207208```python209>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')210Start tag: img211     attr: ('src', 'python-logo.png')212     attr: ('alt', 'The Python logo')213>>>214>>> parser.feed('<h1>Python</h1>')215Start tag: h1216Data     : Python217End tag  : h1218```219220Содержимое элементов, таких как `script` и `style`, возвращается как есть, без дальнейшего разбора:221222```python223>>> parser.feed('<style type="text/css">#python { color: green }</style>')224Start tag: style225     attr: ('type', 'text/css')226Data     : #python { color: green }227End tag  : style228229>>> parser.feed('<script type="text/javascript">'230...             'alert("<strong>hello! &#9786;</strong>");</script>')231Start tag: script232     attr: ('type', 'text/javascript')233Data     : alert("<strong>hello! &#9786;</strong>");234End tag  : script235```236237Разбор комментариев:238239```python240>>> parser.feed('<!-- a comment -->'241...             '<!--[if IE 9]>IE-specific content<![endif]-->')242Comment  :  a comment243Comment  : [if IE 9]>IE-specific content<![endif]244```245246Разбор именованных и числовых символьных ссылок и преобразование их в соответствующий символ (примечание: эти три ссылки эквивалентны `'>'`):247248```python249>>> parser.feed('&gt;&#62;&#x3E;')250Named ent: >251Num ent  : >252Num ent  : >253```254255Передача неполных фрагментов в [`feed()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.feed) работает, но [`handle_data()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.handle_data) может быть вызван более одного раза, если *convert\_charrefs* равен false:256257```python258>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:259...     parser.feed(chunk)260...261Start tag: span262Data     : buff263Data     : ered264Data     : text265End tag  : span266```267268Разбор некорректного HTML (например, атрибуты без кавычек) также работает:269270```python271>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')272Start tag: p273Start tag: a274     attr: ('class', 'link')275     attr: ('href', '#main')276Data     : tag soup277End tag  : p278End tag  : a279```280