`html.parser.md`

275 строк · 17.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.2/library/html.parser.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 19.2. [`html.parser`](https://python-all.ru/3.2/library/html.parser.html#module-html.parser) – Простой парсер HTML и XHTML89**Исходный код:** [Lib/html/parser.py](https://python-all.ru/src/3.2/Lib/html/parser.py)1011---1213Этот модуль определяет класс [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser), который служит основой для разбора текстовых файлов в формате HTML (язык гипертекстовой разметки) и XHTML.1415#### `class html.parser.HTMLParser(strict=True)`1617Создаёт экземпляр парсера. Если *strict* равно `True` (по умолчанию), невалидный HTML приводит к [`HTMLParseError`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParseError) исключениям [\[1\]](https://python-all.ru/3.2/library/html.parser.html#id2). Если *strict* равно `False`, парсер использует эвристику, чтобы наилучшим образом угадать намерение любого невалидного HTML, с которым сталкивается, подобно тому, как это делают большинство браузеров. Рекомендуется использовать `strict=False`.1819Экземпляр [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) получает HTML-данные и вызывает методы-обработчики при обнаружении открывающих тегов, закрывающих тегов, текста, комментариев и других элементов разметки. Чтобы реализовать желаемое поведение, следует создать подкласс [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) и переопределить его методы.2021Этот парсер не проверяет, соответствуют ли закрывающие теги открывающим, и не вызывает обработчик закрывающего тега для элементов, которые неявно закрываются при закрытии внешнего элемента.2223Изменено в версии 3.2: добавлено ключевое слово *strict*2425Также определено исключение:2627#### `exception html.parser.HTMLParseError`2829Исключение, возбуждаемое классом [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser), когда он обнаруживает ошибку при разборе и *strict* равен `True`. Это исключение предоставляет три атрибута: `msg` – краткое сообщение, объясняющее ошибку; `lineno` – номер строки, в которой обнаружен некорректный элемент; `offset` – количество символов от начала строки, где начинается этот элемент.3031## 19.2.1. Пример приложения парсера HTML3233В качестве простого примера ниже приведён парсер HTML, использующий класс [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) для вывода открывающих тегов, закрывающих тегов и данных по мере их обнаружения:3435```python36from html.parser import HTMLParser3738class MyHTMLParser(HTMLParser):39    def handle_starttag(self, tag, attrs):40        print("Encountered a start tag:", tag)41    def handle_endtag(self, tag):42        print("Encountered an end tag :", tag)43    def handle_data(self, data):44        print("Encountered some data  :", data)4546parser = MyHTMLParser(strict=False)47parser.feed('<html><head><title>Test</title></head>'48            '<body><h1>Parse me!</h1></body></html>')49```5051Результат будет таким:5253```python54Encountered a start tag: html55Encountered a start tag: head56Encountered a start tag: title57Encountered some data  : Test58Encountered an end tag : title59Encountered an end tag : head60Encountered a start tag: body61Encountered a start tag: h162Encountered some data  : Parse me!63Encountered an end tag : h164Encountered an end tag : body65Encountered an end tag : html66```6768## 19.2.2. [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) Методы6970Экземпляры [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) имеют следующие методы:7172#### `HTMLParser.feed(data)`7374Передаёт парсеру текст. Он обрабатывается, пока состоит из завершённых элементов; неполные данные буферизуются до тех пор, пока не будут переданы новые данные или не будет вызван метод [`close()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.close). *data* должен иметь тип [`str`](https://python-all.ru/3.2/library/functions.html#str).7576#### `HTMLParser.close()`7778Принудительно обрабатывает все буферизованные данные так, как если бы за ними следовал маркер конца файла. Этот метод может быть переопределён в производном классе для добавления обработки в конце входных данных, но переопределённая версия всегда должна вызывать метод базового класса [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) – [`close()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.close).7980#### `HTMLParser.reset()`8182Сбрасывает экземпляр. Теряет все необработанные данные. Вызывается неявно при создании экземпляра.8384#### `HTMLParser.getpos()`8586Возвращает номер текущей строки и смещение.8788#### `HTMLParser.get_starttag_text()`8990Возвращает текст самого последнего открытого начального тега. Обычно это не требуется для структурированной обработки, но может пригодиться при работе с HTML «как есть» или при повторной генерации входных данных с минимальными изменениями (пробелы между атрибутами можно сохранить и т.д.).9192Следующие методы вызываются при обнаружении данных или элементов разметки, и их предполагается переопределять в подклассе. Реализации базового класса ничего не делают (за исключением [`handle_startendtag()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.handle_startendtag)):9394#### `HTMLParser.handle_starttag(tag, attrs)`9596Этот метод вызывается для обработки открывающего тега (например, `<div id="main">`).9798Аргумент *tag* – это имя тега, приведённое к нижнему регистру. Аргумент *attrs* – это список пар `(name, value)`, содержащих атрибуты, найденные внутри `<>` скобок тега. *name* будет преобразован в нижний регистр, кавычки в *value* удаляются, а символьные и сущностные ссылки заменяются.99100Например, для тега `<A HREF="http://www.cwi.nl/">` этот метод был бы вызван как `handle_starttag('a', [('href', 'http://www.cwi.nl/')])`.101102Все ссылки на сущности из [`html.entities`](https://python-all.ru/3.2/library/html.entities.html#module-html.entities) заменяются в значениях атрибутов.103104#### `HTMLParser.handle_endtag(tag)`105106Этот метод вызывается для обработки закрывающего тега элемента (например, `</div>`).107108Аргумент *tag* – это имя тега, приведённое к нижнему регистру.109110#### `HTMLParser.handle_startendtag(tag, attrs)`111112Аналогичен [`handle_starttag()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.handle_starttag), но вызывается, когда парсер встречает пустой тег в стиле XHTML (`<img ... />`). Этот метод может быть переопределён подклассами, которым требуется эта лексическая информация; реализация по умолчанию просто вызывает [`handle_starttag()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.handle_starttag) и [`handle_endtag()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.handle_endtag).113114#### `HTMLParser.handle_data(data)`115116Этот метод вызывается для обработки произвольных данных (например, текстовых узлов и содержимого `<script>...</script>` и `<style>...</style>`).117118#### `HTMLParser.handle_entityref(name)`119120Этот метод вызывается для обработки именованной символьной ссылки вида `&name;` (например, `&gt;`), где *name* – это общая ссылка на сущность (например, `'gt'`).121122#### `HTMLParser.handle_charref(name)`123124Этот метод вызывается для обработки десятичных и шестнадцатеричных числовых символьных ссылок вида `&#NNN;` и `&#xNNN;`. Например, десятичный эквивалент для `&gt;` – `&#62;`, а шестнадцатеричный – `&#x3E;`; в этом случае метод получит `'62'` или `'x3E'`.125126#### `HTMLParser.handle_comment(data)`127128Этот метод вызывается, когда встречается комментарий (например, `<!--comment-->`).129130Например, комментарий `<!-- comment -->` приведёт к вызову этого метода с аргументом `' comment '`.131132Содержимое условных комментариев Internet Explorer (condcoms) также будет передаваться этому методу, так что для `<!--[if IE 9]>IE9-specific content<![endif]-->` этот метод получит `'[if IE 9]>IE-specific content<![endif]'`.133134#### `HTMLParser.handle_decl(decl)`135136Этот метод вызывается для обработки объявления типа документа HTML (например, `<!DOCTYPE html>`).137138Параметр *decl* будет содержать всё содержимое объявления внутри разметки `<!...>` (например, `'DOCTYPE html'`).139140#### `HTMLParser.handle_pi(data)`141142Метод, вызываемый при обнаружении инструкции обработки. Параметр *data* будет содержать всю инструкцию обработки. Например, для инструкции обработки `<?proc color='red'>` этот метод будет вызван как `handle_pi("proc color='red'")`. Предназначен для переопределения в производном классе; реализация базового класса ничего не делает.143144> **Примечание**145>146> Класс [`HTMLParser`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser) использует синтаксические правила SGML для обработки инструкций. Инструкция обработки XHTML, использующая завершающий `'?'`, приведёт к включению `'?'` в *data*.147148#### `HTMLParser.unknown_decl(data)`149150Этот метод вызывается, когда парсер считывает нераспознанное объявление.151152Параметр *data* будет содержать всё содержимое объявления внутри разметки `<![...]>`. Иногда его полезно переопределять в производном классе. Реализация базового класса вызывает исключение [`HTMLParseError`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParseError), когда *strict* имеет значение `True`.153154## 19.2.3. Примеры155156Следующий класс реализует парсер, который будет использоваться для иллюстрации дополнительных примеров:157158```python159from html.parser import HTMLParser160from html.entities import name2codepoint161162class MyHTMLParser(HTMLParser):163    def handle_starttag(self, tag, attrs):164        print("Start tag:", tag)165        for attr in attrs:166            print("     attr:", attr)167    def handle_endtag(self, tag):168        print("End tag  :", tag)169    def handle_data(self, data):170        print("Data     :", data)171    def handle_comment(self, data):172        print("Comment  :", data)173    def handle_entityref(self, name):174        c = chr(name2codepoint[name])175        print("Named ent:", c)176    def handle_charref(self, name):177        if name.startswith('x'):178            c = chr(int(name[1:], 16))179        else:180            c = chr(int(name))181        print("Num ent  :", c)182    def handle_decl(self, data):183        print("Decl     :", data)184185parser = MyHTMLParser(strict=False)186```187188Разбор объявления типа документа:189190```python191>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '192...             '"http://www.w3.org/TR/html4/strict.dtd">')193Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"194```195196Разбор элемента с несколькими атрибутами и заголовком:197198```python199>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')200Start tag: img201     attr: ('src', 'python-logo.png')202     attr: ('alt', 'The Python logo')203>>>204>>> parser.feed('<h1>Python</h1>')205Start tag: h1206Data     : Python207End tag  : h1208```209210Содержимое элементов `script` и `style` возвращается как есть, без дальнейшего разбора:211212```python213>>> parser.feed('<style type="text/css">#python { color: green }</style>')214Start tag: style215     attr: ('type', 'text/css')216Data     : #python { color: green }217End tag  : style218>>>219>>> parser.feed('<script type="text/javascript">'220...             'alert("<strong>hello!</strong>");</script>')221Start tag: script222     attr: ('type', 'text/javascript')223Data     : alert("<strong>hello!</strong>");224End tag  : script225```226227Разбор комментариев:228229```python230>>> parser.feed('<!-- a comment -->'231...             '<!--[if IE 9]>IE-specific content<![endif]-->')232Comment  :  a comment233Comment  : [if IE 9]>IE-specific content<![endif]234```235236Разбор именованных и числовых символьных ссылок и преобразование их в соответствующий символ (примечание: эти три ссылки эквивалентны `'>'`):237238```python239>>> parser.feed('&gt;&#62;&#x3E;')240Named ent: >241Num ent  : >242Num ent  : >243```244245Передача неполных фрагментов в [`feed()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.feed) работает, но [`handle_data()`](https://python-all.ru/3.2/library/html.parser.html#html.parser.HTMLParser.handle_data) может вызываться более одного раза:246247```python248>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:249...     parser.feed(chunk)250...251Start tag: span252Data     : buff253Data     : ered254Data     : text255End tag  : span256```257258Разбор некорректного HTML (например, атрибуты без кавычек) также работает:259260```python261>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')262Start tag: p263Start tag: a264     attr: ('class', 'link')265     attr: ('href', '#main')266Data     : tag soup267End tag  : p268End tag  : a269```270271Сноски272273| [\[1\]](https://python-all.ru/3.2/library/html.parser.html#id1) | По причинам обратной совместимости режим *strict* не вызывает исключений для всего несоответствующего HTML. То есть некоторый некорректный HTML допускается даже в режиме *strict*. |274| --- | --- |275