Документация Python неофициальный перевод

socketserver.md

479 строк · 43.5 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.11/library/socketserver.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`socketserver`](https://python-all.ru/3.11/library/socketserver.html#module-socketserver) – фреймворк для сетевых серверов89**Исходный код:** [Lib/socketserver.py](https://python-all.ru/src/3.11/Lib/socketserver.py)1011---1213Модуль [`socketserver`](https://python-all.ru/3.11/library/socketserver.html#module-socketserver) упрощает создание сетевых серверов.1415[Доступность](https://python-all.ru/3.11/library/intro.html#availability): not Emscripten, not WASI.1617Этот модуль не работает или недоступен на платформах WebAssembly `wasm32-emscripten` и `wasm32-wasi`. См. [платформы WebAssembly](https://python-all.ru/3.11/library/intro.html#wasm-availability) для получения дополнительной информации.1819Существует четыре базовых конкретных класса серверов:2021#### `class socketserver.TCPServer(server_address, RequestHandlerClass, bind_and_activate=True)`2223Этот класс использует сетевой протокол TCP, который обеспечивает непрерывные потоки данных между клиентом и сервером. Если *bind\_and\_activate* равен true, конструктор автоматически пытается вызвать [`server_bind()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_bind) и [`server_activate()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_activate). Остальные параметры передаются базовому классу [`BaseServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer).2425#### `class socketserver.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)`2627Использует дейтаграммы – отдельные пакеты информации, которые могут приходить не по порядку или теряться при передаче. Параметры те же, что и у [`TCPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.TCPServer).2829#### `class socketserver.UnixStreamServer(server_address, RequestHandlerClass, bind_and_activate=True)`3031#### `class socketserver.UnixDatagramServer(server_address, RequestHandlerClass, bind_and_activate=True)`3233Эти реже используемые классы похожи на классы TCP и UDP, но используют сокеты домена Unix; они недоступны на платформах, отличных от Unix. Параметры те же, что и у [`TCPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.TCPServer).3435Эти четыре класса обрабатывают запросы *синхронно*: каждый запрос должен быть завершён до того, как начнётся следующий. Это не подходит, если каждый запрос требует много времени на выполнение из-за вычислительной сложности или большого объёма возвращаемых данных, которые клиент обрабатывает медленно. Решение – создавать отдельный процесс или поток для обработки каждого запроса; классы-примеси [`ForkingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ForkingMixIn) и [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn) позволяют реализовать асинхронное поведение.3637Создание сервера состоит из нескольких этапов. Сначала необходимо создать класс-обработчик запросов, унаследовав его от [`BaseRequestHandler`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler) и переопределив метод [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle); этот метод будет обрабатывать входящие запросы. Затем нужно создать экземпляр одного из классов сервера, передав ему адрес сервера и класс-обработчик. Рекомендуется использовать сервер в операторе [`with`](https://python-all.ru/3.11/reference/compound_stmts.html#with). После этого вызовите метод [`handle_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.handle_request) или [`serve_forever()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.serve_forever) объекта сервера для обработки одного или нескольких запросов. Наконец, вызовите [`server_close()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_close) для закрытия сокета (если только не использовался оператор `with`).3839При наследовании от [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn) для поддержки многопоточности следует явно указать, как потоки должны вести себя при резком завершении работы. Класс [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn) определяет атрибут *daemon\_threads*, который указывает, должен ли сервер ожидать завершения потоков. Установите этот флаг явно, если хотите, чтобы потоки работали автономно; значение по умолчанию – [`False`](https://python-all.ru/3.11/library/constants.html#False), то есть Python не завершится, пока все потоки, созданные [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn), не завершатся.4041Классы серверов имеют одни и те же внешние методы и атрибуты, независимо от того, какой сетевой протокол они используют.4243## Замечания по созданию серверов4445В иерархии наследования пять классов, четыре из которых представляют синхронные серверы четырёх типов:4647```python48+------------+49| BaseServer |50+------------+51      |52      v53+-----------+        +------------------+54| TCPServer |------->| UnixStreamServer |55+-----------+        +------------------+56      |57      v58+-----------+        +--------------------+59| UDPServer |------->| UnixDatagramServer |60+-----------+        +--------------------+61```6263Обратите внимание, что [`UnixDatagramServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.UnixDatagramServer) наследуется от [`UDPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.UDPServer), а не от [`UnixStreamServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.UnixStreamServer) – единственное различие между IP-сервером и сервером Unix заключается в семействе адресов.6465#### `class socketserver.ForkingMixIn`6667#### `class socketserver.ThreadingMixIn`6869Версии с порождением процессов и потоками для каждого типа сервера можно создать с помощью этих классов-примесей. Например, [`ThreadingUDPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingUDPServer) создаётся следующим образом:7071```python72class ThreadingUDPServer(ThreadingMixIn, UDPServer):73    pass74```7576Класс-примесь указывается первым, поскольку он переопределяет метод, определённый в [`UDPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.UDPServer). Установка различных атрибутов также изменяет поведение базового механизма сервера.7778[`ForkingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ForkingMixIn) и классы Forking, упомянутые ниже, доступны только на POSIX-платформах, поддерживающих [`fork()`](https://python-all.ru/3.11/library/os.html#os.fork).7980#### `block_on_close`8182[`ForkingMixIn.server_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_close) ожидает завершения всех дочерних процессов, за исключением случая, когда атрибут [`block_on_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) равен `False`.8384[`ThreadingMixIn.server_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_close) ожидает завершения всех не-демонических потоков, за исключением случая, когда атрибут [`block_on_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) равен `False`.8586#### `daemon_threads`8788Для [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn) используются демонические потоки, если установить [`ThreadingMixIn.daemon_threads`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn.daemon_threads) в `True` – чтобы не ожидать завершения потоков.8990Изменено в версии 3.7: [`ForkingMixIn.server_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_close) и [`ThreadingMixIn.server_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_close) теперь ожидают завершения всех дочерних процессов и не-демонических потоков. Добавлен новый атрибут класса [`ForkingMixIn.block_on_close`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) для сохранения поведения, предшествующего версии 3.7.9192#### `class socketserver.ForkingTCPServer`9394#### `class socketserver.ForkingUDPServer`9596#### `class socketserver.ThreadingTCPServer`9798#### `class socketserver.ThreadingUDPServer`99100Эти классы предварительно определены с использованием примесных классов.101102Чтобы реализовать службу, необходимо создать класс, наследующий от [`BaseRequestHandler`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler), и переопределить его метод [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle). Затем можно запускать различные версии службы, комбинируя один из классов сервера с классом обработчика запросов. Класс обработчика запросов должен различаться для служб датаграмм и потоков. Эту сложность можно скрыть, используя подклассы обработчиков [`StreamRequestHandler`](https://python-all.ru/3.11/library/socketserver.html#socketserver.StreamRequestHandler) или [`DatagramRequestHandler`](https://python-all.ru/3.11/library/socketserver.html#socketserver.DatagramRequestHandler).103104Конечно, нужно подходить с умом. Например, нет смысла использовать сервер с порождением процессов (forking), если служба хранит состояние в памяти, которое может изменяться разными запросами, потому что изменения в дочернем процессе никогда не попадут в исходное состояние, хранящееся в родительском процессе и передаваемое каждому дочернему. В этом случае можно использовать потоковый сервер (threading), но, скорее всего, придётся использовать блокировки для защиты целостности общих данных.105106С другой стороны, если создаётся HTTP-сервер, где все данные хранятся внешне (например, в файловой системе), синхронный класс фактически сделает службу «глухой» на время обработки одного запроса – что может занять очень много времени, если клиент медленно получает все запрошенные данные. Здесь подойдёт потоковый сервер или сервер с порождением процессов.107108В некоторых случаях может быть уместно обработать часть запроса синхронно, но завершить обработку в порождённом дочернем процессе в зависимости от данных запроса. Этого можно добиться, используя синхронный сервер и выполняя явный fork (порождение процесса) в методе [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle) класса обработчика запросов.109110Другой подход к обработке нескольких одновременных запросов в среде, которая не поддерживает ни потоки, ни [`fork()`](https://python-all.ru/3.11/library/os.html#os.fork) (или когда они слишком дороги или неподходящи для сервиса) – поддерживать явную таблицу частично выполненных запросов и использовать [`selectors`](https://python-all.ru/3.11/library/selectors.html#module-selectors) для решения, какой запрос обрабатывать следующим (или обрабатывать ли новый входящий запрос). Это особенно важно для потоковых сервисов, где каждый клиент потенциально может быть подключён долгое время (если потоки или подпроцессы не могут быть использованы). Смотрите [`asyncore`](https://python-all.ru/3.11/library/asyncore.html#module-asyncore) для другого способа управления этим.111112## Объекты сервера113114#### `class socketserver.BaseServer(server_address, RequestHandlerClass)`115116Это суперкласс для всех объектов Server в модуле. Он определяет интерфейс, приведенный ниже, но не реализует большинство методов – это делается в подклассах. Два параметра хранятся в соответствующих атрибутах [`server_address`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_address) и [`RequestHandlerClass`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass).117118#### `fileno()`119120Возвращает целочисленный файловый дескриптор сокета, на котором сервер прослушивает соединения. Эта функция чаще всего передается в [`selectors`](https://python-all.ru/3.11/library/selectors.html#module-selectors), чтобы обеспечить мониторинг нескольких серверов в одном процессе.121122#### `handle_request()`123124Обрабатывает один запрос. Эта функция вызывает следующие методы по порядку: [`get_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.get_request), [`verify_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.verify_request) и [`process_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.process_request). Если предоставленный пользователем метод [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle) класса-обработчика вызывает исключение, вызывается метод [`handle_error()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.handle_error) сервера. Если в течение [`timeout`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.timeout) секунд не поступило ни одного запроса, будет вызван [`handle_timeout()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.handle_timeout), и [`handle_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.handle_request) завершится.125126#### `serve_forever(poll_interval=0.5)`127128Обрабатывает запросы до явного запроса [`shutdown()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.shutdown). Опрашивает завершение каждые *poll\_interval* секунд. Игнорирует атрибут [`timeout`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.timeout). Также вызывает [`service_actions()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.service_actions), который может использоваться подклассом или миксином для предоставления действий, специфичных для данной службы. Например, класс [`ForkingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ForkingMixIn) использует [`service_actions()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.service_actions) для очистки процессов-зомби.129130Изменено в версии 3.3: Добавлен вызов `service_actions` в метод `serve_forever`.131132#### `service_actions()`133134Вызывается в цикле [`serve_forever()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.serve_forever). Этот метод может быть переопределен подклассами или классами-миксинами для выполнения действий, специфичных для данной службы, например, действий по очистке.135136Новое в версии 3.3.137138#### `shutdown()`139140Сообщает циклу [`serve_forever()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.serve_forever) остановиться и ждет завершения. [`shutdown()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.shutdown) должен вызываться, пока [`serve_forever()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.serve_forever) выполняется в другом потоке, иначе возникнет взаимоблокировка.141142#### `server_close()`143144Выполняет очистку сервера. Может быть переопределен.145146#### `address_family`147148Семейство протоколов, к которому принадлежит сокет сервера. Типичные примеры – [`socket.AF_INET`](https://python-all.ru/3.11/library/socket.html#socket.AF_INET) и [`socket.AF_UNIX`](https://python-all.ru/3.11/library/socket.html#socket.AF_UNIX).149150#### `RequestHandlerClass`151152Класс обработчика запросов, предоставленный пользователем; экземпляр этого класса создаётся для каждого запроса.153154#### `server_address`155156Адрес, на котором сервер принимает соединения. Формат адресов зависит от семейства протоколов; подробнее см. документацию модуля [`socket`](https://python-all.ru/3.11/library/socket.html#module-socket). Для интернет-протоколов это кортеж, содержащий строку с адресом и целочисленный номер порта: например, `('127.0.0.1', 80)`.157158#### `socket`159160Объект сокета, через который сервер будет принимать входящие запросы.161162Классы серверов поддерживают следующие переменные класса:163164#### `allow_reuse_address`165166Определяет, разрешает ли сервер повторное использование адреса. По умолчанию [`False`](https://python-all.ru/3.11/library/constants.html#False); значение можно изменить в подклассах, чтобы задать другую политику.167168#### `request_queue_size`169170Размер очереди запросов. Если обработка одного запроса занимает много времени, запросы, поступающие, пока сервер занят, помещаются в очередь – до [`request_queue_size`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.request_queue_size) запросов. Когда очередь заполняется, дальнейшие запросы от клиентов получают ошибку «Connection denied». Обычно значение по умолчанию – 5, но его можно переопределить в подклассах.171172#### `socket_type`173174Тип сокета, используемый сервером; распространённые значения: [`socket.SOCK_STREAM`](https://python-all.ru/3.11/library/socket.html#socket.SOCK_STREAM) и [`socket.SOCK_DGRAM`](https://python-all.ru/3.11/library/socket.html#socket.SOCK_DGRAM).175176#### `timeout`177178Длительность тайм-аута в секундах или [`None`](https://python-all.ru/3.11/library/constants.html#None), если тайм-аут не нужен. Если [`handle_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.handle_request) не получает входящих запросов в течение периода тайм-аута, вызывается метод [`handle_timeout()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.handle_timeout).179180Существуют различные методы сервера, которые можно переопределить в подклассах базовых классов серверов, например [`TCPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.TCPServer); эти методы не предназначены для внешних пользователей объекта сервера.181182#### `finish_request(request, client_address)`183184Непосредственно обрабатывает запрос, создавая экземпляр [`RequestHandlerClass`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass) и вызывая его метод [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle).185186#### `get_request()`187188Должен принять запрос из сокета и вернуть кортеж из двух элементов, содержащий *новый* объект сокета для взаимодействия с клиентом и адрес клиента.189190#### `handle_error(request, client_address)`191192Эта функция вызывается, если метод [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle) экземпляра [`RequestHandlerClass`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass) возбуждает исключение. По умолчанию трассировка выводится в стандартный поток ошибок, после чего обработка следующих запросов продолжается.193194Изменено в версии 3.6: Теперь вызывается только для исключений, производных от класса [`Exception`](https://python-all.ru/3.11/library/exceptions.html#Exception).195196#### `handle_timeout()`197198Эта функция вызывается, когда атрибут [`timeout`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.timeout) установлен в значение, отличное от [`None`](https://python-all.ru/3.11/library/constants.html#None), и период тайм-аута истёк без получения запросов. По умолчанию для серверов с порождением процессов (forking) собирается статус завершившихся дочерних процессов; в многопоточных серверах этот метод ничего не делает.199200#### `process_request(request, client_address)`201202Вызывает [`finish_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.finish_request) для создания экземпляра [`RequestHandlerClass`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass). При необходимости эта функция может создать новый процесс или поток для обработки запроса; так поступают классы [`ForkingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ForkingMixIn) и [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn).203204#### `server_activate()`205206Вызывается конструктором сервера для активации сервера. По умолчанию для TCP-сервера просто вызывает [`listen()`](https://python-all.ru/3.11/library/socket.html#socket.socket.listen) на сокете сервера. Можно переопределить.207208#### `server_bind()`209210Вызывается конструктором сервера для привязки сокета к нужному адресу. Можно переопределить.211212#### `verify_request(request, client_address)`213214Должна возвращать логическое значение; если значение равно [`True`](https://python-all.ru/3.11/library/constants.html#True), запрос будет обработан, а если [`False`](https://python-all.ru/3.11/library/constants.html#False), запрос будет отклонен. Эта функция может быть переопределена для реализации контроля доступа к серверу. Реализация по умолчанию всегда возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True).215216Изменено в версии 3.6: Добавлена поддержка протокола [контекстного менеджера](https://python-all.ru/3.11/glossary.html#term-context-manager). Выход из контекстного менеджера эквивалентен вызову [`server_close()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.server_close).217218## Объекты обработчика запросов219220#### `class socketserver.BaseRequestHandler`221222Это суперкласс всех объектов-обработчиков запросов. Он определяет интерфейс, приведенный ниже. Конкретный подкласс обработчика запросов должен определить новый метод [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle) и может переопределять любые другие методы. Новый экземпляр подкласса создается для каждого запроса.223224#### `setup()`225226Вызывается перед методом [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle) для выполнения необходимых действий по инициализации. Реализация по умолчанию ничего не делает.227228#### `handle()`229230Эта функция должна выполнять всю работу, необходимую для обслуживания запроса. Реализация по умолчанию ничего не делает. Ей доступны несколько атрибутов экземпляра: запрос доступен как [`request`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.request); адрес клиента как [`client_address`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.client_address); а экземпляр сервера как [`server`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.server), на случай, если потребуется доступ к информации, специфичной для сервера.231232Тип [`request`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.request) различается для служб дейтаграмм и потоков. Для потоковых служб [`request`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.request) – это объект сокета; для служб дейтаграмм [`request`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.request) – это пара из строки и сокета.233234#### `finish()`235236Вызывается после метода [`handle()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.handle) для выполнения необходимых действий по очистке. Реализация по умолчанию ничего не делает. Если [`setup()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.setup) вызывает исключение, эта функция не будет вызвана.237238#### `request`239240*Новый* объект [`socket.socket`](https://python-all.ru/3.11/library/socket.html#socket.socket), используемый для взаимодействия с клиентом.241242#### `client_address`243244Адрес клиента, возвращаемый [`BaseServer.get_request()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer.get_request).245246#### `server`247248Объект [`BaseServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseServer), используемый для обработки запроса.249250#### `class socketserver.StreamRequestHandler`251252#### `class socketserver.DatagramRequestHandler`253254Эти подклассы [`BaseRequestHandler`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler) переопределяют методы [`setup()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.setup) и [`finish()`](https://python-all.ru/3.11/library/socketserver.html#socketserver.BaseRequestHandler.finish) и предоставляют атрибуты [`rfile`](https://python-all.ru/3.11/library/socketserver.html#socketserver.DatagramRequestHandler.rfile) и [`wfile`](https://python-all.ru/3.11/library/socketserver.html#socketserver.DatagramRequestHandler.wfile).255256#### `rfile`257258Файловый объект, из которого считывается запрос. Поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.11/library/io.html#io.BufferedIOBase) readable.259260#### `wfile`261262Файловый объект, в который записывается ответ. Поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.11/library/io.html#io.BufferedIOBase) writable.263264Изменено в версии 3.6: [`wfile`](https://python-all.ru/3.11/library/socketserver.html#socketserver.DatagramRequestHandler.wfile) также поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.11/library/io.html#io.BufferedIOBase) writable.265266## Примеры267268### [`socketserver.TCPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.TCPServer) Пример269270Это серверная сторона:271272```python273import socketserver274275class MyTCPHandler(socketserver.BaseRequestHandler):276    """277    Класс обработчика запросов для нашего сервера.278279    Он создаётся один раз на каждое подключение к серверу и должен280    переопределять метод handle() для реализации взаимодействия с281    клиентом.282    """283284    def handle(self):285        # self.request – это TCP-сокет, подключённый к клиенту286        self.data = self.request.recv(1024).strip()287        print("Received from {}:".format(self.client_address[0]))288        print(self.data)289        # просто отправляет обратно те же данные, но в верхнем регистре290        self.request.sendall(self.data.upper())291292if __name__ == "__main__":293    HOST, PORT = "localhost", 9999294295    # Создаём сервер, привязываясь к localhost на порту 9999296    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:297        # Запускаем сервер; он будет работать, пока вы298        # не прервёте программу с помощью Ctrl-C299        server.serve_forever()300```301302Альтернативный класс обработчика запросов, который использует потоки (объекты, подобные файлам, упрощающие взаимодействие за счет предоставления стандартного файлового интерфейса):303304```python305class MyTCPHandler(socketserver.StreamRequestHandler):306307    def handle(self):308        # self.rfile – это файлоподобный объект, созданный обработчиком;309        # теперь можно использовать, например, readline() вместо прямых вызовов recv()310        self.data = self.rfile.readline().strip()311        print("{} wrote:".format(self.client_address[0]))312        print(self.data)313        # Аналогично, self.wfile – это файлоподобный объект, используемый для записи ответа314        # клиенту315        self.wfile.write(self.data.upper())316```317318Разница в том, что вызов `readline()` во втором обработчике будет вызывать `recv()` несколько раз, пока не встретит символ новой строки, тогда как один вызов `recv()` в первом обработчике просто вернёт то, что было получено на данный момент от вызова `sendall()` клиента (обычно все данные, но это не гарантируется протоколом TCP).319320Это клиентская сторона:321322```python323import socket324import sys325326HOST, PORT = "localhost", 9999327data = " ".join(sys.argv[1:])328329# Создать сокет (SOCK_STREAM означает TCP-сокет)330with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:331    # Подключиться к серверу и отправить данные332    sock.connect((HOST, PORT))333    sock.sendall(bytes(data + "\n", "utf-8"))334335    # Получить данные от сервера и завершить работу336    received = str(sock.recv(1024), "utf-8")337338print("Sent:     {}".format(data))339print("Received: {}".format(received))340```341342Результат работы примера должен выглядеть примерно так:343344Сервер:345346```console347$ python TCPServer.py348127.0.0.1 wrote:349b'hello world with TCP'350127.0.0.1 wrote:351b'python is nice'352```353354Клиент:355356```console357$ python TCPClient.py hello world with TCP358Sent:     hello world with TCP359Received: HELLO WORLD WITH TCP360$ python TCPClient.py python is nice361Sent:     python is nice362Received: PYTHON IS NICE363```364365### [`socketserver.UDPServer`](https://python-all.ru/3.11/library/socketserver.html#socketserver.UDPServer) Пример366367Это серверная сторона:368369```python370import socketserver371372class MyUDPHandler(socketserver.BaseRequestHandler):373    """374    Этот класс работает аналогично классу-обработчику TCP, за исключением того, что375    self.request состоит из пары данных и клиентского сокета, и поскольку376    соединение отсутствует, адрес клиента должен быть указан явно377    при отправке данных обратно через sendto().378    """379380    def handle(self):381        data = self.request[0].strip()382        socket = self.request[1]383        print("{} wrote:".format(self.client_address[0]))384        print(data)385        socket.sendto(data.upper(), self.client_address)386387if __name__ == "__main__":388    HOST, PORT = "localhost", 9999389    with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:390        server.serve_forever()391```392393Это клиентская сторона:394395```python396import socket397import sys398399HOST, PORT = "localhost", 9999400data = " ".join(sys.argv[1:])401402# SOCK_DGRAM – это тип сокета для UDP-сокетов403sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)404405# Как можно видеть, вызов connect() отсутствует; в UDP нет соединений.406# Вместо этого данные отправляются напрямую получателю через sendto().407sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))408received = str(sock.recv(1024), "utf-8")409410print("Sent:     {}".format(data))411print("Received: {}".format(received))412```413414Результат работы примера должен выглядеть точно так же, как для примера TCP-сервера.415416### Асинхронные Mixins417418Для построения асинхронных обработчиков используйте классы [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn) и [`ForkingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ForkingMixIn).419420Пример для класса [`ThreadingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ThreadingMixIn):421422```python423import socket424import threading425import socketserver426427class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):428429    def handle(self):430        data = str(self.request.recv(1024), 'ascii')431        cur_thread = threading.current_thread()432        response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')433        self.request.sendall(response)434435class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):436    pass437438def client(ip, port, message):439    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:440        sock.connect((ip, port))441        sock.sendall(bytes(message, 'ascii'))442        response = str(sock.recv(1024), 'ascii')443        print("Received: {}".format(response))444445if __name__ == "__main__":446    # Порт 0 означает выбор произвольного неиспользуемого порта447    HOST, PORT = "localhost", 0448449    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)450    with server:451        ip, port = server.server_address452453        # Запустить поток для сервера – этот поток затем запустит один454        # дополнительный поток на каждый запрос455        server_thread = threading.Thread(target=server.serve_forever)456        # Завершить поток сервера при завершении главного потока457        server_thread.daemon = True458        server_thread.start()459        print("Server loop running in thread:", server_thread.name)460461        client(ip, port, "Hello World 1")462        client(ip, port, "Hello World 2")463        client(ip, port, "Hello World 3")464465        server.shutdown()466```467468Результат работы примера должен выглядеть примерно так:469470```console471$ python ThreadedTCPServer.py472Server loop running in thread: Thread-1473Received: Thread-2: Hello World 1474Received: Thread-3: Hello World 2475Received: Thread-4: Hello World 3476```477478Класс [`ForkingMixIn`](https://python-all.ru/3.11/library/socketserver.html#socketserver.ForkingMixIn) используется аналогично, за исключением того, что сервер будет создавать новый процесс для каждого запроса. Доступен только на платформах POSIX, поддерживающих [`fork()`](https://python-all.ru/3.11/library/os.html#os.fork).479