`html.parser.md`

279 строк · 18.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/library/html.parser.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 20.2. [`html.parser`](https://python-all.ru/3.3/library/html.parser.html#module-html.parser) – Простой парсер HTML и XHTML89**Исходный код:** [Lib/html/parser.py](https://python-all.ru/src/3.3/Lib/html/parser.py)1011---1213Этот модуль определяет класс [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser), который служит основой для разбора текстовых файлов в формате HTML (язык гипертекстовой разметки) и XHTML.1415#### `class html.parser.HTMLParser(strict=False)`1617Создаёт экземпляр парсера. Если *strict* равно `False` (по умолчанию), парсер принимает и разбирает некорректную разметку. Если *strict* равно `True`, парсер возбуждает исключение [`HTMLParseError`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParseError) вместо [\[1\]](https://python-all.ru/3.3/library/html.parser.html#id2), когда не может разобрать разметку. Использование `strict=True` не рекомендуется, а аргумент *strict* устарел.1819Экземпляр [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser) получает HTML-данные и вызывает методы-обработчики при обнаружении открывающих тегов, закрывающих тегов, текста, комментариев и других элементов разметки. Чтобы реализовать желаемое поведение, следует создать подкласс [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser) и переопределить его методы.2021Этот парсер не проверяет, соответствуют ли закрывающие теги открывающим, и не вызывает обработчик закрывающего тега для элементов, которые неявно закрываются при закрытии внешнего элемента.2223Изменено в версии 3.2: добавлен ключевой аргумент *strict*.2425Устарело с версии 3.3, будет удалено в версии 3.5: Аргумент *strict* и строгий режим устарели. Теперь парсер также способен принимать и разбирать некорректную разметку.2627Также определено исключение:2829#### `exception html.parser.HTMLParseError`3031Исключение, возбуждаемое классом [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser), когда он обнаруживает ошибку при разборе и *strict* равен `True`. Это исключение предоставляет три атрибута: `msg` – краткое сообщение, объясняющее ошибку; `lineno` – номер строки, в которой обнаружен некорректный элемент; `offset` – количество символов от начала строки, где начинается этот элемент.3233Устарело с версии 3.3, будет удалено в версии 3.5: Это исключение было объявлено устаревшим, поскольку оно никогда не возбуждается парсером (при использовании режима нестрогого разбора по умолчанию).3435## 20.2.1. Пример приложения парсера HTML3637В качестве простого примера ниже приведён парсер HTML, использующий класс [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser) для вывода открывающих тегов, закрывающих тегов и данных по мере их обнаружения:3839```python40from html.parser import HTMLParser4142class MyHTMLParser(HTMLParser):43    def handle_starttag(self, tag, attrs):44        print("Encountered a start tag:", tag)45    def handle_endtag(self, tag):46        print("Encountered an end tag :", tag)47    def handle_data(self, data):48        print("Encountered some data  :", data)4950parser = MyHTMLParser(strict=False)51parser.feed('<html><head><title>Test</title></head>'52            '<body><h1>Parse me!</h1></body></html>')53```5455Результат будет таким:5657```python58Encountered 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## 20.2.2. Методы [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser)7374Экземпляры [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser) имеют следующие методы:7576#### `HTMLParser.feed(data)`7778Передаёт парсеру текст. Он обрабатывается, пока состоит из завершённых элементов; неполные данные буферизуются до тех пор, пока не будут переданы новые данные или не будет вызван метод [`close()`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser.close). *data* должен иметь тип [`str`](https://python-all.ru/3.3/library/stdtypes.html#str).7980#### `HTMLParser.close()`8182Принудительно обрабатывает все буферизованные данные так, как если бы за ними следовал маркер конца файла. Этот метод может быть переопределён в производном классе для добавления обработки в конце входных данных, но переопределённая версия всегда должна вызывать метод базового класса [`HTMLParser`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser) – [`close()`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser.close).8384#### `HTMLParser.reset()`8586Сбрасывает экземпляр. Теряет все необработанные данные. Вызывается неявно при создании экземпляра.8788#### `HTMLParser.getpos()`8990Возвращает номер текущей строки и смещение.9192#### `HTMLParser.get_starttag_text()`9394Возвращает текст самого последнего открытого начального тега. Обычно это не требуется для структурированной обработки, но может пригодиться при работе с HTML «как есть» или при повторной генерации входных данных с минимальными изменениями (пробелы между атрибутами можно сохранить и т.д.).9596Следующие методы вызываются при обнаружении данных или элементов разметки, и их предполагается переопределять в подклассе. Реализации базового класса ничего не делают (за исключением [`handle_startendtag()`](https://python-all.ru/3.3/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="http://www.cwi.nl/">` этот метод был бы вызван как `handle_starttag('a', [('href', 'http://www.cwi.nl/')])`.105106Все ссылки на сущности из [`html.entities`](https://python-all.ru/3.3/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.3/library/html.parser.html#html.parser.HTMLParser.handle_starttag), но вызывается, когда парсер встречает пустой тег в стиле XHTML (`<img ... />`). Этот метод может быть переопределён подклассами, которым требуется эта лексическая информация; реализация по умолчанию просто вызывает [`handle_starttag()`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser.handle_starttag) и [`handle_endtag()`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser.handle_endtag).117118#### `HTMLParser.handle_data(data)`119120Этот метод вызывается для обработки произвольных данных (например, текстовых узлов и содержимого `<script>...</script>` и `<style>...</style>`).121122#### `HTMLParser.handle_entityref(name)`123124Этот метод вызывается для обработки именованной символьной ссылки вида `&name;` (например, `&gt;`), где *name* – это общая ссылка на сущность (например, `'gt'`).125126#### `HTMLParser.handle_charref(name)`127128Этот метод вызывается для обработки десятичных и шестнадцатеричных числовых символьных ссылок вида `&#NNN;` и `&#xNNN;`. Например, десятичный эквивалент для `&gt;` – `&#62;`, а шестнадцатеричный – `&#x3E;`; в этом случае метод получит `'62'` или `'x3E'`.129130#### `HTMLParser.handle_comment(data)`131132Этот метод вызывается, когда встречается комментарий (например, `<!--comment-->`).133134Например, комментарий `<!-- comment -->` приведёт к вызову этого метода с аргументом `' comment '`.135136Содержимое условных комментариев Internet Explorer (condcoms) также будет передаваться этому методу, так что для `<!--[if IE 9]>IE9-specific content<![endif]-->` этот метод получит `'[if IE 9]>IE-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.3/library/html.parser.html#html.parser.HTMLParser) использует синтаксические правила SGML для обработки инструкций. Инструкция обработки XHTML, использующая завершающий `'?'`, приведёт к включению `'?'` в *data*.151152#### `HTMLParser.unknown_decl(data)`153154Этот метод вызывается, когда парсер считывает нераспознанное объявление.155156Параметр *data* будет содержать всё содержимое объявления внутри разметки `<![...]>`. Иногда его полезно переопределять в производном классе. Реализация базового класса вызывает исключение [`HTMLParseError`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParseError), когда *strict* имеет значение `True`.157158## 20.2.3. Примеры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)171    def handle_endtag(self, tag):172        print("End tag  :", tag)173    def handle_data(self, data):174        print("Data     :", data)175    def handle_comment(self, data):176        print("Comment  :", data)177    def handle_entityref(self, name):178        c = chr(name2codepoint[name])179        print("Named ent:", c)180    def handle_charref(self, name):181        if name.startswith('x'):182            c = chr(int(name[1:], 16))183        else:184            c = chr(int(name))185        print("Num ent  :", c)186    def handle_decl(self, data):187        print("Decl     :", data)188189parser = MyHTMLParser(strict=False)190```191192Разбор объявления типа документа:193194```python195>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '196...             '"http://www.w3.org/TR/html4/strict.dtd">')197Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"198```199200Разбор элемента с несколькими атрибутами и заголовком:201202```python203>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')204Start tag: img205     attr: ('src', 'python-logo.png')206     attr: ('alt', 'The Python logo')207>>>208>>> parser.feed('<h1>Python</h1>')209Start tag: h1210Data     : Python211End tag  : h1212```213214Содержимое элементов `script` и `style` возвращается как есть, без дальнейшего разбора:215216```python217>>> parser.feed('<style type="text/css">#python { color: green }</style>')218Start tag: style219     attr: ('type', 'text/css')220Data     : #python { color: green }221End tag  : style222>>>223>>> parser.feed('<script type="text/javascript">'224...             'alert("<strong>hello!</strong>");</script>')225Start tag: script226     attr: ('type', 'text/javascript')227Data     : alert("<strong>hello!</strong>");228End tag  : script229```230231Разбор комментариев:232233```python234>>> parser.feed('<!-- a comment -->'235...             '<!--[if IE 9]>IE-specific content<![endif]-->')236Comment  :  a comment237Comment  : [if IE 9]>IE-specific content<![endif]238```239240Разбор именованных и числовых символьных ссылок и преобразование их в соответствующий символ (примечание: эти три ссылки эквивалентны `'>'`):241242```python243>>> parser.feed('&gt;&#62;&#x3E;')244Named ent: >245Num ent  : >246Num ent  : >247```248249Передача неполных фрагментов в [`feed()`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser.feed) работает, но [`handle_data()`](https://python-all.ru/3.3/library/html.parser.html#html.parser.HTMLParser.handle_data) может вызываться более одного раза:250251```python252>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:253...     parser.feed(chunk)254...255Start tag: span256Data     : buff257Data     : ered258Data     : text259End tag  : span260```261262Разбор некорректного HTML (например, атрибуты без кавычек) также работает:263264```python265>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')266Start tag: p267Start tag: a268     attr: ('class', 'link')269     attr: ('href', '#main')270Data     : tag soup271End tag  : p272End tag  : a273```274275Сноски276277| [\[1\]](https://python-all.ru/3.3/library/html.parser.html#id1) | По причинам обратной совместимости режим *strict* не вызывает исключений для всего несоответствующего HTML. То есть некоторый некорректный HTML допускается даже в режиме *strict*. |278| --- | --- |279