> **Источник:** https://python-all.ru/3.10/library/html.parser.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# [`html.parser`](https://python-all.ru/3.10/library/html.parser.html#module-html.parser) – Простой парсер HTML и XHTML

**Исходный код:** [Lib/html/parser.py](https://python-all.ru/src/3.10/Lib/html/parser.py)

---

Этот модуль определяет класс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser), который служит основой для разбора текстовых файлов в форматах HTML (HyperText Mark-up Language) и XHTML.

#### `class html.parser.HTMLParser(*, convert_charrefs=True, scripting=False)`

Создаёт экземпляр парсера, способный разбирать некорректную разметку.

Если *convert\_charrefs* равно true (по умолчанию), все символьные ссылки (кроме тех, что внутри элементов `script` и `style`) автоматически преобразуются в соответствующие символы Unicode.

Если *scripting* равно false (по умолчанию), содержимое элемента `noscript` разбирается как обычно; если true, оно возвращается как есть без разбора.

Экземпляр [`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) и переопределить его методы для реализации нужного поведения.

Этот парсер не проверяет, соответствуют ли закрывающие теги открывающим, и не вызывает обработчик закрывающего тега для элементов, которые неявно закрываются при закрытии внешнего элемента.

Изменено в версии 3.4: Добавлен аргумент *convert\_charrefs*.

Изменено в версии 3.5: Значением по умолчанию для аргумента *convert\_charrefs* теперь является `True`.

Изменено в версии 3.10.20: Добавлен параметр *scripting*.

## Пример приложения парсера HTML

В качестве простого примера ниже показан парсер HTML, использующий класс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) для вывода открывающих тегов, закрывающих тегов и данных по мере их обнаружения:

```python
from html.parser import HTMLParser

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Encountered a start tag:", tag)

    def handle_endtag(self, tag):
        print("Encountered an end tag :", tag)

    def handle_data(self, data):
        print("Encountered some data  :", data)

parser = MyHTMLParser()
parser.feed('<html><head><title>Test</title></head>'
            '<body><h1>Parse me!</h1></body></html>')
```

Результат будет таким:

```text
Encountered a start tag: html
Encountered a start tag: head
Encountered a start tag: title
Encountered some data  : Test
Encountered an end tag : title
Encountered an end tag : head
Encountered a start tag: body
Encountered a start tag: h1
Encountered some data  : Parse me!
Encountered an end tag : h1
Encountered an end tag : body
Encountered an end tag : html
```

## [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) Методы

Экземпляры [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) имеют следующие методы:

#### `HTMLParser.feed(data)`

Передаёт текст парсеру. Текст обрабатывается постольку, поскольку состоит из полных элементов; неполные данные буферизуются до тех пор, пока не будут переданы новые данные или не будет вызван [`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).

#### `HTMLParser.close()`

Принудительно обрабатывает все буферизованные данные так, как если бы за ними следовал маркер конца файла. Этот метод может быть переопределён в производном классе для дополнительной обработки в конце входных данных, но переопределённая версия всегда должна вызывать метод [`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).

#### `HTMLParser.reset()`

Сбрасывает экземпляр. Теряет все необработанные данные. Вызывается неявно при создании экземпляра.

#### `HTMLParser.getpos()`

Возвращает номер текущей строки и смещение.

#### `HTMLParser.get_starttag_text()`

Возвращает текст самого последнего открытого начального тега. Обычно это не требуется для структурированной обработки, но может пригодиться при работе с HTML «как есть» или при повторной генерации входных данных с минимальными изменениями (пробелы между атрибутами можно сохранить и т.д.).

Следующие методы вызываются при обнаружении данных или элементов разметки, и их предполагается переопределять в подклассе. Реализации базового класса ничего не делают (кроме [`handle_startendtag()`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser.handle_startendtag)):

#### `HTMLParser.handle_starttag(tag, attrs)`

Этот метод вызывается для обработки открывающего тега элемента (например, `<div id="main">`).

Аргумент *tag* – это имя тега, приведённое к нижнему регистру. Аргумент *attrs* – это список пар `(name, value)`, содержащих атрибуты, найденные внутри угловых скобок тега `<>`. Имя *name* будет приведено к нижнему регистру, кавычки в значении *value* удалены, а символьные и сущностные ссылки заменены.

Например, для тега `<A HREF="https://www.cwi.nl/">` этот метод будет вызван как `handle_starttag('a', [('href', 'https://www.cwi.nl/')])`.

Все ссылки на сущности из [`html.entities`](https://python-all.ru/3.10/library/html.entities.html#module-html.entities) заменяются в значениях атрибутов.

#### `HTMLParser.handle_endtag(tag)`

Этот метод вызывается для обработки закрывающего тега элемента (например, `</div>`).

Аргумент *tag* – это имя тега, приведённое к нижнему регистру.

#### `HTMLParser.handle_startendtag(tag, attrs)`

Аналогично [`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).

#### `HTMLParser.handle_data(data)`

Этот метод вызывается для обработки произвольных данных (например, текстовых узлов и содержимого элементов, таких как `script` и `style`).

#### `HTMLParser.handle_entityref(name)`

Этот метод вызывается для обработки именованной символьной ссылки вида `&name;` (например, `&gt;`), где *name* – это ссылка на общую сущность (например, `'gt'`). Этот метод вызывается только если *convert\_charrefs* имеет значение false.

#### `HTMLParser.handle_charref(name)`

Этот метод вызывается для обработки десятичных и шестнадцатеричных числовых символьных ссылок вида `&#NNN;` и `&#xNNN;`. Например, десятичный эквивалент для `&gt;` – это `&#62;`, а шестнадцатеричный – `&#x3E;`; в этом случае метод получит `'62'` или `'x3E'`. Этот метод вызывается только если *convert\_charrefs* имеет значение false.

#### `HTMLParser.handle_comment(data)`

Этот метод вызывается, когда встречается комментарий (например, `<!--comment-->`).

Например, комментарий `<!-- comment -->` приведёт к вызову этого метода с аргументом `' comment '`.

Содержимое условных комментариев Internet Explorer (condcoms) также будет передано этому методу, поэтому для `<!--[if IE 9]>IE9-specific content<![endif]-->` этот метод получит `'[if IE 9]>IE9-specific content<![endif]'`.

#### `HTMLParser.handle_decl(decl)`

Этот метод вызывается для обработки объявления типа документа HTML (например, `<!DOCTYPE html>`).

Параметр *decl* будет содержать всё содержимое объявления внутри разметки `<!...>` (например, `'DOCTYPE html'`).

#### `HTMLParser.handle_pi(data)`

Метод, вызываемый при обнаружении инструкции обработки. Параметр *data* будет содержать всю инструкцию обработки. Например, для инструкции обработки `<?proc color='red'>` этот метод будет вызван как `handle_pi("proc color='red'")`. Он предназначен для переопределения в производном классе; реализация базового класса ничего не делает.

> **Примечание**
>
> Класс [`HTMLParser`](https://python-all.ru/3.10/library/html.parser.html#html.parser.HTMLParser) использует синтаксические правила SGML для инструкций обработки. Инструкция обработки XHTML с завершающим `'?'` приведёт к тому, что `'?'` будет включено в *data*.

#### `HTMLParser.unknown_decl(data)`

Этот метод вызывается, когда парсер считывает нераспознанное объявление.

Параметр *data* будет содержать всё содержимое объявления внутри разметки `<![...]>`. Иногда его полезно переопределять в производном классе. Реализация базового класса ничего не делает.

## Примеры

Следующий класс реализует парсер, который будет использоваться для иллюстрации дополнительных примеров:

```python
from html.parser import HTMLParser
from html.entities import name2codepoint

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Start tag:", tag)
        for attr in attrs:
            print("     attr:", attr)

    def handle_endtag(self, tag):
        print("End tag  :", tag)

    def handle_data(self, data):
        print("Data     :", data)

    def handle_comment(self, data):
        print("Comment  :", data)

    def handle_entityref(self, name):
        c = chr(name2codepoint[name])
        print("Named ent:", c)

    def handle_charref(self, name):
        if name.startswith('x'):
            c = chr(int(name[1:], 16))
        else:
            c = chr(int(name))
        print("Num ent  :", c)

    def handle_decl(self, data):
        print("Decl     :", data)

parser = MyHTMLParser()
```

Разбор объявления типа документа:

```python
>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '
...             '"http://www.w3.org/TR/html4/strict.dtd">')
Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"
```

Разбор элемента с несколькими атрибутами и заголовком:

```python
>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
Start tag: img
     attr: ('src', 'python-logo.png')
     attr: ('alt', 'The Python logo')
>>>
>>> parser.feed('<h1>Python</h1>')
Start tag: h1
Data     : Python
End tag  : h1
```

Содержимое элементов, таких как `script` и `style`, возвращается как есть, без дальнейшего разбора:

```python
>>> parser.feed('<style type="text/css">#python { color: green }</style>')
Start tag: style
     attr: ('type', 'text/css')
Data     : #python { color: green }
End tag  : style

>>> parser.feed('<script type="text/javascript">'
...             'alert("<strong>hello! &#9786;</strong>");</script>')
Start tag: script
     attr: ('type', 'text/javascript')
Data     : alert("<strong>hello! &#9786;</strong>");
End tag  : script
```

Разбор комментариев:

```python
>>> parser.feed('<!-- a comment -->'
...             '<!--[if IE 9]>IE-specific content<![endif]-->')
Comment  :  a comment
Comment  : [if IE 9]>IE-specific content<![endif]
```

Разбор именованных и числовых символьных ссылок и преобразование их в соответствующий символ (примечание: эти три ссылки эквивалентны `'>'`):

```python
>>> parser.feed('&gt;&#62;&#x3E;')
Named ent: >
Num ent  : >
Num ent  : >
```

Передача неполных фрагментов в [`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:

```python
>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:
...     parser.feed(chunk)
...
Start tag: span
Data     : buff
Data     : ered
Data     : text
End tag  : span
```

Разбор некорректного HTML (например, атрибуты без кавычек) также работает:

```python
>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
Start tag: p
Start tag: a
     attr: ('class', 'link')
     attr: ('href', '#main')
Data     : tag soup
End tag  : p
End tag  : a
```
