`socketserver.md`

501 строк · 43.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/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.14/Lib/socketserver.py)1011---1213Модуль `socketserver` упрощает создание сетевых серверов.1415[Доступность](https://python-all.ru/3/library/intro.html#availability): не WASI.1617Этот модуль не работает или недоступен на WebAssembly. Подробнее см. [платформы WebAssembly](https://python-all.ru/3/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/library/socketserver.html#socketserver.BaseServer.server_bind) и [`server_activate()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_activate). Остальные параметры передаются базовому классу [`BaseServer`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer).2425#### `class socketserver.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)`2627Использует дейтаграммы – отдельные пакеты информации, которые могут приходить не по порядку или теряться при передаче. Параметры те же, что и у [`TCPServer`](https://python-all.ru/3/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/library/socketserver.html#socketserver.TCPServer).3435Эти четыре класса обрабатывают запросы *синхронно*: каждый запрос должен быть завершён до того, как начнётся следующий. Это не подходит, если каждый запрос требует много времени на выполнение из-за вычислительной сложности или большого объёма возвращаемых данных, которые клиент обрабатывает медленно. Решение – создавать отдельный процесс или поток для обработки каждого запроса; классы-примеси [`ForkingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ForkingMixIn) и [`ThreadingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn) позволяют реализовать асинхронное поведение.3637Создание сервера состоит из нескольких этапов. Сначала необходимо создать класс-обработчик запросов, унаследовав его от [`BaseRequestHandler`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler) и переопределив метод [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle); этот метод будет обрабатывать входящие запросы. Затем нужно создать экземпляр одного из классов сервера, передав ему адрес сервера и класс-обработчик. Рекомендуется использовать сервер в операторе [`with`](https://python-all.ru/3/reference/compound_stmts.html#with). После этого вызовите метод [`handle_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.handle_request) или [`serve_forever()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.serve_forever) объекта сервера для обработки одного или нескольких запросов. Наконец, вызовите [`server_close()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_close) для закрытия сокета (если только не использовался оператор `with`).3839При наследовании от [`ThreadingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn) для поддержки многопоточности следует явно указать, как потоки должны вести себя при резком завершении работы. Класс `ThreadingMixIn` определяет атрибут *daemon\_threads*, который указывает, должен ли сервер ожидать завершения потоков. Установите этот флаг явно, если хотите, чтобы потоки работали автономно; значение по умолчанию – [`False`](https://python-all.ru/3/library/constants.html#False), то есть Python не завершится, пока все потоки, созданные `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/library/socketserver.html#socketserver.UnixDatagramServer) наследуется от [`UDPServer`](https://python-all.ru/3/library/socketserver.html#socketserver.UDPServer), а не от [`UnixStreamServer`](https://python-all.ru/3/library/socketserver.html#socketserver.UnixStreamServer) – единственное различие между IP-сервером и сервером Unix заключается в семействе адресов.6465#### `class socketserver.ForkingMixIn`6667#### `class socketserver.ThreadingMixIn`6869Версии с порождением процессов и потоками для каждого типа сервера можно создать с помощью этих классов-примесей. Например, [`ThreadingUDPServer`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingUDPServer) создаётся следующим образом:7071```python72class ThreadingUDPServer(ThreadingMixIn, UDPServer):73    pass74```7576Класс-примесь указывается первым, поскольку он переопределяет метод, определённый в [`UDPServer`](https://python-all.ru/3/library/socketserver.html#socketserver.UDPServer). Установка различных атрибутов также изменяет поведение базового механизма сервера.7778`ForkingMixIn` и классы Forking, упомянутые ниже, доступны только на POSIX-платформах, поддерживающих [`fork()`](https://python-all.ru/3/library/os.html#os.fork).7980#### `block_on_close`8182[`ForkingMixIn.server_close`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_close) ожидает завершения всех дочерних процессов, за исключением случая, когда атрибут [`block_on_close`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) равен `False`.8384[`ThreadingMixIn.server_close`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_close) ожидает завершения всех не-демонических потоков, за исключением случая, когда атрибут [`block_on_close`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) равен `False`.8586#### `max_children`8788Задаёт максимальное количество дочерних процессов, одновременно обрабатывающих запросы для `ForkingMixIn`. Если лимит достигнут, новые запросы ожидают завершения одного из дочерних процессов.8990#### `daemon_threads`9192Для `ThreadingMixIn` используются демонические потоки, если установить [`ThreadingMixIn.daemon_threads`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn.daemon_threads) в `True` – чтобы не ожидать завершения потоков.9394Изменено в версии 3.7: [`ForkingMixIn.server_close`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_close) и `ThreadingMixIn.server_close` теперь ожидают завершения всех дочерних процессов и не-демонических потоков. Добавлен новый атрибут класса [`ForkingMixIn.block_on_close`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close) для сохранения поведения, предшествующего версии 3.7.9596#### `class socketserver.ForkingTCPServer`9798#### `class socketserver.ForkingUDPServer`99100#### `class socketserver.ThreadingTCPServer`101102#### `class socketserver.ThreadingUDPServer`103104#### `class socketserver.ForkingUnixStreamServer`105106#### `class socketserver.ForkingUnixDatagramServer`107108#### `class socketserver.ThreadingUnixStreamServer`109110#### `class socketserver.ThreadingUnixDatagramServer`111112Эти классы предварительно определены с использованием примесных классов.113114Добавлено в версии 3.12: Классы `ForkingUnixStreamServer` и `ForkingUnixDatagramServer` были добавлены.115116Чтобы реализовать службу, необходимо создать класс, наследующий от [`BaseRequestHandler`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler), и переопределить его метод [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle). Затем можно запускать различные версии службы, комбинируя один из классов сервера с классом обработчика запросов. Класс обработчика запросов должен различаться для служб датаграмм и потоков. Эту сложность можно скрыть, используя подклассы обработчиков [`StreamRequestHandler`](https://python-all.ru/3/library/socketserver.html#socketserver.StreamRequestHandler) или [`DatagramRequestHandler`](https://python-all.ru/3/library/socketserver.html#socketserver.DatagramRequestHandler).117118Конечно, нужно подходить с умом. Например, нет смысла использовать сервер с порождением процессов (forking), если служба хранит состояние в памяти, которое может изменяться разными запросами, потому что изменения в дочернем процессе никогда не попадут в исходное состояние, хранящееся в родительском процессе и передаваемое каждому дочернему. В этом случае можно использовать потоковый сервер (threading), но, скорее всего, придётся использовать блокировки для защиты целостности общих данных.119120С другой стороны, если создаётся HTTP-сервер, где все данные хранятся внешне (например, в файловой системе), синхронный класс фактически сделает службу «глухой» на время обработки одного запроса – что может занять очень много времени, если клиент медленно получает все запрошенные данные. Здесь подойдёт потоковый сервер или сервер с порождением процессов.121122В некоторых случаях может быть уместно обработать часть запроса синхронно, но завершить обработку в порождённом дочернем процессе в зависимости от данных запроса. Этого можно добиться, используя синхронный сервер и выполняя явный fork (порождение процесса) в методе [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle) класса обработчика запросов.123124Другой подход к обработке нескольких одновременных запросов в среде, не поддерживающей ни потоки, ни [`fork()`](https://python-all.ru/3/library/os.html#os.fork) (или если они слишком дороги или неподходящи для службы) – поддерживать явную таблицу частично выполненных запросов и использовать [`selectors`](https://python-all.ru/3/library/selectors.html#module-selectors) для определения, какой запрос обрабатывать следующим (или нужно ли обрабатывать новый входящий запрос). Это особенно важно для потоковых служб, где каждый клиент может потенциально оставаться подключённым долгое время (если потоки или подпроцессы не могут использоваться).125126## Объекты сервера127128#### `class socketserver.BaseServer(server_address, RequestHandlerClass)`129130Это суперкласс для всех объектов Server в модуле. Он определяет интерфейс, приведенный ниже, но не реализует большинство методов – это делается в подклассах. Два параметра хранятся в соответствующих атрибутах [`server_address`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_address) и [`RequestHandlerClass`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass).131132#### `fileno()`133134Возвращает целочисленный файловый дескриптор сокета, на котором сервер прослушивает соединения. Эта функция чаще всего передается в [`selectors`](https://python-all.ru/3/library/selectors.html#module-selectors), чтобы обеспечить мониторинг нескольких серверов в одном процессе.135136#### `handle_request()`137138Обрабатывает один запрос. Эта функция вызывает следующие методы по порядку: [`get_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.get_request), [`verify_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.verify_request) и [`process_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.process_request). Если предоставленный пользователем метод [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle) класса-обработчика вызывает исключение, вызывается метод [`handle_error()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.handle_error) сервера. Если в течение [`timeout`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.timeout) секунд не поступило ни одного запроса, будет вызван [`handle_timeout()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.handle_timeout), и `handle_request()` завершится.139140#### `serve_forever(poll_interval=0.5)`141142Обрабатывает запросы до явного запроса [`shutdown()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.shutdown). Опрашивает завершение каждые *poll\_interval* секунд. Игнорирует атрибут [`timeout`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.timeout). Также вызывает [`service_actions()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.service_actions), который может использоваться подклассом или миксином для предоставления действий, специфичных для данной службы. Например, класс [`ForkingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ForkingMixIn) использует `service_actions()` для очистки процессов-зомби.143144Изменено в версии 3.3: Добавлен вызов `service_actions` в метод `serve_forever`.145146#### `service_actions()`147148Вызывается в цикле [`serve_forever()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.serve_forever). Этот метод может быть переопределен подклассами или классами-миксинами для выполнения действий, специфичных для данной службы, например, действий по очистке.149150Добавлено в версии 3.3.151152#### `shutdown()`153154Сообщает циклу [`serve_forever()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.serve_forever) остановиться и ждет завершения. `shutdown()` должен вызываться, пока `serve_forever()` выполняется в другом потоке, иначе возникнет взаимоблокировка.155156#### `server_close()`157158Выполняет очистку сервера. Может быть переопределен.159160#### `address_family`161162Семейство протоколов, к которому принадлежит сокет сервера. Типичные примеры: [`socket.AF_INET`](https://python-all.ru/3/library/socket.html#socket.AF_INET), [`socket.AF_INET6`](https://python-all.ru/3/library/socket.html#socket.AF_INET6) и [`socket.AF_UNIX`](https://python-all.ru/3/library/socket.html#socket.AF_UNIX). Наследуйте классы TCP- или UDP-сервера из этого модуля, установив атрибут класса `address_family = AF_INET6`, если нужны классы сервера для IPv6.163164#### `RequestHandlerClass`165166Класс обработчика запросов, предоставленный пользователем; экземпляр этого класса создаётся для каждого запроса.167168#### `server_address`169170Адрес, на котором сервер принимает соединения. Формат адресов зависит от семейства протоколов; подробнее см. документацию модуля [`socket`](https://python-all.ru/3/library/socket.html#module-socket). Для интернет-протоколов это кортеж, содержащий строку с адресом и целочисленный номер порта: например, `('127.0.0.1', 80)`.171172#### `socket`173174Объект сокета, через который сервер будет принимать входящие запросы.175176Классы серверов поддерживают следующие переменные класса:177178#### `allow_reuse_address`179180Определяет, разрешает ли сервер повторное использование адреса. По умолчанию [`False`](https://python-all.ru/3/library/constants.html#False); значение можно изменить в подклассах, чтобы задать другую политику.181182#### `request_queue_size`183184Размер очереди запросов. Если обработка одного запроса занимает много времени, запросы, поступающие, пока сервер занят, помещаются в очередь – до [`request_queue_size`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.request_queue_size) запросов. Когда очередь заполняется, дальнейшие запросы от клиентов получают ошибку «Connection denied». Обычно значение по умолчанию – 5, но его можно переопределить в подклассах.185186#### `socket_type`187188Тип сокета, используемый сервером; распространённые значения: [`socket.SOCK_STREAM`](https://python-all.ru/3/library/socket.html#socket.SOCK_STREAM) и [`socket.SOCK_DGRAM`](https://python-all.ru/3/library/socket.html#socket.SOCK_DGRAM).189190#### `timeout`191192Длительность тайм-аута в секундах или [`None`](https://python-all.ru/3/library/constants.html#None), если тайм-аут не нужен. Если [`handle_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.handle_request) не получает входящих запросов в течение периода тайм-аута, вызывается метод [`handle_timeout()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.handle_timeout).193194Существуют различные методы сервера, которые можно переопределить в подклассах базовых классов серверов, например [`TCPServer`](https://python-all.ru/3/library/socketserver.html#socketserver.TCPServer); эти методы не предназначены для внешних пользователей объекта сервера.195196#### `finish_request(request, client_address)`197198Непосредственно обрабатывает запрос, создавая экземпляр [`RequestHandlerClass`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass) и вызывая его метод [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle).199200#### `get_request()`201202Должен принять запрос из сокета и вернуть кортеж из двух элементов, содержащий *новый* объект сокета для взаимодействия с клиентом и адрес клиента.203204#### `handle_error(request, client_address)`205206Эта функция вызывается, если метод [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle) экземпляра [`RequestHandlerClass`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass) возбуждает исключение. По умолчанию трассировка выводится в стандартный поток ошибок, после чего обработка следующих запросов продолжается.207208Изменено в версии 3.6: Теперь вызывается только для исключений, производных от класса [`Exception`](https://python-all.ru/3/library/exceptions.html#Exception).209210#### `handle_timeout()`211212Эта функция вызывается, когда атрибут [`timeout`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.timeout) установлен в значение, отличное от [`None`](https://python-all.ru/3/library/constants.html#None), и период тайм-аута истёк без получения запросов. По умолчанию для серверов с порождением процессов (forking) собирается статус завершившихся дочерних процессов; в многопоточных серверах этот метод ничего не делает.213214#### `process_request(request, client_address)`215216Вызывает [`finish_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.finish_request) для создания экземпляра [`RequestHandlerClass`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass). При необходимости эта функция может создать новый процесс или поток для обработки запроса; так поступают классы [`ForkingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ForkingMixIn) и [`ThreadingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn).217218#### `server_activate()`219220Вызывается конструктором сервера для активации сервера. По умолчанию для TCP-сервера просто вызывает [`listen()`](https://python-all.ru/3/library/socket.html#socket.socket.listen) на сокете сервера. Можно переопределить.221222#### `server_bind()`223224Вызывается конструктором сервера для привязки сокета к нужному адресу. Можно переопределить.225226#### `verify_request(request, client_address)`227228Должна возвращать логическое значение; если значение равно [`True`](https://python-all.ru/3/library/constants.html#True), запрос будет обработан, а если [`False`](https://python-all.ru/3/library/constants.html#False), запрос будет отклонен. Эта функция может быть переопределена для реализации контроля доступа к серверу. Реализация по умолчанию всегда возвращает `True`.229230Изменено в версии 3.6: Добавлена поддержка протокола [контекстного менеджера](https://python-all.ru/3/glossary.html#term-context-manager). Выход из контекстного менеджера эквивалентен вызову [`server_close()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.server_close).231232## Объекты обработчика запросов233234#### `class socketserver.BaseRequestHandler`235236Это суперкласс всех объектов-обработчиков запросов. Он определяет интерфейс, приведенный ниже. Конкретный подкласс обработчика запросов должен определить новый метод [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle) и может переопределять любые другие методы. Новый экземпляр подкласса создается для каждого запроса.237238#### `setup()`239240Вызывается перед методом [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle) для выполнения необходимых действий по инициализации. Реализация по умолчанию ничего не делает.241242#### `handle()`243244Эта функция должна выполнять всю работу, необходимую для обслуживания запроса. Реализация по умолчанию ничего не делает. Ей доступны несколько атрибутов экземпляра: запрос доступен как [`request`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.request); адрес клиента как [`client_address`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.client_address); а экземпляр сервера как [`server`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.server), на случай, если потребуется доступ к информации, специфичной для сервера.245246Тип [`request`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.request) различается для служб дейтаграмм и потоков. Для потоковых служб `request` – это объект сокета; для служб дейтаграмм `request` – это пара из строки и сокета.247248#### `finish()`249250Вызывается после метода [`handle()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.handle) для выполнения необходимых действий по очистке. Реализация по умолчанию ничего не делает. Если [`setup()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.setup) вызывает исключение, эта функция не будет вызвана.251252#### `request`253254*Новый* объект [`socket.socket`](https://python-all.ru/3/library/socket.html#socket.socket), используемый для взаимодействия с клиентом.255256#### `client_address`257258Адрес клиента, возвращаемый [`BaseServer.get_request()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer.get_request).259260#### `server`261262Объект [`BaseServer`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseServer), используемый для обработки запроса.263264#### `class socketserver.StreamRequestHandler`265266#### `class socketserver.DatagramRequestHandler`267268Эти подклассы [`BaseRequestHandler`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler) переопределяют методы [`setup()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.setup) и [`finish()`](https://python-all.ru/3/library/socketserver.html#socketserver.BaseRequestHandler.finish) и предоставляют атрибуты [`rfile`](https://python-all.ru/3/library/socketserver.html#socketserver.DatagramRequestHandler.rfile) и [`wfile`](https://python-all.ru/3/library/socketserver.html#socketserver.DatagramRequestHandler.wfile).269270#### `rfile`271272Файловый объект, из которого считывается запрос. Поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3/library/io.html#io.BufferedIOBase) readable.273274#### `wfile`275276Файловый объект, в который записывается ответ. Поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3/library/io.html#io.BufferedIOBase) writable.277278Изменено в версии 3.6: [`wfile`](https://python-all.ru/3/library/socketserver.html#socketserver.DatagramRequestHandler.wfile) также поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3/library/io.html#io.BufferedIOBase) writable.279280## Примеры281282### [`socketserver.TCPServer`](https://python-all.ru/3/library/socketserver.html#socketserver.TCPServer) Пример283284Это сторона сервера:285286```python287import socketserver288289class MyTCPHandler(socketserver.BaseRequestHandler):290    """291    Класс обработчика запросов для нашего сервера.292293    Он создаётся один раз на каждое подключение к серверу и должен294    переопределять метод handle() для реализации взаимодействия с295    клиентом.296    """297298    def handle(self):299        # self.request – это TCP-сокет, подключённый к клиенту300        pieces = [b'']301        total = 0302        while b'\n' not in pieces[-1] and total < 10_000:303            pieces.append(self.request.recv(2000))304            total += len(pieces[-1])305        self.data = b''.join(pieces)306        print(f"Received from {self.client_address[0]}:")307        print(self.data.decode("utf-8"))308        # просто отправляет обратно те же данные, но в верхнем регистре309        self.request.sendall(self.data.upper())310        # после возврата сокет будет закрыт.311312if __name__ == "__main__":313    HOST, PORT = "localhost", 9999314315    # Создаём сервер, привязываясь к localhost на порту 9999316    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:317        # Запускаем сервер; он будет работать, пока вы318        # не прервёте программу с помощью Ctrl-C319        server.serve_forever()320```321322Альтернативный класс обработчика запросов, который использует потоки (объекты, подобные файлам, упрощающие взаимодействие за счет предоставления стандартного файлового интерфейса):323324```python325class MyTCPHandler(socketserver.StreamRequestHandler):326327    def handle(self):328        # self.rfile – это файлоподобный объект, созданный обработчиком.329        # Теперь можно использовать, например, readline() вместо прямых вызовов recv().330        # Мы ограничиваемся 10 000 байт, чтобы избежать злоупотреблений со стороны отправителя.331        self.data = self.rfile.readline(10000).rstrip()332        print(f"{self.client_address[0]} wrote:")333        print(self.data.decode("utf-8"))334        # Аналогично, self.wfile – это файлоподобный объект, используемый для записи ответа335        # клиенту336        self.wfile.write(self.data.upper())337```338339Разница в том, что вызов `readline()` во втором обработчике вызывает `recv()` несколько раз, пока не встретит символ новой строки, тогда как первый обработчик должен был использовать цикл `recv()` для накопления данных до символа новой строки. Если бы он использовал один `recv()` без цикла, он бы просто вернул то, что было получено от клиента на данный момент. TCP основан на потоках: данные поступают в том порядке, в котором были отправлены, но нет корреляции между вызовами клиента `send()` или `sendall()` и количеством вызовов `recv()` на сервере, необходимых для их получения.340341Это сторона клиента:342343```python344import socket345import sys346347HOST, PORT = "localhost", 9999348data = " ".join(sys.argv[1:])349350# Создать сокет (SOCK_STREAM означает TCP-сокет)351with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:352    # Подключиться к серверу и отправить данные353    sock.connect((HOST, PORT))354    sock.sendall(bytes(data, "utf-8"))355    sock.sendall(b"\n")356357    # Получить данные от сервера и завершить работу358    received = str(sock.recv(1024), "utf-8")359360print("Sent:    ", data)361print("Received:", received)362```363364Вывод примера должен выглядеть примерно так:365366Сервер:367368```console369$ python TCPServer.py370127.0.0.1 wrote:371b'hello world with TCP'372127.0.0.1 wrote:373b'python is nice'374```375376Клиент:377378```console379$ python TCPClient.py hello world with TCP380Sent:     hello world with TCP381Received: HELLO WORLD WITH TCP382$ python TCPClient.py python is nice383Sent:     python is nice384Received: PYTHON IS NICE385```386387### [`socketserver.UDPServer`](https://python-all.ru/3/library/socketserver.html#socketserver.UDPServer) Пример388389Это серверная сторона:390391```python392import socketserver393394class MyUDPHandler(socketserver.BaseRequestHandler):395    """396    Этот класс работает аналогично классу-обработчику TCP, за исключением того, что397    self.request состоит из пары данных и клиентского сокета, и поскольку398    соединение отсутствует, адрес клиента должен быть указан явно399    при отправке данных обратно через sendto().400    """401402    def handle(self):403        data = self.request[0].strip()404        socket = self.request[1]405        print(f"{self.client_address[0]} wrote:")406        print(data)407        socket.sendto(data.upper(), self.client_address)408409if __name__ == "__main__":410    HOST, PORT = "localhost", 9999411    with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:412        server.serve_forever()413```414415Это клиентская сторона:416417```python418import socket419import sys420421HOST, PORT = "localhost", 9999422data = " ".join(sys.argv[1:])423424# SOCK_DGRAM – это тип сокета для UDP-сокетов425sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)426427# Как можно видеть, вызов connect() отсутствует; в UDP нет соединений.428# Вместо этого данные отправляются напрямую получателю через sendto().429sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))430received = str(sock.recv(1024), "utf-8")431432print("Sent:    ", data)433print("Received:", received)434```435436Результат работы примера должен выглядеть точно так же, как для примера TCP-сервера.437438### Асинхронные Mixins439440Для построения асинхронных обработчиков используйте классы [`ThreadingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn) и [`ForkingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ForkingMixIn).441442Пример для класса [`ThreadingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ThreadingMixIn):443444```python445import socket446import threading447import socketserver448449class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):450451    def handle(self):452        data = str(self.request.recv(1024), 'ascii')453        cur_thread = threading.current_thread()454        response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')455        self.request.sendall(response)456457class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):458    pass459460def client(ip, port, message):461    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:462        sock.connect((ip, port))463        sock.sendall(bytes(message, 'ascii'))464        response = str(sock.recv(1024), 'ascii')465        print("Received: {}".format(response))466467if __name__ == "__main__":468    # Порт 0 означает выбор произвольного неиспользуемого порта469    HOST, PORT = "localhost", 0470471    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)472    with server:473        ip, port = server.server_address474475        # Запустить поток для сервера – этот поток затем запустит один476        # дополнительный поток на каждый запрос477        server_thread = threading.Thread(target=server.serve_forever)478        # Завершить поток сервера при завершении главного потока479        server_thread.daemon = True480        server_thread.start()481        print("Server loop running in thread:", server_thread.name)482483        client(ip, port, "Hello World 1")484        client(ip, port, "Hello World 2")485        client(ip, port, "Hello World 3")486487        server.shutdown()488```489490Результат работы примера должен выглядеть примерно так:491492```console493$ python ThreadedTCPServer.py494Server loop running in thread: Thread-1495Received: Thread-2: Hello World 1496Received: Thread-3: Hello World 2497Received: Thread-4: Hello World 3498```499500Класс [`ForkingMixIn`](https://python-all.ru/3/library/socketserver.html#socketserver.ForkingMixIn) используется аналогично, за исключением того, что сервер будет создавать новый процесс для каждого запроса. Доступен только на платформах POSIX, поддерживающих [`fork()`](https://python-all.ru/3/library/os.html#os.fork).501