asyncore.md
1> **Источник:** https://python-all.ru/3.7/library/asyncore.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`asyncore`](https://python-all.ru/3.7/library/asyncore.html#module-asyncore) – Асинхронный обработчик сокетов89**Исходный код:** [Lib/asyncore.py](https://python-all.ru/src/3.7/Lib/asyncore.py)1011Устарело с версии 3.6: Вместо этого используйте [`asyncio`](https://python-all.ru/3.7/library/asyncio.html#module-asyncio).1213---1415> **Примечание**16>17> Этот модуль существует только для обратной совместимости. Для нового кода рекомендуется использовать [`asyncio`](https://python-all.ru/3.7/library/asyncio.html#module-asyncio).1819Этот модуль предоставляет базовую инфраструктуру для написания клиентов и серверов асинхронных сокетных служб.2021Есть только два способа заставить программу на одном процессоре делать «более одного дела одновременно». Многопоточное программирование – самый простой и популярный способ, но есть и другой, совершенно иной метод, который даёт почти все преимущества многопоточности без использования нескольких потоков. Он действительно практичен только в том случае, если программа в основном связана с вводом-выводом. Если программа загружает процессор, то, вероятно, на самом деле требуются вытесняющие потоки с планированием. Однако сетевые серверы редко бывают привязаны к процессору.2223Если ваша операционная система поддерживает системный вызов `select()` в своей библиотеке ввода-вывода (а поддерживают почти все), то вы можете использовать его для одновременной работы с несколькими каналами связи, выполняя другую работу, пока ваш ввод-вывод происходит в «фоне». Хотя эта стратегия может показаться странной и сложной, особенно поначалу, во многих отношениях она проще для понимания и управления, чем многопоточное программирование. Модуль [`asyncore`](https://python-all.ru/3.7/library/asyncore.html#module-asyncore) решает за вас многие сложные проблемы, делая создание сложных высокопроизводительных сетевых серверов и клиентов очень простым. Для «диалоговых» приложений и протоколов незаменим сопутствующий модуль [`asynchat`](https://python-all.ru/3.7/library/asynchat.html#module-asynchat).2425Основная идея обоих модулей – создать один или несколько сетевых *каналов*, экземпляров классов [`asyncore.dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher) и [`asynchat.async_chat`](https://python-all.ru/3.7/library/asynchat.html#asynchat.async_chat). Создание каналов добавляет их в глобальную карту, используемую функцией [`loop()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.loop), если вы не предоставите ей собственную *карту*.2627Как только начальный канал (или каналы) созданы, вызов функции [`loop()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.loop) активирует обслуживание каналов, которое продолжается до тех пор, пока последний канал (включая те, что были добавлены в карту во время асинхронного обслуживания) не будет закрыт.2829#### `asyncore.loop([timeout[, use_poll[, map[, count]]]])`3031Входит в цикл опроса, который завершается после count проходов или когда все открытые каналы будут закрыты. Все аргументы необязательны. Параметр *count* по умолчанию равен `None`, в результате чего цикл завершается только после закрытия всех каналов. Аргумент *timeout* задаёт параметр тайм-аута для соответствующего вызова [`select()`](https://python-all.ru/3.7/library/select.html#select.select) или [`poll()`](https://python-all.ru/3.7/library/select.html#select.poll), измеряемый в секундах; по умолчанию 30 секунд. Параметр *use\_poll*, если равен true, указывает, что [`poll()`](https://python-all.ru/3.7/library/select.html#select.poll) должен использоваться предпочтительнее, чем [`select()`](https://python-all.ru/3.7/library/select.html#select.select) (по умолчанию `False`).3233Параметр *map* – это словарь, элементами которого являются отслеживаемые каналы. При закрытии каналов они удаляются из своей карты. Если *map* опущен, используется глобальная карта. Каналы (экземпляры [`asyncore.dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher), [`asynchat.async_chat`](https://python-all.ru/3.7/library/asynchat.html#asynchat.async_chat) и их подклассов) могут свободно смешиваться в карте.3435#### `class asyncore.dispatcher`3637Класс [`dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher) представляет собой тонкую обёртку вокруг низкоуровневого сокетного объекта. Чтобы сделать его более полезным, у него есть несколько методов обработки событий, которые вызываются из асинхронного цикла. В остальном его можно рассматривать как обычный неблокирующий сокетный объект.3839Возникновение низкоуровневых событий в определённые моменты или в определённых состояниях соединения сообщает асинхронному циклу, что произошли некоторые высокоуровневые события. Например, если мы запросили подключение сокета к другому хосту, мы знаем, что соединение установлено, когда сокет впервые становится доступным для записи (в этот момент можно писать в него, рассчитывая на успех). Подразумеваемые высокоуровневые события:4041| Событие | Описание |42| --- | --- |43| `handle_connect()` | Подразумевается первым событием чтения или записи |44| `handle_close()` | Подразумевается событием чтения, когда данные недоступны |45| `handle_accepted()` | Подразумевается событием чтения на слушающем сокете |4647Во время асинхронной обработки методы [`readable()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher.readable) и [`writable()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher.writable) каждого сопоставленного канала используются для определения, должен ли сокет канала быть добавлен в список каналов, `select()`ed или `poll()`ed для событий чтения и записи.4849Таким образом, набор событий канала шире, чем базовые события сокета. Полный набор методов, которые можно переопределить в вашем подклассе, приведён ниже:5051#### `handle_read()`5253Вызывается, когда асинхронный цикл обнаруживает, что вызов `read()` на сокете канала будет успешным.5455#### `handle_write()`5657Вызывается, когда асинхронный цикл обнаруживает, что сокет, доступный для записи, можно записать. Часто этот метод реализует необходимую буферизацию для производительности. Например:5859```python60def handle_write(self):61 sent = self.send(self.buffer)62 self.buffer = self.buffer[sent:]63```6465#### `handle_expt()`6667Вызывается при наличии внеполосных данных (OOB) для сокетного соединения. Это почти никогда не происходит, так как OOB поддерживается слабо и редко используется.6869#### `handle_connect()`7071Вызывается, когда сокет активного инициатора действительно устанавливает соединение. Может, например, отправить приветственный баннер или инициировать согласование протокола с удалённой конечной точкой.7273#### `handle_close()`7475Вызывается при закрытии сокета.7677#### `handle_error()`7879Вызывается, когда возникает исключение, которое иначе не обрабатывается. Версия по умолчанию выводит сокращённую трассировку.8081#### `handle_accept()`8283Вызывается на слушающих каналах (пассивных инициаторах), когда может быть установлено соединение с новой удалённой конечной точкой, которая выполнила вызов [`connect()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher.connect) для локальной конечной точки. Устарело в версии 3.2; вместо этого используйте [`handle_accepted()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher.handle_accepted).8485Устарело с версии 3.2.8687#### `handle_accepted(sock, addr)`8889Вызывается на слушающих каналах (пассивных открывателях), когда установлено соединение с новым удалённым узлом, который отправил вызов [`connect()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher.connect) для локального узла. *sock* – это *новый* объект сокета, пригодный для отправки и получения данных по соединению, а *addr* – адрес, привязанный к сокету на другом конце соединения.9091Новое в версии 3.2.9293#### `readable()`9495Вызывается на каждом витке асинхронного цикла, чтобы определить, следует ли добавить сокет канала в список, в котором могут происходить события чтения. Метод по умолчанию просто возвращает `True`, указывая, что по умолчанию все каналы будут заинтересованы в событиях чтения.9697#### `writable()`9899Вызывается на каждом витке асинхронного цикла, чтобы определить, следует ли добавить сокет канала в список, в котором могут происходить события записи. Метод по умолчанию просто возвращает `True`, указывая, что по умолчанию все каналы будут заинтересованы в событиях записи.100101Кроме того, каждый канал делегирует или расширяет многие методы сокета. Большинство из них почти идентичны своим сокетным аналогам.102103#### `create_socket(family=socket.AF_INET, type=socket.SOCK_STREAM)`104105Это идентично созданию обычного сокета и использует те же параметры создания. Обратитесь к документации [`socket`](https://python-all.ru/3.7/library/socket.html#module-socket) за информацией о создании сокетов.106107Изменено в версии 3.3: *family* и *type* аргументы могут быть опущены.108109#### `connect(address)`110111Как и для обычного объекта сокета, *address* – это кортеж, первый элемент которого – хост для подключения, а второй – номер порта.112113#### `send(data)`114115Отправляет *data* на удалённый узел сокета.116117#### `recv(buffer_size)`118119Читает не более *buffer\_size* байт с удалённого узла сокета. Пустой объект bytes означает, что канал был закрыт с другого конца.120121Обратите внимание, что [`recv()`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher.recv) может порождать [`BlockingIOError`](https://python-all.ru/3.7/library/exceptions.html#BlockingIOError), даже если [`select.select()`](https://python-all.ru/3.7/library/select.html#select.select) или [`select.poll()`](https://python-all.ru/3.7/library/select.html#select.poll) сообщили, что сокет готов к чтению.122123#### `listen(backlog)`124125Ожидает входящие соединения на сокете. Аргумент *backlog* задаёт максимальное количество соединений в очереди и должен быть не менее 1; максимальное значение зависит от системы (обычно 5).126127#### `bind(address)`128129Привязывает сокет к *address*. Сокет не должен быть уже привязан. (Формат *address* зависит от адресного семейства – обратитесь к документации [`socket`](https://python-all.ru/3.7/library/socket.html#module-socket) для получения дополнительной информации.) Чтобы пометить сокет как повторно используемый (установив параметр `SO_REUSEADDR`), вызовите метод `set_reuse_addr()` объекта [`dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher).130131#### `accept()`132133Принимает соединение. Сокет должен быть привязан к адресу и ожидать соединения. Возвращаемое значение может быть либо `None`, либо парой `(conn, address)`, где *conn* – это *новый* объект сокета, пригодный для отправки и получения данных по соединению, а *address* – адрес, привязанный к сокету на другом конце соединения. Если возвращено `None`, это означает, что соединение не установлено; в этом случае сервер должен просто проигнорировать это событие и продолжать ожидать новые входящие соединения.134135#### `close()`136137Закрывает сокет. Все последующие операции с объектом сокета будут завершаться ошибкой. Удалённый узел больше не будет получать данные (после отправки данных из очереди). Сокеты автоматически закрываются при сборке мусора.138139#### `class asyncore.dispatcher_with_send`140141Подкласс [`dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher), который добавляет простую возможность буферизованного вывода, полезен для простых клиентов. Для более сложных случаев используйте [`asynchat.async_chat`](https://python-all.ru/3.7/library/asynchat.html#asynchat.async_chat).142143#### `class asyncore.file_dispatcher`144145file\_dispatcher принимает файловый дескриптор или [файловый объект](https://python-all.ru/3.7/glossary.html#term-file-object) вместе с необязательным аргументом map и оборачивает его для использования с функциями `poll()` или `loop()`. Если передан файловый объект или что-либо с методом `fileno()`, этот метод будет вызван и передан конструктору [`file_wrapper`](https://python-all.ru/3.7/library/asyncore.html#asyncore.file_wrapper).146147[Доступность](https://python-all.ru/3.7/library/intro.html#availability): Unix.148149#### `class asyncore.file_wrapper`150151file\_wrapper принимает целочисленный файловый дескриптор и вызывает [`os.dup()`](https://python-all.ru/3.7/library/os.html#os.dup) для дублирования дескриптора, чтобы исходный дескриптор можно было закрыть независимо от file\_wrapper. Этот класс реализует достаточное количество методов для эмуляции сокета для использования классом [`file_dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.file_dispatcher).152153[Доступность](https://python-all.ru/3.7/library/intro.html#availability): Unix.154155## asyncore Пример базового HTTP-клиента156157Вот очень простой HTTP-клиент, который использует класс [`dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher) для реализации обработки сокетов:158159```python160import asyncore161162class HTTPClient(asyncore.dispatcher):163164 def __init__(self, host, path):165 asyncore.dispatcher.__init__(self)166 self.create_socket()167 self.connect( (host, 80) )168 self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' %169 (path, host), 'ascii')170171 def handle_connect(self):172 pass173174 def handle_close(self):175 self.close()176177 def handle_read(self):178 print(self.recv(8192))179180 def writable(self):181 return (len(self.buffer) > 0)182183 def handle_write(self):184 sent = self.send(self.buffer)185 self.buffer = self.buffer[sent:]186187client = HTTPClient('www.python.org', '/')188asyncore.loop()189```190191## asyncore Пример простого эхо-сервера192193Вот простой эхо-сервер, который использует класс [`dispatcher`](https://python-all.ru/3.7/library/asyncore.html#asyncore.dispatcher) для приёма соединений и направляет входящие соединения обработчику:194195```python196import asyncore197198class EchoHandler(asyncore.dispatcher_with_send):199200 def handle_read(self):201 data = self.recv(8192)202 if data:203 self.send(data)204205class EchoServer(asyncore.dispatcher):206207 def __init__(self, host, port):208 asyncore.dispatcher.__init__(self)209 self.create_socket()210 self.set_reuse_addr()211 self.bind((host, port))212 self.listen(5)213214 def handle_accepted(self, sock, addr):215 print('Incoming connection from %s' % repr(addr))216 handler = EchoHandler(sock)217218server = EchoServer('localhost', 8080)219asyncore.loop()220```221