asynchat.md
1> **Источник:** https://python-all.ru/3.5/library/asynchat.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.7. [`asynchat`](https://python-all.ru/3.5/library/asynchat.html#module-asynchat) – асинхронный обработчик команд/ответов сокетов89**Исходный код:** [Lib/asynchat.py](https://python-all.ru/src/3.5/Lib/asynchat.py)1011---1213> **Примечание**14>15> Этот модуль существует только для обратной совместимости. Для нового кода рекомендуется использовать [`asyncio`](https://python-all.ru/3.5/library/asyncio.html#module-asyncio).1617Этот модуль построен на основе инфраструктуры [`asyncore`](https://python-all.ru/3.5/library/asyncore.html#module-asyncore), упрощая реализацию асинхронных клиентов и серверов, а также обработку протоколов, элементы которых завершаются произвольными строками или имеют переменную длину. [`asynchat`](https://python-all.ru/3.5/library/asynchat.html#module-asynchat) определяет абстрактный класс [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat), который нужно наследовать, реализуя методы `collect_incoming_data()` и `found_terminator()`. Он использует тот же асинхронный цикл, что и [`asyncore`](https://python-all.ru/3.5/library/asyncore.html#module-asyncore), и два типа каналов – [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) и [`asynchat.async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat) – могут свободно сочетаться в карте каналов. Обычно серверный канал [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) создаёт новые объекты канала [`asynchat.async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat) при получении входящих запросов на соединение.1819#### `class asynchat.async_chat`2021Этот класс является абстрактным подклассом [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher). Чтобы использовать его на практике, необходимо наследовать [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat), реализовав осмысленные методы [`collect_incoming_data()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.collect_incoming_data) и [`found_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.found_terminator). Методы [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) можно использовать, хотя не все из них имеют смысл в контексте сообщений/ответов.2223Как и [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher), [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat) определяет набор событий, порождаемых анализом состояния сокета после вызова `select()`. Как только цикл опроса запущен, методы объекта [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat) вызываются каркасом обработки событий без каких-либо действий со стороны программиста.2425Два атрибута класса можно изменять для повышения производительности или, возможно, даже для экономии памяти.2627#### `ac_in_buffer_size`2829Размер асинхронного входного буфера (по умолчанию `4096`).3031#### `ac_out_buffer_size`3233Размер асинхронного выходного буфера (по умолчанию `4096`).3435В отличие от [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher), [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat) позволяет определить очередь типа FIFO (первым вошёл – первым вышел) из *производителей*. Производителю нужно иметь лишь один метод, `more()`, который должен возвращать данные для передачи по каналу. Производитель сигнализирует об исчерпании данных (*т.е.* что у него больше нет данных) путём возврата из метода `more()` пустого объекта bytes. В этот момент объект [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat) удаляет производителя из очереди и начинает использовать следующего производителя, если таковой имеется. Когда очередь производителей пуста, `handle_write()` метод ничего не делает. Вы используете объекта канала [`set_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.set_terminator) метод для описания того, как распознавать конец или важную точку останова во входящей передаче от удалённой стороны.3637Чтобы создать работоспособный подкласс [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat), ваши входные методы [`collect_incoming_data()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.collect_incoming_data) и [`found_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.found_terminator) должны обрабатывать данные, которые канал получает асинхронно. Методы описаны ниже.3839#### `async_chat.close_when_done()`4041Помещает `None` в очередь производителей. Когда этот производитель извлекается из очереди, канал закрывается.4243#### `async_chat.collect_incoming_data(data)`4445Вызывается с параметром *data*, содержащим произвольный объём полученных данных. Метод по умолчанию (должен быть переопределён) возбуждает исключение [`NotImplementedError`](https://python-all.ru/3.5/library/exceptions.html#NotImplementedError).4647#### `async_chat.discard_buffers()`4849В экстренных случаях этот метод удаляет любые данные, находящиеся во входных и/или выходных буферах, а также в очереди производителей.5051#### `async_chat.found_terminator()`5253Вызывается, когда входящий поток данных соответствует условию завершения, заданному [`set_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.set_terminator). Метод по умолчанию (должен быть переопределён) возбуждает исключение [`NotImplementedError`](https://python-all.ru/3.5/library/exceptions.html#NotImplementedError). Буферизованные входные данные должны быть доступны через атрибут экземпляра.5455#### `async_chat.get_terminator()`5657Возвращает текущий терминатор канала.5859#### `async_chat.push(data)`6061Помещает данные в очередь канала для их передачи. Это всё, что нужно сделать, чтобы канал записал данные в сеть, хотя при желании можно использовать собственных производителей в более сложных схемах, например для реализации шифрования и разбиения на блоки.6263#### `async_chat.push_with_producer(producer)`6465Принимает объект производителя и добавляет его в очередь производителей, связанную с каналом. Когда все ранее помещённые производители будут исчерпаны, канал начнёт потреблять данные этого производителя, вызывая его метод `more()` и отправлять данные на удалённую сторону.6667#### `async_chat.set_terminator(term)`6869Устанавливает условие завершения, которое будет распознаваться на канале. `term` может быть одним из трёх типов значений, соответствующих трём различным способам обработки входящих протокольных данных.7071| терминатор | Описание |72| --- | --- |73| *строка* | Вызовет [`found_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.found_terminator), когда строка будет найдена во входном потоке данных |74| *целое* | Вызовет [`found_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.found_terminator), когда будет получено указанное количество символов |75| `None` | Канал продолжает собирать данные бесконечно |7677Обратите внимание, что любые данные после терминатора будут доступны для чтения каналом после вызова [`found_terminator()`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat.found_terminator).7879## 18.7.1. Пример asynchat8081Следующий неполный пример показывает, как HTTP-запросы можно читать с помощью [`async_chat`](https://python-all.ru/3.5/library/asynchat.html#asynchat.async_chat). Веб-сервер может создавать объект `http_request_handler` для каждого входящего подключения клиента. Обратите внимание, что изначально терминатор канала устанавливается на пустую строку в конце HTTP-заголовков, а флаг указывает, что заголовки читаются.8283После чтения заголовков, если запрос имеет тип POST (что указывает на наличие дополнительных данных во входном потоке), то заголовок `Content-Length:` используется для установки числового терминатора для чтения нужного количества данных из канала.8485Метод `handle_request()` вызывается после того, как все соответствующие входные данные были маршализированы, после установки терминатора канала на `None`, чтобы любые посторонние данные, отправленные веб-клиентом, игнорировались.8687```python88import asynchat8990class http_request_handler(asynchat.async_chat):9192 def __init__(self, sock, addr, sessions, log):93 asynchat.async_chat.__init__(self, sock=sock)94 self.addr = addr95 self.sessions = sessions96 self.ibuffer = []97 self.obuffer = b""98 self.set_terminator(b"\r\n\r\n")99 self.reading_headers = True100 self.handling = False101 self.cgi_data = None102 self.log = log103104 def collect_incoming_data(self, data):105 """Буферизировать данные"""106 self.ibuffer.append(data)107108 def found_terminator(self):109 if self.reading_headers:110 self.reading_headers = False111 self.parse_headers(b"".join(self.ibuffer))112 self.ibuffer = []113 if self.op.upper() == b"POST":114 clen = self.headers.getheader("content-length")115 self.set_terminator(int(clen))116 else:117 self.handling = True118 self.set_terminator(None)119 self.handle_request()120 elif not self.handling:121 self.set_terminator(None) # браузеры иногда отправляют лишние данные122 self.cgi_data = parse(self.headers, b"".join(self.ibuffer))123 self.handling = True124 self.ibuffer = []125 self.handle_request()126```127