`asyncore.md`

204 строк · 20.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/2.7/library/asyncore.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 17.6. [`asyncore`](https://python-all.ru/2.7/library/asyncore.html#module-asyncore) – Асинхронный обработчик сокетов89**Исходный код:** [Lib/asyncore.py](https://python-all.ru/src/2.7/Lib/asyncore.py)1011---1213Этот модуль предоставляет базовую инфраструктуру для написания клиентов и серверов асинхронных сокетных служб.1415Есть только два способа заставить программу на одном процессоре делать «более одного дела одновременно». Многопоточное программирование – самый простой и популярный способ, но есть и другой, совершенно иной метод, который даёт почти все преимущества многопоточности без использования нескольких потоков. Он действительно практичен только в том случае, если программа в основном связана с вводом-выводом. Если программа загружает процессор, то, вероятно, на самом деле требуются вытесняющие потоки с планированием. Однако сетевые серверы редко бывают привязаны к процессору.1617Если ваша операционная система поддерживает системный вызов `select()` в своей библиотеке ввода-вывода (а поддерживают почти все), то вы можете использовать его для одновременной работы с несколькими каналами связи, выполняя другую работу, пока ваш ввод-вывод происходит в «фоне». Хотя эта стратегия может показаться странной и сложной, особенно поначалу, во многих отношениях она проще для понимания и управления, чем многопоточное программирование. Модуль [`asyncore`](https://python-all.ru/2.7/library/asyncore.html#module-asyncore) решает за вас многие сложные проблемы, делая создание сложных высокопроизводительных сетевых серверов и клиентов очень простым. Для «диалоговых» приложений и протоколов незаменим сопутствующий модуль [`asynchat`](https://python-all.ru/2.7/library/asynchat.html#module-asynchat).1819Основная идея обоих модулей – создать один или несколько сетевых *каналов*, экземпляров классов [`asyncore.dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher) и [`asynchat.async_chat`](https://python-all.ru/2.7/library/asynchat.html#asynchat.async_chat). Создание каналов добавляет их в глобальную карту, используемую функцией [`loop()`](https://python-all.ru/2.7/library/asyncore.html#asyncore.loop), если вы не предоставите ей собственную *карту*.2021Как только начальный канал (или каналы) созданы, вызов функции [`loop()`](https://python-all.ru/2.7/library/asyncore.html#asyncore.loop) активирует обслуживание каналов, которое продолжается до тех пор, пока последний канал (включая те, что были добавлены в карту во время асинхронного обслуживания) не будет закрыт.2223#### `asyncore.loop([timeout[, use_poll[, map[, count]]]])`2425Входит в цикл опроса, который завершается после count проходов или когда все открытые каналы будут закрыты. Все аргументы необязательны. Параметр *count* по умолчанию равен `None`, в результате чего цикл завершается только после закрытия всех каналов. Аргумент *timeout* задаёт параметр тайм-аута для соответствующего вызова [`select()`](https://python-all.ru/2.7/library/select.html#select.select) или [`poll()`](https://python-all.ru/2.7/library/select.html#select.poll), измеряемый в секундах; по умолчанию 30 секунд. Параметр *use\_poll*, если равен true, указывает, что [`poll()`](https://python-all.ru/2.7/library/select.html#select.poll) должен использоваться предпочтительнее, чем [`select()`](https://python-all.ru/2.7/library/select.html#select.select) (по умолчанию `False`).2627Параметр *map* – это словарь, элементами которого являются отслеживаемые каналы. При закрытии каналов они удаляются из своей карты. Если *map* опущен, используется глобальная карта. Каналы (экземпляры [`asyncore.dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher), [`asynchat.async_chat`](https://python-all.ru/2.7/library/asynchat.html#asynchat.async_chat) и их подклассов) могут свободно смешиваться в карте.2829#### `class asyncore.dispatcher`3031Класс [`dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher) представляет собой тонкую обёртку вокруг низкоуровневого сокетного объекта. Чтобы сделать его более полезным, у него есть несколько методов обработки событий, которые вызываются из асинхронного цикла. В остальном его можно рассматривать как обычный неблокирующий сокетный объект.3233Возникновение низкоуровневых событий в определённые моменты или в определённых состояниях соединения сообщает асинхронному циклу, что произошли некоторые высокоуровневые события. Например, если мы запросили подключение сокета к другому хосту, мы знаем, что соединение установлено, когда сокет впервые становится доступным для записи (в этот момент можно писать в него, рассчитывая на успех). Подразумеваемые высокоуровневые события:3435| Событие | Описание |36| --- | --- |37| `handle_connect()` | Подразумевается первым событием чтения или записи |38| `handle_close()` | Подразумевается событием чтения, когда данные недоступны |39| `handle_accept()` | Подразумевается событием чтения на слушающем сокете |4041Во время асинхронной обработки методы [`readable()`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher.readable) и [`writable()`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher.writable) каждого сопоставленного канала используются для определения, должен ли сокет канала быть добавлен в список каналов, `select()`ed или `poll()`ed для событий чтения и записи.4243Таким образом, набор событий канала шире, чем базовые события сокета. Полный набор методов, которые можно переопределить в вашем подклассе, приведён ниже:4445#### `handle_read()`4647Вызывается, когда асинхронный цикл обнаруживает, что вызов `read()` на сокете канала будет успешным.4849#### `handle_write()`5051Вызывается, когда асинхронный цикл обнаруживает, что сокет, доступный для записи, можно записать. Часто этот метод реализует необходимую буферизацию для производительности. Например:5253```python54def handle_write(self):55    sent = self.send(self.buffer)56    self.buffer = self.buffer[sent:]57```5859#### `handle_expt()`6061Вызывается при наличии внеполосных данных (OOB) для сокетного соединения. Это почти никогда не происходит, так как OOB поддерживается слабо и редко используется.6263#### `handle_connect()`6465Вызывается, когда сокет активного инициатора действительно устанавливает соединение. Может, например, отправить приветственный баннер или инициировать согласование протокола с удалённой конечной точкой.6667#### `handle_close()`6869Вызывается при закрытии сокета.7071#### `handle_error()`7273Вызывается, когда возникает исключение, которое иначе не обрабатывается. Версия по умолчанию выводит сокращённую трассировку.7475#### `handle_accept()`7677Вызывается на прослушивающих каналах (пассивные открыватели), когда может быть установлено соединение с новой удаленной конечной точкой, которая выполнила вызов [`connect()`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher.connect) для локальной конечной точки.7879#### `readable()`8081Вызывается на каждом витке асинхронного цикла, чтобы определить, следует ли добавить сокет канала в список, в котором могут происходить события чтения. Метод по умолчанию просто возвращает `True`, указывая, что по умолчанию все каналы будут заинтересованы в событиях чтения.8283#### `writable()`8485Вызывается на каждом витке асинхронного цикла, чтобы определить, следует ли добавить сокет канала в список, в котором могут происходить события записи. Метод по умолчанию просто возвращает `True`, указывая, что по умолчанию все каналы будут заинтересованы в событиях записи.8687Кроме того, каждый канал делегирует или расширяет многие методы сокета. Большинство из них почти идентичны своим сокетным аналогам.8889#### `create_socket(family, type)`9091Это идентично созданию обычного сокета и использует те же параметры создания. Обратитесь к документации [`socket`](https://python-all.ru/2.7/library/socket.html#module-socket) за информацией о создании сокетов.9293#### `connect(address)`9495Как и для обычного объекта сокета, *address* – это кортеж, первый элемент которого – хост для подключения, а второй – номер порта.9697#### `send(data)`9899Отправляет *data* на удалённый узел сокета.100101#### `recv(buffer_size)`102103Читает не более *buffer\_size* байт из удалённой конечной точки сокета. Пустая строка означает, что канал был закрыт с другого конца.104105Обратите внимание, что [`recv()`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher.recv) может возбуждать [`socket.error`](https://python-all.ru/2.7/library/socket.html#socket.error) с [`EAGAIN`](https://python-all.ru/2.7/library/errno.html#errno.EAGAIN) или [`EWOULDBLOCK`](https://python-all.ru/2.7/library/errno.html#errno.EWOULDBLOCK), даже если [`select.select()`](https://python-all.ru/2.7/library/select.html#select.select) или [`select.poll()`](https://python-all.ru/2.7/library/select.html#select.poll) сообщил, что сокет готов к чтению.106107#### `listen(backlog)`108109Ожидает входящие соединения на сокете. Аргумент *backlog* задаёт максимальное количество соединений в очереди и должен быть не менее 1; максимальное значение зависит от системы (обычно 5).110111#### `bind(address)`112113Привязывает сокет к *address*. Сокет не должен быть уже привязан. (Формат *address* зависит от адресного семейства – обратитесь к документации [`socket`](https://python-all.ru/2.7/library/socket.html#module-socket) для получения дополнительной информации.) Чтобы пометить сокет как повторно используемый (установив параметр `SO_REUSEADDR`), вызовите метод `set_reuse_addr()` объекта [`dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher).114115#### `accept()`116117Принимает соединение. Сокет должен быть привязан к адресу и ожидать соединения. Возвращаемое значение может быть либо `None`, либо парой `(conn, address)`, где *conn* – это *новый* объект сокета, пригодный для отправки и получения данных по соединению, а *address* – адрес, привязанный к сокету на другом конце соединения. Если возвращено `None`, это означает, что соединение не установлено; в этом случае сервер должен просто проигнорировать это событие и продолжать ожидать новые входящие соединения.118119#### `close()`120121Закрывает сокет. Все последующие операции с объектом сокета будут завершаться ошибкой. Удалённый узел больше не будет получать данные (после отправки данных из очереди). Сокеты автоматически закрываются при сборке мусора.122123#### `class asyncore.dispatcher_with_send`124125Подкласс [`dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher), который добавляет простую возможность буферизованного вывода, полезен для простых клиентов. Для более сложных случаев используйте [`asynchat.async_chat`](https://python-all.ru/2.7/library/asynchat.html#asynchat.async_chat).126127#### `class asyncore.file_dispatcher`128129file\_dispatcher принимает файловый дескриптор или файловый объект вместе с необязательным аргументом map и оборачивает его для использования с функциями `poll()` или `loop()`. Если передан файловый объект или что-либо с методом `fileno()`, этот метод будет вызван, а результат передан конструктору [`file_wrapper`](https://python-all.ru/2.7/library/asyncore.html#asyncore.file_wrapper). Доступность: UNIX.130131#### `class asyncore.file_wrapper`132133A file\_wrapper takes an integer file descriptor and calls [`os.dup()`](https://python-all.ru/2.7/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/2.7/library/asyncore.html#asyncore.file_dispatcher) class. Доступность: UNIX.134135## 17.6.1. asyncore – пример базового HTTP-клиента136137Вот очень простой HTTP-клиент, который использует класс [`dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher) для реализации обработки сокетов:138139```python140import asyncore, socket141142class HTTPClient(asyncore.dispatcher):143144    def __init__(self, host, path):145        asyncore.dispatcher.__init__(self)146        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)147        self.connect( (host, 80) )148        self.buffer = 'GET %s HTTP/1.0\r\n\r\n' % path149150    def handle_connect(self):151        pass152153    def handle_close(self):154        self.close()155156    def handle_read(self):157        print self.recv(8192)158159    def writable(self):160        return (len(self.buffer) > 0)161162    def handle_write(self):163        sent = self.send(self.buffer)164        self.buffer = self.buffer[sent:]165166client = HTTPClient('www.python.org', '/')167asyncore.loop()168```169170## 17.6.2. asyncore – пример базового эхо-сервера171172Вот простой эхо-сервер, который использует класс [`dispatcher`](https://python-all.ru/2.7/library/asyncore.html#asyncore.dispatcher) для приёма соединений и направляет входящие соединения обработчику:173174```python175import asyncore176import socket177178class EchoHandler(asyncore.dispatcher_with_send):179180    def handle_read(self):181        data = self.recv(8192)182        if data:183            self.send(data)184185class EchoServer(asyncore.dispatcher):186187    def __init__(self, host, port):188        asyncore.dispatcher.__init__(self)189        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)190        self.set_reuse_addr()191        self.bind((host, port))192        self.listen(5)193194    def handle_accept(self):195        pair = self.accept()196        if pair is not None:197            sock, addr = pair198            print 'Incoming connection from %s' % repr(addr)199            handler = EchoHandler(sock)200201server = EchoServer('localhost', 8080)202asyncore.loop()203```204