asynchat.md
1> **Источник:** https://python-all.ru/3.8/library/asynchat.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`asynchat`](https://python-all.ru/3.8/library/asynchat.html#module-asynchat) – Асинхронный обработчик команд/ответов через сокеты89**Исходный код:** [Lib/asynchat.py](https://python-all.ru/src/3.8/Lib/asynchat.py)1011Устарело с версии 3.6: Вместо этого используйте [`asyncio`](https://python-all.ru/3.8/library/asyncio.html#module-asyncio).1213---1415> **Примечание**16>17> Этот модуль существует только для обратной совместимости. Для нового кода рекомендуется использовать [`asyncio`](https://python-all.ru/3.8/library/asyncio.html#module-asyncio).1819Этот модуль построен на основе инфраструктуры [`asyncore`](https://python-all.ru/3.8/library/asyncore.html#module-asyncore), упрощая реализацию асинхронных клиентов и серверов, а также обработку протоколов, элементы которых завершаются произвольными строками или имеют переменную длину. [`asynchat`](https://python-all.ru/3.8/library/asynchat.html#module-asynchat) определяет абстрактный класс [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat), который нужно наследовать, реализуя методы `collect_incoming_data()` и `found_terminator()`. Он использует тот же асинхронный цикл, что и [`asyncore`](https://python-all.ru/3.8/library/asyncore.html#module-asyncore), и два типа каналов – [`asyncore.dispatcher`](https://python-all.ru/3.8/library/asyncore.html#asyncore.dispatcher) и [`asynchat.async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat) – могут свободно сочетаться в карте каналов. Обычно серверный канал [`asyncore.dispatcher`](https://python-all.ru/3.8/library/asyncore.html#asyncore.dispatcher) создаёт новые объекты канала [`asynchat.async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat) при получении входящих запросов на соединение.2021#### `class asynchat.async_chat`2223Этот класс является абстрактным подклассом [`asyncore.dispatcher`](https://python-all.ru/3.8/library/asyncore.html#asyncore.dispatcher). Чтобы использовать его на практике, необходимо наследовать [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat), реализовав осмысленные методы [`collect_incoming_data()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.collect_incoming_data) и [`found_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.found_terminator). Методы [`asyncore.dispatcher`](https://python-all.ru/3.8/library/asyncore.html#asyncore.dispatcher) можно использовать, хотя не все из них имеют смысл в контексте сообщений/ответов.2425Как и [`asyncore.dispatcher`](https://python-all.ru/3.8/library/asyncore.html#asyncore.dispatcher), [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat) определяет набор событий, порождаемых анализом состояния сокета после вызова `select()`. Как только цикл опроса запущен, методы объекта [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat) вызываются каркасом обработки событий без каких-либо действий со стороны программиста.2627Два атрибута класса можно изменять для повышения производительности или, возможно, даже для экономии памяти.2829#### `ac_in_buffer_size`3031Размер асинхронного входного буфера (по умолчанию `4096`).3233#### `ac_out_buffer_size`3435Размер асинхронного выходного буфера (по умолчанию `4096`).3637В отличие от [`asyncore.dispatcher`](https://python-all.ru/3.8/library/asyncore.html#asyncore.dispatcher), [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat) позволяет определить очередь FIFO из *производителей*. Производителю нужен всего один метод `more()`, который должен возвращать данные для передачи по каналу. Производитель сигнализирует об исчерпании данных (*т.е.* что у него больше нет данных), возвращая из метода `more()` пустой объект bytes. В этот момент объект [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat) удаляет производителя из очереди и начинает использовать следующего, если он есть. Когда очередь производителей пуста, метод `handle_write()` ничего не делает. Используйте метод канала [`set_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.set_terminator), чтобы задать способ распознавания конца или важной точки останова во входящей передаче от удалённой стороны.3839Чтобы создать работоспособный подкласс [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat), ваши входные методы [`collect_incoming_data()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.collect_incoming_data) и [`found_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.found_terminator) должны обрабатывать данные, которые канал получает асинхронно. Методы описаны ниже.4041#### `async_chat.close_when_done()`4243Помещает `None` в очередь производителей. Когда этот производитель извлекается из очереди, он вызывает закрытие канала.4445#### `async_chat.collect_incoming_data(data)`4647Вызывается с параметром *data*, содержащим произвольный объём полученных данных. Метод по умолчанию (должен быть переопределён) возбуждает исключение [`NotImplementedError`](https://python-all.ru/3.8/library/exceptions.html#NotImplementedError).4849#### `async_chat.discard_buffers()`5051В аварийных ситуациях этот метод сбрасывает все данные, находящиеся во входном и/или выходном буферах, а также в очереди производителей.5253#### `async_chat.found_terminator()`5455Вызывается, когда входящий поток данных соответствует условию завершения, заданному [`set_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.set_terminator). Метод по умолчанию (должен быть переопределён) возбуждает исключение [`NotImplementedError`](https://python-all.ru/3.8/library/exceptions.html#NotImplementedError). Буферизованные входные данные должны быть доступны через атрибут экземпляра.5657#### `async_chat.get_terminator()`5859Возвращает текущий терминатор канала.6061#### `async_chat.push(data)`6263Помещает данные в очередь канала для гарантированной передачи. Это всё, что нужно сделать, чтобы канал записал данные в сеть, хотя в более сложных схемах можно использовать собственных производителей, например, для шифрования или разбиения на блоки.6465#### `async_chat.push_with_producer(producer)`6667Принимает объект-производитель и добавляет его в очередь производителей, связанную с каналом. Когда все текущие добавленные производители будут исчерпаны, канал начнёт потреблять данные этого производителя, вызывая его метод `more()`, и отправлять данные на удалённую конечную точку.6869#### `async_chat.set_terminator(term)`7071Устанавливает условие завершения, которое будет распознаваться на канале. `term` может быть одним из трёх типов значений, соответствующих трём различным способам обработки входящих протокольных данных.7273| терминатор | Описание |74| --- | --- |75| *строка* | Вызовет [`found_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.found_terminator), когда строка будет найдена во входном потоке данных |76| *целое* | Вызовет [`found_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.found_terminator), когда будет получено указанное количество символов |77| `None` | Канал продолжает собирать данные бесконечно |7879Обратите внимание, что любые данные после терминатора будут доступны для чтения каналом после вызова [`found_terminator()`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat.found_terminator).8081## Пример asynchat8283Следующий неполный пример показывает, как HTTP-запросы можно читать с помощью [`async_chat`](https://python-all.ru/3.8/library/asynchat.html#asynchat.async_chat). Веб-сервер может создавать объект `http_request_handler` для каждого входящего подключения клиента. Обратите внимание, что изначально терминатор канала устанавливается на пустую строку в конце HTTP-заголовков, а флаг указывает, что заголовки читаются.8485После чтения заголовков, если запрос имеет тип POST (что указывает на наличие дополнительных данных во входном потоке), то заголовок `Content-Length:` используется для установки числового терминатора для чтения нужного количества данных из канала.8687Метод `handle_request()` вызывается после того, как все соответствующие входные данные были маршализированы, после установки терминатора канала на `None`, чтобы любые посторонние данные, отправленные веб-клиентом, игнорировались.8889```python90import asynchat9192class http_request_handler(asynchat.async_chat):9394 def __init__(self, sock, addr, sessions, log):95 asynchat.async_chat.__init__(self, sock=sock)96 self.addr = addr97 self.sessions = sessions98 self.ibuffer = []99 self.obuffer = b""100 self.set_terminator(b"\r\n\r\n")101 self.reading_headers = True102 self.handling = False103 self.cgi_data = None104 self.log = log105106 def collect_incoming_data(self, data):107 """Буферизировать данные"""108 self.ibuffer.append(data)109110 def found_terminator(self):111 if self.reading_headers:112 self.reading_headers = False113 self.parse_headers(b"".join(self.ibuffer))114 self.ibuffer = []115 if self.op.upper() == b"POST":116 clen = self.headers.getheader("content-length")117 self.set_terminator(int(clen))118 else:119 self.handling = True120 self.set_terminator(None)121 self.handle_request()122 elif not self.handling:123 self.set_terminator(None) # браузеры иногда отправляют лишние данные124 self.cgi_data = parse(self.headers, b"".join(self.ibuffer))125 self.handling = True126 self.ibuffer = []127 self.handle_request()128```129