`socketserver.md`

497 строк · 44.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/socketserver.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `socketserver` – фреймворк для сетевых серверов89**Исходный код:** [Lib/socketserver.py](https://python-all.ru/src/3.12/Lib/socketserver.py)1011---1213Модуль [`socketserver`](https://python-all.ru/3.12/library/socketserver.html#module-socketserver) упрощает создание сетевых серверов.1415[Доступность](https://python-all.ru/3.12/library/intro.html#availability): not Emscripten, not WASI.1617Этот модуль не работает или недоступен на платформах WebAssembly `wasm32-emscripten` и `wasm32-wasi`. См. [платформы WebAssembly](https://python-all.ru/3.12/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.12/library/socketserver.html#socketserver.BaseServer.server_bind) и [`server_activate()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_activate). Остальные параметры передаются базовому классу [`BaseServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer).2425#### `class socketserver.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)`2627Использует дейтаграммы – отдельные пакеты информации, которые могут приходить не по порядку или теряться при передаче. Параметры те же, что и у [`TCPServer`](https://python-all.ru/3.12/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.12/library/socketserver.html#socketserver.TCPServer).3435Эти четыре класса обрабатывают запросы *синхронно*: каждый запрос должен быть завершён до того, как начнётся следующий. Это не подходит, если каждый запрос требует много времени на выполнение из-за вычислительной сложности или большого объёма возвращаемых данных, которые клиент обрабатывает медленно. Решение – создавать отдельный процесс или поток для обработки каждого запроса; классы-примеси [`ForkingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ForkingMixIn) и [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn) позволяют реализовать асинхронное поведение.3637Создание сервера состоит из нескольких этапов. Сначала необходимо создать класс-обработчик запросов, унаследовав его от [`BaseRequestHandler`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler) и переопределив метод [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle); этот метод будет обрабатывать входящие запросы. Затем нужно создать экземпляр одного из классов сервера, передав ему адрес сервера и класс-обработчик. Рекомендуется использовать сервер в операторе [`with`](https://python-all.ru/3.12/reference/compound_stmts.html#with). После этого вызовите метод [`handle_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.handle_request) или [`serve_forever()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.serve_forever) объекта сервера для обработки одного или нескольких запросов. Наконец, вызовите [`server_close()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_close) для закрытия сокета (если только не использовался оператор `with`).3839При наследовании от [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn) для поддержки многопоточности следует явно указать, как потоки должны вести себя при резком завершении работы. Класс [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn) определяет атрибут *daemon\_threads*, который указывает, должен ли сервер ожидать завершения потоков. Установите этот флаг явно, если хотите, чтобы потоки работали автономно; значение по умолчанию – [`False`](https://python-all.ru/3.12/library/constants.html#False), то есть Python не завершится, пока все потоки, созданные [`ThreadingMixIn`](https://python-all.ru/3.12/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.12/library/socketserver.html#socketserver.UnixDatagramServer) наследуется от [`UDPServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.UDPServer), а не от [`UnixStreamServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.UnixStreamServer) – единственное различие между IP-сервером и сервером Unix заключается в семействе адресов.6465#### `class socketserver.ForkingMixIn`6667#### `class socketserver.ThreadingMixIn`6869Версии с порождением процессов и потоками для каждого типа сервера можно создать с помощью этих классов-примесей. Например, [`ThreadingUDPServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingUDPServer) создаётся следующим образом:7071```python72class ThreadingUDPServer(ThreadingMixIn, UDPServer):73    pass74```7576Класс-примесь указывается первым, поскольку он переопределяет метод, определённый в [`UDPServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.UDPServer). Установка различных атрибутов также изменяет поведение базового механизма сервера.7778[`ForkingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ForkingMixIn) и классы Forking, упомянутые ниже, доступны только на POSIX-платформах, поддерживающих [`fork()`](https://python-all.ru/3.12/library/os.html#os.fork).7980#### `block_on_close`8182[`ForkingMixIn.server_close`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_close) ожидает завершения всех дочерних процессов, за исключением случая, когда атрибут [`block_on_close`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) равен `False`.8384[`ThreadingMixIn.server_close`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_close) ожидает завершения всех не-демонических потоков, за исключением случая, когда атрибут [`block_on_close`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) равен `False`.8586#### `daemon_threads`8788Для [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn) используются демонические потоки, если установить [`ThreadingMixIn.daemon_threads`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn.daemon_threads) в `True` – чтобы не ожидать завершения потоков.8990Изменено в версии 3.7: [`ForkingMixIn.server_close`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_close) и [`ThreadingMixIn.server_close`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_close) теперь ожидают завершения всех дочерних процессов и не-демонических потоков. Добавлен новый атрибут класса [`ForkingMixIn.block_on_close`](https://python-all.ru/3.12/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#### `class socketserver.ForkingUnixStreamServer`101102#### `class socketserver.ForkingUnixDatagramServer`103104#### `class socketserver.ThreadingUnixStreamServer`105106#### `class socketserver.ThreadingUnixDatagramServer`107108Эти классы предварительно определены с использованием примесных классов.109110Добавлено в версии 3.12: Классы `ForkingUnixStreamServer` и `ForkingUnixDatagramServer` были добавлены.111112Чтобы реализовать службу, необходимо создать класс, наследующий от [`BaseRequestHandler`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler), и переопределить его метод [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle). Затем можно запускать различные версии службы, комбинируя один из классов сервера с классом обработчика запросов. Класс обработчика запросов должен различаться для служб датаграмм и потоков. Эту сложность можно скрыть, используя подклассы обработчиков [`StreamRequestHandler`](https://python-all.ru/3.12/library/socketserver.html#socketserver.StreamRequestHandler) или [`DatagramRequestHandler`](https://python-all.ru/3.12/library/socketserver.html#socketserver.DatagramRequestHandler).113114Конечно, нужно подходить с умом. Например, нет смысла использовать сервер с порождением процессов (forking), если служба хранит состояние в памяти, которое может изменяться разными запросами, потому что изменения в дочернем процессе никогда не попадут в исходное состояние, хранящееся в родительском процессе и передаваемое каждому дочернему. В этом случае можно использовать потоковый сервер (threading), но, скорее всего, придётся использовать блокировки для защиты целостности общих данных.115116С другой стороны, если создаётся HTTP-сервер, где все данные хранятся внешне (например, в файловой системе), синхронный класс фактически сделает службу «глухой» на время обработки одного запроса – что может занять очень много времени, если клиент медленно получает все запрошенные данные. Здесь подойдёт потоковый сервер или сервер с порождением процессов.117118В некоторых случаях может быть уместно обработать часть запроса синхронно, но завершить обработку в порождённом дочернем процессе в зависимости от данных запроса. Этого можно добиться, используя синхронный сервер и выполняя явный fork (порождение процесса) в методе [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle) класса обработчика запросов.119120Другой подход к обработке нескольких одновременных запросов в среде, не поддерживающей ни потоки, ни [`fork()`](https://python-all.ru/3.12/library/os.html#os.fork) (или если они слишком дороги или неподходящи для службы) – поддерживать явную таблицу частично выполненных запросов и использовать [`selectors`](https://python-all.ru/3.12/library/selectors.html#module-selectors) для определения, какой запрос обрабатывать следующим (или нужно ли обрабатывать новый входящий запрос). Это особенно важно для потоковых служб, где каждый клиент может потенциально оставаться подключённым долгое время (если потоки или подпроцессы не могут использоваться).121122## Объекты сервера123124#### `class socketserver.BaseServer(server_address, RequestHandlerClass)`125126Это суперкласс для всех объектов Server в модуле. Он определяет интерфейс, приведенный ниже, но не реализует большинство методов – это делается в подклассах. Два параметра хранятся в соответствующих атрибутах [`server_address`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_address) и [`RequestHandlerClass`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass).127128#### `fileno()`129130Возвращает целочисленный файловый дескриптор сокета, на котором сервер прослушивает соединения. Эта функция чаще всего передается в [`selectors`](https://python-all.ru/3.12/library/selectors.html#module-selectors), чтобы обеспечить мониторинг нескольких серверов в одном процессе.131132#### `handle_request()`133134Обрабатывает один запрос. Эта функция вызывает следующие методы по порядку: [`get_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.get_request), [`verify_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.verify_request) и [`process_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.process_request). Если предоставленный пользователем метод [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle) класса-обработчика вызывает исключение, вызывается метод [`handle_error()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.handle_error) сервера. Если в течение [`timeout`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.timeout) секунд не поступило ни одного запроса, будет вызван [`handle_timeout()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.handle_timeout), и [`handle_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.handle_request) завершится.135136#### `serve_forever(poll_interval=0.5)`137138Обрабатывает запросы до явного запроса [`shutdown()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.shutdown). Опрашивает завершение каждые *poll\_interval* секунд. Игнорирует атрибут [`timeout`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.timeout). Также вызывает [`service_actions()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.service_actions), который может использоваться подклассом или миксином для предоставления действий, специфичных для данной службы. Например, класс [`ForkingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ForkingMixIn) использует [`service_actions()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.service_actions) для очистки процессов-зомби.139140Изменено в версии 3.3: Добавлен вызов `service_actions` в метод `serve_forever`.141142#### `service_actions()`143144Вызывается в цикле [`serve_forever()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.serve_forever). Этот метод может быть переопределен подклассами или классами-миксинами для выполнения действий, специфичных для данной службы, например, действий по очистке.145146Добавлено в версии 3.3.147148#### `shutdown()`149150Сообщает циклу [`serve_forever()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.serve_forever) остановиться и ждет завершения. [`shutdown()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.shutdown) должен вызываться, пока [`serve_forever()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.serve_forever) выполняется в другом потоке, иначе возникнет взаимоблокировка.151152#### `server_close()`153154Выполняет очистку сервера. Может быть переопределен.155156#### `address_family`157158Семейство протоколов, к которому принадлежит сокет сервера. Типичные примеры: [`socket.AF_INET`](https://python-all.ru/3.12/library/socket.html#socket.AF_INET), [`socket.AF_INET6`](https://python-all.ru/3.12/library/socket.html#socket.AF_INET6) и [`socket.AF_UNIX`](https://python-all.ru/3.12/library/socket.html#socket.AF_UNIX). Наследуйте классы TCP- или UDP-сервера из этого модуля, установив атрибут класса `address_family = AF_INET6`, если нужны классы сервера для IPv6.159160#### `RequestHandlerClass`161162Класс обработчика запросов, предоставленный пользователем; экземпляр этого класса создаётся для каждого запроса.163164#### `server_address`165166Адрес, на котором сервер принимает соединения. Формат адресов зависит от семейства протоколов; подробнее см. документацию модуля [`socket`](https://python-all.ru/3.12/library/socket.html#module-socket). Для интернет-протоколов это кортеж, содержащий строку с адресом и целочисленный номер порта: например, `('127.0.0.1', 80)`.167168#### `socket`169170Объект сокета, через который сервер будет принимать входящие запросы.171172Классы серверов поддерживают следующие переменные класса:173174#### `allow_reuse_address`175176Определяет, разрешает ли сервер повторное использование адреса. По умолчанию [`False`](https://python-all.ru/3.12/library/constants.html#False); значение можно изменить в подклассах, чтобы задать другую политику.177178#### `request_queue_size`179180Размер очереди запросов. Если обработка одного запроса занимает много времени, запросы, поступающие, пока сервер занят, помещаются в очередь – до [`request_queue_size`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.request_queue_size) запросов. Когда очередь заполняется, дальнейшие запросы от клиентов получают ошибку «Connection denied». Обычно значение по умолчанию – 5, но его можно переопределить в подклассах.181182#### `socket_type`183184Тип сокета, используемый сервером; распространённые значения: [`socket.SOCK_STREAM`](https://python-all.ru/3.12/library/socket.html#socket.SOCK_STREAM) и [`socket.SOCK_DGRAM`](https://python-all.ru/3.12/library/socket.html#socket.SOCK_DGRAM).185186#### `timeout`187188Длительность тайм-аута в секундах или [`None`](https://python-all.ru/3.12/library/constants.html#None), если тайм-аут не нужен. Если [`handle_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.handle_request) не получает входящих запросов в течение периода тайм-аута, вызывается метод [`handle_timeout()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.handle_timeout).189190Существуют различные методы сервера, которые можно переопределить в подклассах базовых классов серверов, например [`TCPServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.TCPServer); эти методы не предназначены для внешних пользователей объекта сервера.191192#### `finish_request(request, client_address)`193194Непосредственно обрабатывает запрос, создавая экземпляр [`RequestHandlerClass`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass) и вызывая его метод [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle).195196#### `get_request()`197198Должен принять запрос из сокета и вернуть кортеж из двух элементов, содержащий *новый* объект сокета для взаимодействия с клиентом и адрес клиента.199200#### `handle_error(request, client_address)`201202Эта функция вызывается, если метод [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle) экземпляра [`RequestHandlerClass`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass) возбуждает исключение. По умолчанию трассировка выводится в стандартный поток ошибок, после чего обработка следующих запросов продолжается.203204Изменено в версии 3.6: Теперь вызывается только для исключений, производных от класса [`Exception`](https://python-all.ru/3.12/library/exceptions.html#Exception).205206#### `handle_timeout()`207208Эта функция вызывается, когда атрибут [`timeout`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.timeout) установлен в значение, отличное от [`None`](https://python-all.ru/3.12/library/constants.html#None), и период тайм-аута истёк без получения запросов. По умолчанию для серверов с порождением процессов (forking) собирается статус завершившихся дочерних процессов; в многопоточных серверах этот метод ничего не делает.209210#### `process_request(request, client_address)`211212Вызывает [`finish_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.finish_request) для создания экземпляра [`RequestHandlerClass`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass). При необходимости эта функция может создать новый процесс или поток для обработки запроса; так поступают классы [`ForkingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ForkingMixIn) и [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn).213214#### `server_activate()`215216Вызывается конструктором сервера для активации сервера. По умолчанию для TCP-сервера просто вызывает [`listen()`](https://python-all.ru/3.12/library/socket.html#socket.socket.listen) на сокете сервера. Можно переопределить.217218#### `server_bind()`219220Вызывается конструктором сервера для привязки сокета к нужному адресу. Можно переопределить.221222#### `verify_request(request, client_address)`223224Должна возвращать логическое значение; если значение равно [`True`](https://python-all.ru/3.12/library/constants.html#True), запрос будет обработан, а если [`False`](https://python-all.ru/3.12/library/constants.html#False), запрос будет отклонен. Эта функция может быть переопределена для реализации контроля доступа к серверу. Реализация по умолчанию всегда возвращает [`True`](https://python-all.ru/3.12/library/constants.html#True).225226Изменено в версии 3.6: Добавлена поддержка протокола [контекстного менеджера](https://python-all.ru/3.12/glossary.html#term-context-manager). Выход из контекстного менеджера эквивалентен вызову [`server_close()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.server_close).227228## Объекты обработчика запросов229230#### `class socketserver.BaseRequestHandler`231232Это суперкласс всех объектов-обработчиков запросов. Он определяет интерфейс, приведенный ниже. Конкретный подкласс обработчика запросов должен определить новый метод [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle) и может переопределять любые другие методы. Новый экземпляр подкласса создается для каждого запроса.233234#### `setup()`235236Вызывается перед методом [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle) для выполнения необходимых действий по инициализации. Реализация по умолчанию ничего не делает.237238#### `handle()`239240Эта функция должна выполнять всю работу, необходимую для обслуживания запроса. Реализация по умолчанию ничего не делает. Ей доступны несколько атрибутов экземпляра: запрос доступен как [`request`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.request); адрес клиента как [`client_address`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.client_address); а экземпляр сервера как [`server`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.server), на случай, если потребуется доступ к информации, специфичной для сервера.241242Тип [`request`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.request) различается для служб дейтаграмм и потоков. Для потоковых служб [`request`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.request) – это объект сокета; для служб дейтаграмм [`request`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.request) – это пара из строки и сокета.243244#### `finish()`245246Вызывается после метода [`handle()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.handle) для выполнения необходимых действий по очистке. Реализация по умолчанию ничего не делает. Если [`setup()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.setup) вызывает исключение, эта функция не будет вызвана.247248#### `request`249250*Новый* объект [`socket.socket`](https://python-all.ru/3.12/library/socket.html#socket.socket), используемый для взаимодействия с клиентом.251252#### `client_address`253254Адрес клиента, возвращаемый [`BaseServer.get_request()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer.get_request).255256#### `server`257258Объект [`BaseServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseServer), используемый для обработки запроса.259260#### `class socketserver.StreamRequestHandler`261262#### `class socketserver.DatagramRequestHandler`263264Эти подклассы [`BaseRequestHandler`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler) переопределяют методы [`setup()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.setup) и [`finish()`](https://python-all.ru/3.12/library/socketserver.html#socketserver.BaseRequestHandler.finish) и предоставляют атрибуты [`rfile`](https://python-all.ru/3.12/library/socketserver.html#socketserver.DatagramRequestHandler.rfile) и [`wfile`](https://python-all.ru/3.12/library/socketserver.html#socketserver.DatagramRequestHandler.wfile).265266#### `rfile`267268Файловый объект, из которого считывается запрос. Поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.12/library/io.html#io.BufferedIOBase) readable.269270#### `wfile`271272Файловый объект, в который записывается ответ. Поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.12/library/io.html#io.BufferedIOBase) writable.273274Изменено в версии 3.6: [`wfile`](https://python-all.ru/3.12/library/socketserver.html#socketserver.DatagramRequestHandler.wfile) также поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.12/library/io.html#io.BufferedIOBase) writable.275276## Примеры277278### [`socketserver.TCPServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.TCPServer) Пример279280Это серверная сторона:281282```python283import socketserver284285class MyTCPHandler(socketserver.BaseRequestHandler):286    """287    Класс обработчика запросов для нашего сервера.288289    Он создаётся один раз на каждое подключение к серверу и должен290    переопределять метод handle() для реализации взаимодействия с291    клиентом.292    """293294    def handle(self):295        # self.request – это TCP-сокет, подключённый к клиенту296        pieces = [b'']297        total = 0298        while b'\n' not in pieces[-1] and total < 10_000:299            pieces.append(self.request.recv(2000))300            total += len(pieces[-1])301        self.data = b''.join(pieces)302        print(f"Received from {self.client_address[0]}:")303        print(self.data.decode("utf-8"))304        # просто отправляет обратно те же данные, но в верхнем регистре305        self.request.sendall(self.data.upper())306        # после возврата сокет будет закрыт.307308if __name__ == "__main__":309    HOST, PORT = "localhost", 9999310311    # Создаём сервер, привязываясь к localhost на порту 9999312    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:313        # Запускаем сервер; он будет работать, пока вы314        # не прервёте программу с помощью Ctrl-C315        server.serve_forever()316```317318Альтернативный класс обработчика запросов, который использует потоки (объекты, подобные файлам, упрощающие взаимодействие за счет предоставления стандартного файлового интерфейса):319320```python321class MyTCPHandler(socketserver.StreamRequestHandler):322323    def handle(self):324        # self.rfile – это файлоподобный объект, созданный обработчиком.325        # Теперь можно использовать, например, readline() вместо прямых вызовов recv().326        # Мы ограничиваемся 10 000 байт, чтобы избежать злоупотреблений со стороны отправителя.327        self.data = self.rfile.readline(10000).rstrip()328        print(f"{self.client_address[0]} wrote:")329        print(self.data.decode("utf-8"))330        # Аналогично, self.wfile – это файлоподобный объект, используемый для записи ответа331        # клиенту332        self.wfile.write(self.data.upper())333```334335Разница в том, что вызов `readline()` во втором обработчике будет вызывать `recv()` несколько раз, пока не встретит символ новой строки, тогда как первый обработчик должен был использовать цикл `recv()` для накопления данных до новой строки. Если бы он просто использовал один `recv()` без цикла, он бы просто вернул то, что получено от клиента на данный момент. TCP – потоковый протокол: данные приходят в порядке отправки, но нет зависимости между вызовами `send()` или `sendall()` на стороне клиента и количеством вызовов `recv()` на сервере, необходимых для их получения.336337Это клиентская сторона:338339```python340import socket341import sys342343HOST, PORT = "localhost", 9999344data = " ".join(sys.argv[1:])345346# Создать сокет (SOCK_STREAM означает TCP-сокет)347with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:348    # Подключиться к серверу и отправить данные349    sock.connect((HOST, PORT))350    sock.sendall(bytes(data, "utf-8"))351    sock.sendall(b"\n")352353    # Получить данные от сервера и завершить работу354    received = str(sock.recv(1024), "utf-8")355356print("Sent:    ", data)357print("Received:", received)358```359360Результат работы примера должен выглядеть примерно так:361362Сервер:363364```console365$ python TCPServer.py366127.0.0.1 wrote:367b'hello world with TCP'368127.0.0.1 wrote:369b'python is nice'370```371372Клиент:373374```console375$ python TCPClient.py hello world with TCP376Sent:     hello world with TCP377Received: HELLO WORLD WITH TCP378$ python TCPClient.py python is nice379Sent:     python is nice380Received: PYTHON IS NICE381```382383### [`socketserver.UDPServer`](https://python-all.ru/3.12/library/socketserver.html#socketserver.UDPServer) Пример384385Это серверная сторона:386387```python388import socketserver389390class MyUDPHandler(socketserver.BaseRequestHandler):391    """392    Этот класс работает аналогично классу-обработчику TCP, за исключением того, что393    self.request состоит из пары данных и клиентского сокета, и поскольку394    соединение отсутствует, адрес клиента должен быть указан явно395    при отправке данных обратно через sendto().396    """397398    def handle(self):399        data = self.request[0].strip()400        socket = self.request[1]401        print(f"{self.client_address[0]} wrote:")402        print(data)403        socket.sendto(data.upper(), self.client_address)404405if __name__ == "__main__":406    HOST, PORT = "localhost", 9999407    with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:408        server.serve_forever()409```410411Это клиентская сторона:412413```python414import socket415import sys416417HOST, PORT = "localhost", 9999418data = " ".join(sys.argv[1:])419420# SOCK_DGRAM – это тип сокета для UDP-сокетов421sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)422423# Как можно видеть, вызов connect() отсутствует; в UDP нет соединений.424# Вместо этого данные отправляются напрямую получателю через sendto().425sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))426received = str(sock.recv(1024), "utf-8")427428print("Sent:    ", data)429print("Received:", received)430```431432Результат работы примера должен выглядеть точно так же, как для примера TCP-сервера.433434### Асинхронные Mixins435436Для построения асинхронных обработчиков используйте классы [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn) и [`ForkingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ForkingMixIn).437438Пример для класса [`ThreadingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ThreadingMixIn):439440```python441import socket442import threading443import socketserver444445class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):446447    def handle(self):448        data = str(self.request.recv(1024), 'ascii')449        cur_thread = threading.current_thread()450        response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')451        self.request.sendall(response)452453class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):454    pass455456def client(ip, port, message):457    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:458        sock.connect((ip, port))459        sock.sendall(bytes(message, 'ascii'))460        response = str(sock.recv(1024), 'ascii')461        print("Received: {}".format(response))462463if __name__ == "__main__":464    # Порт 0 означает выбор произвольного неиспользуемого порта465    HOST, PORT = "localhost", 0466467    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)468    with server:469        ip, port = server.server_address470471        # Запустить поток для сервера – этот поток затем запустит один472        # дополнительный поток на каждый запрос473        server_thread = threading.Thread(target=server.serve_forever)474        # Завершить поток сервера при завершении главного потока475        server_thread.daemon = True476        server_thread.start()477        print("Server loop running in thread:", server_thread.name)478479        client(ip, port, "Hello World 1")480        client(ip, port, "Hello World 2")481        client(ip, port, "Hello World 3")482483        server.shutdown()484```485486Результат работы примера должен выглядеть примерно так:487488```console489$ python ThreadedTCPServer.py490Server loop running in thread: Thread-1491Received: Thread-2: Hello World 1492Received: Thread-3: Hello World 2493Received: Thread-4: Hello World 3494```495496Класс [`ForkingMixIn`](https://python-all.ru/3.12/library/socketserver.html#socketserver.ForkingMixIn) используется аналогично, за исключением того, что сервер будет создавать новый процесс для каждого запроса. Доступен только на платформах POSIX, поддерживающих [`fork()`](https://python-all.ru/3.12/library/os.html#os.fork).497