`asyncore.md`

215 строк · 20.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/library/asyncore.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.6. [`asyncore`](https://python-all.ru/3.5/library/asyncore.html#module-asyncore) – асинхронный обработчик сокетов89**Исходный код:** [Lib/asyncore.py](https://python-all.ru/src/3.5/Lib/asyncore.py)1011---1213> **Примечание**14>15> Этот модуль существует только для обратной совместимости. Для нового кода рекомендуется использовать [`asyncio`](https://python-all.ru/3.5/library/asyncio.html#module-asyncio).1617Этот модуль предоставляет базовую инфраструктуру для написания клиентов и серверов асинхронных сокетных служб.1819Есть только два способа заставить программу на одном процессоре делать «более одного дела одновременно». Многопоточное программирование – самый простой и популярный способ, но есть и другой, совершенно иной метод, который даёт почти все преимущества многопоточности без использования нескольких потоков. Он действительно практичен только в том случае, если программа в основном связана с вводом-выводом. Если программа загружает процессор, то, вероятно, на самом деле требуются вытесняющие потоки с планированием. Однако сетевые серверы редко бывают привязаны к процессору.2021Если ваша операционная система поддерживает системный вызов `select()` в своей библиотеке ввода-вывода (а поддерживают почти все), то вы можете использовать его для одновременной работы с несколькими каналами связи, выполняя другую работу, пока ваш ввод-вывод происходит в «фоне». Хотя эта стратегия может показаться странной и сложной, особенно поначалу, во многих отношениях она проще для понимания и управления, чем многопоточное программирование. Модуль [`asyncore`](https://python-all.ru/3.5/library/asyncore.html#module-asyncore) решает за вас многие сложные проблемы, делая создание сложных высокопроизводительных сетевых серверов и клиентов очень простым. Для «диалоговых» приложений и протоколов незаменим сопутствующий модуль [`asynchat`](https://python-all.ru/3.5/library/asynchat.html#module-asynchat).2223Основная идея обоих модулей – создать один или несколько сетевых *каналов*, экземпляров классов [`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). Создание каналов добавляет их в глобальную карту, используемую функцией [`loop()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.loop), если вы не предоставите ей собственную *карту*.2425Как только начальный канал (или каналы) созданы, вызов функции [`loop()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.loop) активирует обслуживание каналов, которое продолжается до тех пор, пока последний канал (включая те, что были добавлены в карту во время асинхронного обслуживания) не будет закрыт.2627#### `asyncore.loop([timeout[, use_poll[, map[, count]]]])`2829Входит в цикл опроса, который завершается после count проходов или когда все открытые каналы будут закрыты. Все аргументы необязательны. Параметр *count* по умолчанию равен `None`, в результате чего цикл завершается только после закрытия всех каналов. Аргумент *timeout* задаёт параметр тайм-аута для соответствующего вызова [`select()`](https://python-all.ru/3.5/library/select.html#select.select) или [`poll()`](https://python-all.ru/3.5/library/select.html#select.poll), измеряемый в секундах; по умолчанию 30 секунд. Параметр *use\_poll*, если равен true, указывает, что [`poll()`](https://python-all.ru/3.5/library/select.html#select.poll) должен использоваться предпочтительнее, чем [`select()`](https://python-all.ru/3.5/library/select.html#select.select) (по умолчанию `False`).3031Параметр *map* – это словарь, элементами которого являются отслеживаемые каналы. При закрытии каналов они удаляются из своей карты. Если *map* опущен, используется глобальная карта. Каналы (экземпляры [`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) и их подклассов) могут свободно смешиваться в карте.3233#### `class asyncore.dispatcher`3435Класс [`dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) представляет собой тонкую обёртку вокруг низкоуровневого сокетного объекта. Чтобы сделать его более полезным, у него есть несколько методов обработки событий, которые вызываются из асинхронного цикла. В остальном его можно рассматривать как обычный неблокирующий сокетный объект.3637Возникновение низкоуровневых событий в определённые моменты или в определённых состояниях соединения сообщает асинхронному циклу, что произошли некоторые высокоуровневые события. Например, если мы запросили подключение сокета к другому хосту, мы знаем, что соединение установлено, когда сокет впервые становится доступным для записи (в этот момент можно писать в него, рассчитывая на успех). Подразумеваемые высокоуровневые события:3839| Событие | Описание |40| --- | --- |41| `handle_connect()` | Подразумевается первым событием чтения или записи |42| `handle_close()` | Подразумевается событием чтения, когда данные недоступны |43| `handle_accepted()` | Подразумевается событием чтения на слушающем сокете |4445Во время асинхронной обработки методы [`readable()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher.readable) и [`writable()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher.writable) каждого сопоставленного канала используются для определения, должен ли сокет канала быть добавлен в список каналов, `select()`ed или `poll()`ed для событий чтения и записи.4647Таким образом, набор событий канала шире, чем базовые события сокета. Полный набор методов, которые можно переопределить в вашем подклассе, приведён ниже:4849#### `handle_read()`5051Вызывается, когда асинхронный цикл обнаруживает, что вызов `read()` на сокете канала будет успешным.5253#### `handle_write()`5455Вызывается, когда асинхронный цикл обнаруживает, что сокет, доступный для записи, можно записать. Часто этот метод реализует необходимую буферизацию для производительности. Например:5657```python58def handle_write(self):59    sent = self.send(self.buffer)60    self.buffer = self.buffer[sent:]61```6263#### `handle_expt()`6465Вызывается при наличии внеполосных данных (OOB) для сокетного соединения. Это почти никогда не происходит, так как OOB поддерживается слабо и редко используется.6667#### `handle_connect()`6869Вызывается, когда сокет активного инициатора действительно устанавливает соединение. Может, например, отправить приветственный баннер или инициировать согласование протокола с удалённой конечной точкой.7071#### `handle_close()`7273Вызывается при закрытии сокета.7475#### `handle_error()`7677Вызывается, когда возникает исключение, которое иначе не обрабатывается. Версия по умолчанию выводит сокращённую трассировку.7879#### `handle_accept()`8081Вызывается на слушающих каналах (пассивных инициаторах), когда может быть установлено соединение с новой удалённой конечной точкой, которая выполнила вызов [`connect()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher.connect) для локальной конечной точки. Устарело в версии 3.2; вместо этого используйте [`handle_accepted()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher.handle_accepted).8283Устарело с версии 3.2.8485#### `handle_accepted(sock, addr)`8687Вызывается на слушающих каналах (пассивных открывателях), когда установлено соединение с новым удалённым узлом, который отправил вызов [`connect()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher.connect) для локального узла. *sock* – это *новый* объект сокета, пригодный для отправки и получения данных по соединению, а *addr* – адрес, привязанный к сокету на другом конце соединения.8889Новое в версии 3.2.9091#### `readable()`9293Вызывается на каждом витке асинхронного цикла, чтобы определить, следует ли добавить сокет канала в список, в котором могут происходить события чтения. Метод по умолчанию просто возвращает `True`, указывая, что по умолчанию все каналы будут заинтересованы в событиях чтения.9495#### `writable()`9697Вызывается на каждом витке асинхронного цикла, чтобы определить, следует ли добавить сокет канала в список, в котором могут происходить события записи. Метод по умолчанию просто возвращает `True`, указывая, что по умолчанию все каналы будут заинтересованы в событиях записи.9899Кроме того, каждый канал делегирует или расширяет многие методы сокета. Большинство из них почти идентичны своим сокетным аналогам.100101#### `create_socket(family=socket.AF_INET, type=socket.SOCK_STREAM)`102103Это идентично созданию обычного сокета и использует те же параметры создания. Обратитесь к документации [`socket`](https://python-all.ru/3.5/library/socket.html#module-socket) за информацией о создании сокетов.104105Изменено в версии 3.3: *family* и *type* аргументы могут быть опущены.106107#### `connect(address)`108109Как и для обычного объекта сокета, *address* – это кортеж, первый элемент которого – хост для подключения, а второй – номер порта.110111#### `send(data)`112113Отправляет *data* на удалённый узел сокета.114115#### `recv(buffer_size)`116117Читает не более *buffer\_size* байт с удалённого узла сокета. Пустой объект bytes означает, что канал был закрыт с другого конца.118119Обратите внимание, что [`recv()`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher.recv) может порождать [`BlockingIOError`](https://python-all.ru/3.5/library/exceptions.html#BlockingIOError), даже если [`select.select()`](https://python-all.ru/3.5/library/select.html#select.select) или [`select.poll()`](https://python-all.ru/3.5/library/select.html#select.poll) сообщили, что сокет готов к чтению.120121#### `listen(backlog)`122123Ожидает входящие соединения на сокете. Аргумент *backlog* задаёт максимальное количество соединений в очереди и должен быть не менее 1; максимальное значение зависит от системы (обычно 5).124125#### `bind(address)`126127Привязывает сокет к *address*. Сокет не должен быть уже привязан. (Формат *address* зависит от адресного семейства – обратитесь к документации [`socket`](https://python-all.ru/3.5/library/socket.html#module-socket) для получения дополнительной информации.) Чтобы пометить сокет как повторно используемый (установив параметр `SO_REUSEADDR`), вызовите метод `set_reuse_addr()` объекта [`dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher).128129#### `accept()`130131Принимает соединение. Сокет должен быть привязан к адресу и ожидать соединения. Возвращаемое значение может быть либо `None`, либо парой `(conn, address)`, где *conn* – это *новый* объект сокета, пригодный для отправки и получения данных по соединению, а *address* – адрес, привязанный к сокету на другом конце соединения. Если возвращено `None`, это означает, что соединение не установлено; в этом случае сервер должен просто проигнорировать это событие и продолжать ожидать новые входящие соединения.132133#### `close()`134135Закрывает сокет. Все последующие операции с объектом сокета будут завершаться ошибкой. Удалённый узел больше не будет получать данные (после отправки данных из очереди). Сокеты автоматически закрываются при сборке мусора.136137#### `class asyncore.dispatcher_with_send`138139Подкласс [`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).140141#### `class asyncore.file_dispatcher`142143A file\_dispatcher takes a file descriptor or [файловый объект](https://python-all.ru/3.5/glossary.html#term-file-object) along with an optional map argument and wraps it for use with the `poll()` or `loop()` functions. If provided a file object or anything with a `fileno()` method, that method will be called and passed to the [`file_wrapper`](https://python-all.ru/3.5/library/asyncore.html#asyncore.file_wrapper) constructor. Доступность: UNIX.144145#### `class asyncore.file_wrapper`146147A file\_wrapper takes an integer file descriptor and calls [`os.dup()`](https://python-all.ru/3.5/library/os.html#os.dup) to duplicate the handle so that the original handle may be closed independently of the file\_wrapper. This class implements sufficient methods to emulate a socket for use by the [`file_dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.file_dispatcher) class. Доступность: UNIX.148149## 18.6.1. asyncore: пример базового HTTP-клиента150151Вот очень простой HTTP-клиент, который использует класс [`dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) для реализации обработки сокетов:152153```python154import asyncore155156class HTTPClient(asyncore.dispatcher):157158    def __init__(self, host, path):159        asyncore.dispatcher.__init__(self)160        self.create_socket()161        self.connect( (host, 80) )162        self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' %163                            (path, host), 'ascii')164165    def handle_connect(self):166        pass167168    def handle_close(self):169        self.close()170171    def handle_read(self):172        print(self.recv(8192))173174    def writable(self):175        return (len(self.buffer) > 0)176177    def handle_write(self):178        sent = self.send(self.buffer)179        self.buffer = self.buffer[sent:]180181client = HTTPClient('www.python.org', '/')182asyncore.loop()183```184185## 18.6.2. asyncore: пример базового эхо-сервера186187Вот простой эхо-сервер, который использует класс [`dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) для приёма соединений и направляет входящие соединения обработчику:188189```python190import asyncore191192class EchoHandler(asyncore.dispatcher_with_send):193194    def handle_read(self):195        data = self.recv(8192)196        if data:197            self.send(data)198199class EchoServer(asyncore.dispatcher):200201    def __init__(self, host, port):202        asyncore.dispatcher.__init__(self)203        self.create_socket()204        self.set_reuse_addr()205        self.bind((host, port))206        self.listen(5)207208    def handle_accepted(self, sock, addr):209        print('Incoming connection from %s' % repr(addr))210        handler = EchoHandler(sock)211212server = EchoServer('localhost', 8080)213asyncore.loop()214```215