`socket.md`

877 строк · 93.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/library/socket.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.1. [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket) – низкоуровневый сетевой интерфейс89Этот модуль предоставляет доступ к интерфейсу BSD *socket*. Он доступен во всех современных Unix-системах, Windows, MacOS, OS/2 и, вероятно, на других платформах.1011> **Примечание**12>13> Некоторые аспекты поведения могут зависеть от платформы, поскольку вызовы выполняются через API сокетов операционной системы.1415Интерфейс Python представляет собой прямую трансляцию системных вызовов и библиотечного интерфейса сокетов Unix в объектно-ориентированном стиле Python: функция [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket) возвращает *объект сокета*, методы которого реализуют различные системные вызовы сокетов. Типы параметров находятся на более высоком уровне, чем в интерфейсе C: как и при операциях `read()` и `write()` с файлами Python, выделение буфера при приёме происходит автоматически, а длина буфера при отправке подразумевается неявно.1617> **См. также**18>19> **Модуль [`socketserver`](https://python-all.ru/3.3/library/socketserver.html#module-socketserver)**20>21> Классы, упрощающие написание сетевых серверов.22>23> **Модуль [`ssl`](https://python-all.ru/3.3/library/ssl.html#module-ssl)**24>25> Обёртка TLS/SSL для объектов сокетов.2627## 18.1.1. Семейства сокетов2829В зависимости от системы и параметров сборки этим модулем поддерживаются различные семейства сокетов.3031Формат адреса, требуемый для конкретного объекта сокета, автоматически выбирается на основе семейства адресов, указанного при создании объекта сокета. Адреса сокетов представляются следующим образом:3233- Адрес сокета [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX), привязанного к узлу файловой системы, представляется в виде строки с использованием кодировки файловой системы и обработчика ошибок `'surrogateescape'` (см. [**PEP 383**](https://python-all.ru/3.3/library/socket.html)). Адрес в абстрактном пространстве имён Linux возвращается как объект [`bytes`](https://python-all.ru/3.3/library/functions.html#bytes) с начальным нулевым байтом; учтите, что сокеты в этом пространстве имён могут взаимодействовать с обычными сокетами файловой системы, поэтому программам, предназначенным для работы в Linux, возможно, придётся работать с обоими типами адресов. Строку или объект [`bytes`](https://python-all.ru/3.3/library/functions.html#bytes) можно использовать для адресов любого типа при передаче в качестве аргумента.3435  > Изменено в версии 3.3: Ранее пути сокетов [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX) считались использующими кодировку UTF-8.36- Пара `(host, port)` используется для семейства адресов [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET), где *host* – строка, представляющая либо имя хоста в доменной нотации Интернета, например `'daring.cwi.nl'`, либо IPv4-адрес, например `'100.50.200.5'`, а *port* – целое число.37- Для семейства адресов [`AF_INET6`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET6) используется кортеж из четырёх элементов `(host, port, flowinfo, scopeid)`, где *flowinfo* и *scopeid* соответствуют полям `sin6_flowinfo` и `sin6_scope_id` в структуре `struct sockaddr_in6` в C. Для методов модуля [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket) *flowinfo* и *scopeid* можно опускать для обратной совместимости. Однако учтите, что пропуск *scopeid* может вызвать проблемы при работе с адресами IPv6, имеющими зону действия.38- Сокеты `AF_NETLINK` представляются в виде пар `(pid, groups)`.39- Поддержка TIPC только для Linux доступна с использованием семейства адресов `AF_TIPC`. TIPC – это открытый сетевой протокол, не основанный на IP, предназначенный для использования в кластерных вычислительных средах. Адреса представляются в виде кортежа, и поля зависят от типа адреса. Общая форма кортежа: `(addr_type, v1, v2, v3 [, scope])`, где:4041  - *addr\_type* – одно из `TIPC_ADDR_NAMESEQ`, `TIPC_ADDR_NAME`, или `TIPC_ADDR_ID`.42  - *scope* – одно из `TIPC_ZONE_SCOPE`, `TIPC_CLUSTER_SCOPE` и `TIPC_NODE_SCOPE`.43  - Если *addr\_type* – `TIPC_ADDR_NAME`, то *v1* – тип сервера, *v2* – идентификатор порта, а *v3* должно быть равно 0.4445    Если *addr\_type* – `TIPC_ADDR_NAMESEQ`, то *v1* – тип сервера, *v2* – нижний номер порта, а *v3* – верхний номер порта.4647    Если *addr\_type* – `TIPC_ADDR_ID`, то *v1* – узел, *v2* – ссылка, а *v3* должно быть установлено в 0.4849    Если *addr\_type* – `TIPC_ADDR_ID`, то *v1* – узел, *v2* – ссылка, а *v3* должно быть установлено в 0.50- Кортеж `(interface, )` используется для семейства адресов [`AF_CAN`](https://python-all.ru/3.3/library/socket.html#socket.AF_CAN), где *interface* – строка, представляющая имя сетевого интерфейса, например `'can0'`. Имя сетевого интерфейса `''` можно использовать для получения пакетов со всех сетевых интерфейсов этого семейства.51- Строка или кортеж `(id, unit)` используется для протокола `SYSPROTO_CONTROL` семейства `PF_SYSTEM`. Строка – это имя элемента управления ядра с динамически назначаемым идентификатором. Кортеж можно использовать, если идентификатор и номер модуля элемента управления ядра известны или используется зарегистрированный идентификатор.5253  Новое в версии 3.3.54- Некоторые другие семейства адресов (`AF_BLUETOOTH`, `AF_PACKET`) поддерживают особые представления.5556Для IPv4-адресов вместо адреса хоста принимаются две специальные формы: пустая строка обозначает `INADDR_ANY`, а строка `'<broadcast>'` обозначает `INADDR_BROADCAST`. Такое поведение несовместимо с IPv6, поэтому от этих форм лучше отказаться, если планируется поддержка IPv6 в программах на Python.5758Если в части *узел* адреса сокета IPv4/v6 указано имя узла, программа может демонстрировать недетерминированное поведение, так как Python использует первый адрес, возвращённый при разрешении DNS. Адрес сокета будет разрешаться по-разному в фактический IPv4/v6-адрес в зависимости от результатов разрешения DNS и/или конфигурации узла. Для детерминированного поведения используйте числовой адрес в части *узел*.5960Все ошибки порождают исключения. Могут возникать обычные исключения для недопустимых типов аргументов и нехватки памяти; начиная с Python 3.3 ошибки, связанные с семантикой сокетов или адресов, порождают [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError) или один из его подклассов (ранее они порождали [`socket.error`](https://python-all.ru/3.3/library/socket.html#socket.error)).6162Неподдерживаемый режим поддерживается через [`setblocking()`](https://python-all.ru/3.3/library/socket.html#socket.socket.setblocking). Более общий подход на основе тайм-аутов поддерживается через [`settimeout()`](https://python-all.ru/3.3/library/socket.html#socket.socket.settimeout).6364## 18.1.2. Содержание модуля6566Модуль [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket) экспортирует следующие элементы.6768### 18.1.2.1. Исключения6970#### `exception socket.error`7172Устаревший псевдоним [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).7374Изменено в версии 3.3: В соответствии с [**PEP 3151**](https://python-all.ru/3.3/library/socket.html), этот класс стал псевдонимом [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).7576#### `exception socket.herror`7778Подкласс [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), это исключение возникает при ошибках, связанных с адресами, то есть для функций, использующих *h\_errno* в C POSIX API, включая [`gethostbyname_ex()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyname_ex) и [`gethostbyaddr()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyaddr). Сопутствующее значение – это пара `(h_errno, string)`, представляющая ошибку, возвращённую вызовом библиотеки. *h\_errno* – числовое значение, а *string* – описание *h\_errno*, возвращаемое функцией `hstrerror()` из C.7980Изменено в версии 3.3: Этот класс стал подклассом [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).8182#### `exception socket.gaierror`8384Подкласс [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), это исключение вызывается для ошибок, связанных с адресами, функциями [`getaddrinfo()`](https://python-all.ru/3.3/library/socket.html#socket.getaddrinfo) и [`getnameinfo()`](https://python-all.ru/3.3/library/socket.html#socket.getnameinfo).\\nСопутствующее значение – пара `(error, string)`, представляющая ошибку, возвращённую библиотечным вызовом. *string* содержит описание *error*, возвращённое C-функцией `gai_strerror()`. Числовое значение *error* соответствует одной из констант `EAI_*`, определённых в этом модуле.8586Изменено в версии 3.3: Этот класс стал подклассом [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).8788#### `exception socket.timeout`8990Подкласс [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), это исключение вызывается, когда на сокете, для которого были включены тайм-ауты с помощью предыдущего вызова [`settimeout()`](https://python-all.ru/3.3/library/socket.html#socket.socket.settimeout) (или неявно через [`setdefaulttimeout()`](https://python-all.ru/3.3/library/socket.html#socket.setdefaulttimeout)), происходит тайм-аут. Сопутствующее значение – строка, значением которой в настоящее время всегда является «истекло время ожидания».9192Изменено в версии 3.3: Этот класс стал подклассом [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).9394### 18.1.2.2. Константы9596#### `socket.AF_UNIX`9798#### `socket.AF_INET`99100#### `socket.AF_INET6`101102Эти константы представляют семейства адресов (и протоколов), используемые для первого аргумента [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket). Если константа [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX) не определена, то этот протокол не поддерживается. В зависимости от системы могут быть доступны дополнительные константы.103104#### `socket.SOCK_STREAM`105106#### `socket.SOCK_DGRAM`107108#### `socket.SOCK_RAW`109110#### `socket.SOCK_RDM`111112#### `socket.SOCK_SEQPACKET`113114Эти константы представляют типы сокетов, используемые для второго аргумента [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket). В зависимости от системы могут быть доступны дополнительные константы. (Обычно полезными считаются только [`SOCK_STREAM`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_STREAM) и [`SOCK_DGRAM`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_DGRAM).)115116#### `socket.SOCK_CLOEXEC`117118#### `socket.SOCK_NONBLOCK`119120Эти две константы, если они определены, можно комбинировать с типами сокетов, что позволяет устанавливать некоторые флаги атомарно (тем самым избегая возможных состояний гонки и необходимости отдельных вызовов).121122> **См. также**123>124> [Безопасная обработка файловых дескрипторов](https://python-all.ru/3.3/library/socket.html) для более подробного объяснения.125126Доступность: Linux \>= 2.6.27.127128Новое в версии 3.2.129130#### `SO_*`131132#### `socket.SOMAXCONN`133134#### `MSG_*`135136#### `SOL_*`137138#### `SCM_*`139140#### `IPPROTO_*`141142#### `IPPORT_*`143144#### `INADDR_*`145146#### `IP_*`147148#### `IPV6_*`149150#### `EAI_*`151152#### `AI_*`153154#### `NI_*`155156#### `TCP_*`157158Многие константы этих форм, описанные в документации Unix по сокетам и/или протоколу IP, также определены в модуле socket. Они обычно используются в аргументах методов `setsockopt()` и `getsockopt()` объектов сокетов. В большинстве случаев определены только те символы, которые есть в заголовочных файлах Unix; для некоторых символов заданы значения по умолчанию.159160#### `socket.AF_CAN`161162#### `socket.PF_CAN`163164#### `SOL_CAN_*`165166#### `CAN_*`167168Множество констант такого вида, описанных в документации Linux, также определены в модуле socket.169170Доступность: Linux \>= 2.6.25.171172Новое в версии 3.3.173174#### `socket.AF_RDS`175176#### `socket.PF_RDS`177178#### `socket.SOL_RDS`179180#### `RDS_*`181182Множество констант такого вида, описанных в документации Linux, также определены в модуле socket.183184Доступность: Linux \>= 2.6.30.185186Новое в версии 3.3.187188#### `SIO_*`189190#### `RCVALL_*`191192Константы для функции WSAIoctl() в Windows. Эти константы используются как аргументы метода [`ioctl()`](https://python-all.ru/3.3/library/socket.html#socket.socket.ioctl) объектов сокетов.193194#### `TIPC_*`195196Константы, связанные с TIPC, соответствующие тем, что экспортируются C API сокетов. Дополнительную информацию см. в документации TIPC.197198#### `socket.has_ipv6`199200Эта константа содержит логическое значение, указывающее, поддерживается ли IPv6 на данной платформе.201202### 18.1.2.3. Функции203204#### 18.1.2.3.1. Создание сокетов205206Все следующие функции создают [*объекты сокетов*](https://python-all.ru/3.3/library/socket.html#socket-objects).207208#### `socket.socket([family[, type[, proto]]])`209210Создаёт новый сокет с указанным семейством адресов, типом сокета и номером протокола. Семейство адресов может быть [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET) (по умолчанию), [`AF_INET6`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET6), [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX), [`AF_CAN`](https://python-all.ru/3.3/library/socket.html#socket.AF_CAN) или [`AF_RDS`](https://python-all.ru/3.3/library/socket.html#socket.AF_RDS). Тип сокета должен быть [`SOCK_STREAM`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_STREAM) (по умолчанию), [`SOCK_DGRAM`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_DGRAM), [`SOCK_RAW`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_RAW) или, возможно, одна из других констант `SOCK_`. Номер протокола обычно равен нулю и в этом случае может быть опущен, или `CAN_RAW`, если семейство адресов [`AF_CAN`](https://python-all.ru/3.3/library/socket.html#socket.AF_CAN).211212Изменено в версии 3.3: Добавлено семейство AF\_CAN. Добавлено семейство AF\_RDS.213214#### `socket.socketpair([family[, type[, proto]]])`215216Создаёт пару соединённых объектов сокетов, используя указанное семейство адресов, тип сокета и номер протокола. Семейство адресов, тип сокета и номер протокола такие же, как для функции [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket) выше. Семейство по умолчанию – [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX), если оно определено на платформе; в противном случае по умолчанию используется [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET). Доступность: Unix.217218Изменено в версии 3.2: Возвращаемые объекты сокетов теперь поддерживают полный API сокетов, а не подмножество.219220#### `socket.create_connection(address[, timeout[, source_address]])`221222Подключается к TCP-сервису, ожидающему по адресу *address* в Интернете (кортеж из двух элементов `(host, port)`), и возвращает объект сокета. Это функция более высокого уровня, чем [`socket.connect()`](https://python-all.ru/3.3/library/socket.html#socket.socket.connect): если *host* – нечисловое имя хоста, она попытается разрешить его и для [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET), и для [`AF_INET6`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET6), а затем попробует подключиться ко всем возможным адресам по очереди, пока не произойдёт успешное подключение. Это упрощает написание клиентов, совместимых с IPv4 и IPv6.223224Передача необязательного параметра *timeout* установит тайм-аут для экземпляра сокета перед попыткой подключения. Если *timeout* не указан, используется глобальная настройка тайм-аута по умолчанию, возвращаемая функцией [`getdefaulttimeout()`](https://python-all.ru/3.3/library/socket.html#socket.getdefaulttimeout).225226Если указан, то *source\_address* должен быть кортежем из двух элементов `(host, port)`, чтобы сокет привязывался к нему как к исходному адресу перед подключением. Если host или port равны ‘’ или 0 соответственно, будет использовано поведение ОС по умолчанию.227228Изменено в версии 3.2: Добавлен параметр *source\_address*.229230Изменено в версии 3.2: добавлена поддержка оператора [`with`](https://python-all.ru/3.3/reference/compound_stmts.html#with).231232#### `socket.fromfd(fd, family, type[, proto])`233234Дублирует файловый дескриптор *fd* (целое число, возвращаемое методом `fileno()` объекта файла) и создаёт из результата объект сокета. Семейство адресов, тип сокета и номер протокола такие же, как у функции [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket) выше. Файловый дескриптор должен ссылаться на сокет, но это не проверяется – последующие операции с объектом могут завершиться ошибкой, если файловый дескриптор некорректен. Эта функция требуется редко, но может использоваться для получения или установки параметров сокета, переданного программе как стандартный ввод или вывод (например, сервер, запущенный демоном inet в Unix). Предполагается, что сокет находится в блокирующем режиме.235236#### `socket.fromshare(data)`237238Создаёт экземпляр сокета из данных, полученных методом [`socket.share()`](https://python-all.ru/3.3/library/socket.html#socket.socket.share). Предполагается, что сокет находится в блокирующем режиме.239240Доступность: Windows.241242Новое в версии 3.3.243244#### `socket.SocketType`245246Это объект типа Python, представляющий тип объекта сокета. Он эквивалентен `type(socket(...))`.247248#### 18.1.2.3.2. Другие функции249250Модуль [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket) также предоставляет различные сетевые сервисы:251252#### `socket.getaddrinfo(host, port, family=0, type=0, proto=0, flags=0)`253254Преобразует аргументы *host*/*port* в последовательность кортежей из 5 элементов, содержащих все необходимые аргументы для создания сокета, подключённого к этой службе. *host* – это доменное имя, строковое представление IPv4/v6-адреса или `None`. *port* – это строковое имя службы, например `'http'`, числовой номер порта или `None`. Передавая `None` в качестве значения *host* и *port*, можно передать `NULL` в нижележащий C API.255256Аргументы *family*, *type* и *proto* можно указать необязательно, чтобы сузить список возвращаемых адресов. Если передать ноль в качестве значения каждого из этих аргументов, будут выбраны все возможные результаты. Аргумент *flags* может содержать одну или несколько констант `AI_*` и влияет на то, как вычисляются и возвращаются результаты. Например, `AI_NUMERICHOST` отключает разрешение доменных имён и вызовет ошибку, если *host* является доменным именем.257258Функция возвращает список кортежей из 5 элементов со следующей структурой:259260`(family, type, proto, canonname, sockaddr)`261262В этих кортежах *family*, *type*, *proto* – целые числа, и их следует передавать функции [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket). *canonname* будет строкой, представляющей каноническое имя *host*, если `AI_CANONNAME` входит в аргумент *flags*; в противном случае *canonname* будет пустым. *sockaddr* – это кортеж, описывающий адрес сокета, формат которого зависит от возвращённого *family* (кортеж из 2 элементов `(address, port)` для [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET), кортеж из 4 элементов `(address, port, flow info, scope id)` для [`AF_INET6`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET6)), и предназначен для передачи методу [`socket.connect()`](https://python-all.ru/3.3/library/socket.html#socket.socket.connect).263264Следующий пример получает информацию об адресе для гипотетического TCP-соединения к `www.python.org` на порту 80 (на вашей системе результаты могут отличаться, если IPv6 не включён):265266```python267>>> socket.getaddrinfo("www.python.org", 80, proto=socket.SOL_TCP)268[(2, 1, 6, '', ('82.94.164.162', 80)),269 (10, 1, 6, '', ('2001:888:2000:d::a2', 80, 0, 0))]270```271272Изменено в версии 3.2: теперь параметры можно передавать в виде именованных аргументов.273274#### `socket.getfqdn([name])`275276Возвращает полное доменное имя для *name*. Если *name* опущен или пуст, он интерпретируется как локальный хост. Чтобы найти полное имя, проверяется имя хоста, возвращённое [`gethostbyaddr()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyaddr), а затем, при наличии, псевдонимы хоста. Выбирается первое имя, содержащее точку. Если полное доменное имя недоступно, возвращается имя хоста, полученное через [`gethostname()`](https://python-all.ru/3.3/library/socket.html#socket.gethostname).277278#### `socket.gethostbyname(hostname)`279280Преобразует имя хоста в формат IPv4-адреса. IPv4-адрес возвращается в виде строки, например `'100.50.200.5'`. Если само имя хоста является IPv4-адресом, оно возвращается без изменений. См. [`gethostbyname_ex()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyname_ex) для более полного интерфейса. [`gethostbyname()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyname) не поддерживает разрешение имён IPv6, поэтому для поддержки dual stack IPv4/v6 следует использовать [`getaddrinfo()`](https://python-all.ru/3.3/library/socket.html#socket.getaddrinfo).281282#### `socket.gethostbyname_ex(hostname)`283284Преобразует имя хоста в формат IPv4-адреса, расширенный интерфейс. Возвращает тройку `(hostname, aliaslist, ipaddrlist)`, где *hostname* – основное имя хоста, отвечающего на заданный *ip\_address*, *aliaslist* – (возможно, пустой) список альтернативных имён хоста для того же адреса, а *ipaddrlist* – список IPv4-адресов того же интерфейса на том же хосте (часто, но не всегда, один адрес). [`gethostbyname_ex()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyname_ex) не поддерживает разрешение имён IPv6, поэтому для поддержки dual stack IPv4/v6 следует использовать [`getaddrinfo()`](https://python-all.ru/3.3/library/socket.html#socket.getaddrinfo).285286#### `socket.gethostname()`287288Возвращает строку, содержащую имя хоста машины, на которой в данный момент выполняется интерпретатор Python.289290Если нужно узнать IP-адрес текущей машины, можно использовать `gethostbyname(gethostname())`. Эта операция предполагает, что существует корректное отображение адреса на хост, и это предположение выполняется не всегда.291292Примечание: [`gethostname()`](https://python-all.ru/3.3/library/socket.html#socket.gethostname) не всегда возвращает полное доменное имя; используйте `getfqdn()` (см. выше).293294#### `socket.gethostbyaddr(ip_address)`295296Возвращает тройку `(hostname, aliaslist, ipaddrlist)`, где *hostname* – основное имя хоста, отвечающего на заданный *ip\_address*, *aliaslist* – (возможно, пустой) список альтернативных имён хоста для того же адреса, а *ipaddrlist* – список IPv4/v6-адресов того же интерфейса на том же хосте (скорее всего, содержащий только один адрес). Чтобы найти полное доменное имя, используйте функцию [`getfqdn()`](https://python-all.ru/3.3/library/socket.html#socket.getfqdn). [`gethostbyaddr()`](https://python-all.ru/3.3/library/socket.html#socket.gethostbyaddr) поддерживает как IPv4, так и IPv6.297298#### `socket.getnameinfo(sockaddr, flags)`299300Преобразует адрес сокета *sockaddr* в кортеж из двух элементов `(host, port)`. В зависимости от настроек *flags* результат может содержать полное доменное имя или числовое представление адреса в *host*. Аналогично, *port* может содержать строковое имя порта или числовой номер порта.301302#### `socket.getprotobyname(protocolname)`303304Преобразует имя интернет-протокола (например, `'icmp'`) в константу, пригодную для передачи в качестве (необязательного) третьего аргумента функции [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket). Обычно это требуется только для сокетов, открытых в «сыром» режиме ([`SOCK_RAW`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_RAW)); для обычных режимов сокета правильный протокол выбирается автоматически, если протокол опущен или равен нулю.305306#### `socket.getservbyname(servicename[, protocolname])`307308Преобразует имя интернет-службы и имя протокола в номер порта для этой службы. Необязательное имя протокола, если указано, должно быть `'tcp'` или `'udp'`, в противном случае подойдёт любой протокол.309310#### `socket.getservbyport(port[, protocolname])`311312Преобразует номер порта и имя протокола в имя службы для этой службы. Необязательное имя протокола, если указано, должно быть `'tcp'` или `'udp'`, иначе подойдет любой протокол.313314#### `socket.ntohl(x)`315316Преобразует 32-битные положительные целые числа из сетевого порядка байтов в порядок байтов хоста. На машинах, где порядок байтов хоста совпадает с сетевым, эта операция ничего не делает; в противном случае выполняется перестановка 4 байтов.317318#### `socket.ntohs(x)`319320Преобразует 16-битные положительные целые числа из сетевого порядка байтов в порядок байтов хоста. На машинах, где порядок байтов хоста совпадает с сетевым, эта функция ничего не делает; в противном случае она выполняет обмен двух байтов.321322#### `socket.htonl(x)`323324Преобразует 32-битные положительные целые числа из порядка байтов хоста в сетевой порядок. На машинах, где порядок байтов хоста совпадает с сетевым, эта функция ничего не делает; в противном случае она выполняет обмен четырёх байтов.325326#### `socket.htons(x)`327328Преобразует 16-битные положительные целые числа из порядка байтов хоста в сетевой порядок. На машинах, где порядок байтов хоста совпадает с сетевым, эта функция ничего не делает; в противном случае она выполняет обмен двух байтов.329330#### `socket.inet_aton(ip_string)`331332Преобразует IPv4-адрес из строкового формата с точками (например, '123.45.67.89') в 32-битный упакованный двоичный формат в виде объекта bytes длиной четыре символа. Это полезно при взаимодействии с программой, использующей стандартную библиотеку C и требующей объекты типа `struct in_addr`, который является типом C для 32-битного упакованного двоичного представления, возвращаемого этой функцией.333334[`inet_aton()`](https://python-all.ru/3.3/library/socket.html#socket.inet_aton) также принимает строки с менее чем тремя точками; подробнее см. в руководстве Unix *inet(3)*.335336Если переданная этой функции строка IPv4-адреса недействительна, будет возбуждено [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError). Обратите внимание, что точное определение допустимости зависит от базовой реализации C функции `inet_aton()`.337338[`inet_aton()`](https://python-all.ru/3.3/library/socket.html#socket.inet_aton) не поддерживает IPv6, и для поддержки двойного стека IPv4/IPv6 вместо него следует использовать [`inet_pton()`](https://python-all.ru/3.3/library/socket.html#socket.inet_pton).339340#### `socket.inet_ntoa(packed_ip)`341342Преобразует 32-битный упакованный IPv4-адрес (объект bytes длиной четыре символа) в его стандартное строковое представление с точками (например, '123.45.67.89'). Это полезно при взаимодействии с программой, использующей стандартную библиотеку C и требующей объекты типа `struct in_addr`, который является типом C для 32-битных упакованных двоичных данных, принимаемых этой функцией в качестве аргумента.343344Если переданная этой функции последовательность байтов имеет длину не ровно 4 байта, будет возбуждено [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError). [`inet_ntoa()`](https://python-all.ru/3.3/library/socket.html#socket.inet_ntoa) не поддерживает IPv6, и для поддержки двойного стека IPv4/IPv6 вместо него следует использовать [`inet_ntop()`](https://python-all.ru/3.3/library/socket.html#socket.inet_ntop).345346#### `socket.inet_pton(address_family, ip_string)`347348Преобразует IP-адрес из строкового формата, зависящего от семейства, в упакованный двоичный формат. [`inet_pton()`](https://python-all.ru/3.3/library/socket.html#socket.inet_pton) полезен, когда библиотека или сетевой протокол требует объект типа `struct in_addr` (аналогично [`inet_aton()`](https://python-all.ru/3.3/library/socket.html#socket.inet_aton)) или `struct in6_addr`.349350В настоящее время поддерживаемыми значениями для *address\_family* являются [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET) и [`AF_INET6`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET6). Если строка IP-адреса *ip\_string* недействительна, будет возбуждено [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError). Обратите внимание, что точное определение допустимости зависит как от значения *address\_family*, так и от базовой реализации `inet_pton()`.351352Доступность: Unix (возможно, не на всех платформах).353354#### `socket.inet_ntop(address_family, packed_ip)`355356Convert a packed IP address (a bytes object of some number of characters) to its standard, family-specific string representation (for example, `'7.10.0.5'` or `'5aef:2b::8'`). [`inet_ntop()`](https://python-all.ru/3.3/library/socket.html#socket.inet_ntop) is useful when a library or network protocol returns an object of type `struct in_addr` (similar to [`inet_ntoa()`](https://python-all.ru/3.3/library/socket.html#socket.inet_ntoa)) or `struct in6_addr`.357358Поддерживаемые значения для *address\_family* сейчас: [`AF_INET`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET) и\\n[`AF_INET6`](https://python-all.ru/3.3/library/socket.html#socket.AF_INET6). Если строка *packed\_ip* имеет неверную длину для указанного семейства адресов, будет вызвано исключение [`ValueError`](https://python-all.ru/3.3/library/exceptions.html#ValueError).\\n[`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError) вызывается при ошибках вызова [`inet_ntop()`](https://python-all.ru/3.3/library/socket.html#socket.inet_ntop).359360Доступность: Unix (возможно, не на всех платформах).361362#### `socket.CMSG_LEN(length)`363364Возвращает общую длину (без завершающего выравнивания) элемента вспомогательных данных с соответствующими данными заданной *length*. Это значение часто можно использовать как размер буфера для [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg) для получения одного элемента вспомогательных данных, но [**RFC 3542**](https://python-all.ru/3.3/library/socket.html) требует от переносимых приложений использования [`CMSG_SPACE()`](https://python-all.ru/3.3/library/socket.html#socket.CMSG_SPACE) и, таким образом, включения пространства для выравнивания, даже если элемент будет последним в буфере. Возбуждает [`OverflowError`](https://python-all.ru/3.3/library/exceptions.html#OverflowError), если *length* выходит за допустимый диапазон значений.365366Доступность: большинство платформ Unix, возможно, и другие.367368Новое в версии 3.3.369370#### `socket.CMSG_SPACE(length)`371372Возвращает размер буфера, необходимый для [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg) для получения элемента вспомогательных данных с соответствующими данными заданной *length*, включая любое завершающее выравнивание. Пробел буфера, необходимый для получения нескольких элементов, представляет собой сумму значений [`CMSG_SPACE()`](https://python-all.ru/3.3/library/socket.html#socket.CMSG_SPACE) для соответствующих длин данных. Возбуждает [`OverflowError`](https://python-all.ru/3.3/library/exceptions.html#OverflowError), если *length* выходит за допустимый диапазон значений.373374Обратите внимание, что некоторые системы могут поддерживать вспомогательные данные, не предоставляя эту функцию. Также обратите внимание, что установка размера буфера с использованием результатов этой функции может не точно ограничить объём принимаемых вспомогательных данных, поскольку дополнительные данные могут поместиться в область выравнивания.375376Доступность: большинство платформ Unix, возможно, и другие.377378Новое в версии 3.3.379380#### `socket.getdefaulttimeout()`381382Возвращает тайм-аут по умолчанию в секундах (float) для новых сокетов. Значение `None` означает, что новые сокеты не имеют тайм-аута. При первом импорте модуля socket значение по умолчанию равно `None`.383384#### `socket.setdefaulttimeout(timeout)`385386Устанавливает тайм-аут по умолчанию в секундах (float) для новых сокетов. При первом импорте модуля socket значение по умолчанию равно `None`. См. [`settimeout()`](https://python-all.ru/3.3/library/socket.html#socket.socket.settimeout) для возможных значений и их соответствующих значений.387388#### `socket.sethostname(name)`389390Устанавливает имя узла на *name*. Это вызовет исключение [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), если недостаточно прав.391392Доступность: Unix.393394Новое в версии 3.3.395396#### `socket.if_nameindex()`397398Возвращает список кортежей с информацией о сетевых интерфейсах (индекс int, имя string). [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), если системный вызов завершается неудачей.399400Доступность: Unix.401402Новое в версии 3.3.403404#### `socket.if_nametoindex(if_name)`405406Возвращает номер индекса сетевого интерфейса, соответствующий имени интерфейса. [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), если интерфейса с указанным именем не существует.407408Доступность: Unix.409410Новое в версии 3.3.411412#### `socket.if_indextoname(if_index)`413414Возвращает имя сетевого интерфейса, соответствующее номеру индекса интерфейса.\\n[`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError), если интерфейс с указанным индексом не существует.415416Доступность: Unix.417418Новое в версии 3.3.419420## 18.1.3. Объекты сокетов421422Объекты сокетов имеют следующие методы. За исключением [`makefile()`](https://python-all.ru/3.3/library/socket.html#socket.socket.makefile), они соответствуют системным вызовам Unix, применимым к сокетам.423424#### `socket.accept()`425426Принимает соединение. Сокет должен быть привязан к адресу и прослушивать соединения. Возвращаемое значение – пара `(conn, address)`, где *conn* – это *новый* объект сокета, который можно использовать для отправки и получения данных по соединению, а *address* – это адрес, привязанный к сокету на другом конце соединения.427428#### `socket.bind(address)`429430Привязывает сокет к *address*. Сокет не должен быть уже привязан. (Формат *address* зависит от семейства адресов – см. выше.)431432#### `socket.close()`433434Помечает сокет как закрытый. Базовый системный ресурс (например, файловый дескриптор) также закрывается, когда все файловые объекты из [`makefile()`](https://python-all.ru/3.3/library/socket.html#socket.socket.makefile) закрыты. Как только это происходит, все последующие операции с объектом сокета завершаются ошибкой. Удаленная сторона больше не будет получать данные (после сброса поставленных в очередь данных).435436Сокеты автоматически закрываются при сборке мусора, но рекомендуется явно закрывать их с помощью [`close()`](https://python-all.ru/3.3/library/socket.html#socket.socket.close) или использовать оператор [`with`](https://python-all.ru/3.3/reference/compound_stmts.html#with) для работы с ними.437438> **Примечание**439>440> [`close()`](https://python-all.ru/3.3/library/socket.html#socket.socket.close) освобождает ресурс, связанный с соединением, но не обязательно закрывает соединение немедленно. Если требуется вовремя закрыть соединение, вызовите [`shutdown()`](https://python-all.ru/3.3/library/socket.html#socket.socket.shutdown) перед [`close()`](https://python-all.ru/3.3/library/socket.html#socket.socket.close).441442#### `socket.connect(address)`443444Подключается к удалённому сокету по адресу *address*. (Формат *address* зависит от семейства адресов – см. выше.)445446#### `socket.connect_ex(address)`447448Как и `connect(address)`, но возвращает индикатор ошибки вместо вызова исключения для ошибок, возвращаемых вызовом `connect()` на уровне C (другие проблемы, такие как «хост не найден», по-прежнему могут вызывать исключения). Индикатор ошибки равен `0`, если операция выполнена успешно, в противном случае – значению переменной `errno`. Это полезно, например, для поддержки асинхронных соединений.449450#### `socket.detach()`451452Переводит объект сокета в закрытое состояние без фактического закрытия базового файлового дескриптора. Файловый дескриптор возвращается и может быть повторно использован для других целей.453454Новое в версии 3.2.455456#### `socket.fileno()`457458Возвращает файловый дескриптор сокета (небольшое целое число). Это полезно с [`select.select()`](https://python-all.ru/3.3/library/select.html#select.select).459460В Windows небольшое целое число, возвращаемое этим методом, нельзя использовать там, где может использоваться файловый дескриптор (например, в [`os.fdopen()`](https://python-all.ru/3.3/library/os.html#os.fdopen)). В Unix такого ограничения нет.461462#### `socket.getpeername()`463464Возвращает удалённый адрес, к которому подключён сокет. Это полезно, например, для определения номера порта удалённого сокета IPv4/v6. (Формат возвращаемого адреса зависит от семейства адресов – см. выше.) На некоторых системах эта функция не поддерживается.465466#### `socket.getsockname()`467468Возвращает собственный адрес сокета. Это полезно, например, для определения номера порта сокета IPv4/v6. (Формат возвращаемого адреса зависит от семейства адресов – см. выше.)469470#### `socket.getsockopt(level, optname[, buflen])`471472Возвращает значение указанной опции сокета (см. страницу man Unix *getsockopt(2)*). Необходимые символьные константы (`SO_*` и т.д.) определены в этом модуле. Если *buflen* отсутствует, предполагается целочисленная опция, и функция возвращает её целочисленное значение. Если *buflen* присутствует, он задает максимальную длину буфера для получения опции, и этот буфер возвращается в виде объекта bytes. Вызывающий код должен сам декодировать содержимое буфера (см. опциональный встроенный модуль [`struct`](https://python-all.ru/3.3/library/struct.html#module-struct) для способа декодирования структур C, закодированных как байтовые строки).473474#### `socket.gettimeout()`475476Возвращает тайм-аут в секундах (число с плавающей точкой), связанный с операциями сокета, или `None`, если тайм-аут не установлен. Это значение отражает последний вызов [`setblocking()`](https://python-all.ru/3.3/library/socket.html#socket.socket.setblocking) или [`settimeout()`](https://python-all.ru/3.3/library/socket.html#socket.socket.settimeout).477478#### `socket.ioctl(control, option)`479480| Платформа: | Windows |481| --- | --- |482483Метод [`ioctl()`](https://python-all.ru/3.3/library/socket.html#socket.socket.ioctl) представляет собой ограниченный интерфейс к системному интерфейсу WSAIoctl. Для получения дополнительной информации обратитесь к [документации Win32](https://python-all.ru/3.3/library/socket.html).484485On other platforms, the generic [`fcntl.fcntl()`](https://python-all.ru/3.3/library/fcntl.html#fcntl.fcntl) and [`fcntl.ioctl()`](https://python-all.ru/3.3/library/fcntl.html#fcntl.ioctl) functions may be used; they accept a socket object as their first argument.486487#### `socket.listen(backlog)`488489Ожидает подключения к сокету. Аргумент *backlog* задаёт максимальное количество ожидающих соединений в очереди и должен быть не меньше 0; максимальное значение зависит от системы (обычно 5), минимальное принудительно устанавливается в 0.490491#### `socket.makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)`492493Возвращает [*файловый объект*](https://python-all.ru/3.3/glossary.html#term-file-object), связанный с сокетом. Точный возвращаемый тип зависит от аргументов, переданных в [`makefile()`](https://python-all.ru/3.3/library/socket.html#socket.socket.makefile). Эти аргументы интерпретируются так же, как и встроенной функцией [`open()`](https://python-all.ru/3.3/library/functions.html#open).494495Сокет должен быть в блокирующем режиме; у него может быть тайм-аут, но внутренний буфер файлового объекта может оказаться в несогласованном состоянии, если тайм-аут сработает.496497Закрытие файлового объекта, возвращённого [`makefile()`](https://python-all.ru/3.3/library/socket.html#socket.socket.makefile), не закроет исходный сокет, пока не будут закрыты все остальные файловые объекты и для объекта сокета не будет вызван [`socket.close()`](https://python-all.ru/3.3/library/socket.html#socket.socket.close).498499> **Примечание**500>501> В Windows файлоподобный объект, созданный [`makefile()`](https://python-all.ru/3.3/library/socket.html#socket.socket.makefile), нельзя использовать там, где требуется файловый объект с файловым дескриптором, например в аргументах потока [`subprocess.Popen()`](https://python-all.ru/3.3/library/subprocess.html#subprocess.Popen).502503#### `socket.recv(bufsize[, flags])`504505Получает данные из сокета. Возвращает объект bytes с полученными данными. Максимальный объём данных за одно получение задаётся параметром *bufsize*. Значение необязательного аргумента *flags* описано на странице руководства Unix *recv(2)*; по умолчанию он равен нулю.506507> **Примечание**508>509> Для наилучшего соответствия реальным характеристикам оборудования и сети значение *bufsize* должно быть относительно небольшой степенью двойки, например, 4096.510511#### `socket.recvfrom(bufsize[, flags])`512513Receive data from the socket. The return value is a pair `(bytes, address)` where *bytes* is a bytes object representing the data received and *address* is the address of the socket sending the data. See the Unix manual page *recv(2)* for the meaning of the optional argument *flags*; it defaults to zero. (The format of *address* depends on the address family – see above.)514515#### `socket.recvmsg(bufsize[, ancbufsize[, flags]])`516517Получает из сокета обычные данные (до *bufsize* байт) и вспомогательные данные. Аргумент *ancbufsize* задаёт размер внутреннего буфера для вспомогательных данных в байтах; по умолчанию равен 0, то есть вспомогательные данные не принимаются. Подходящие размеры буфера для вспомогательных данных можно вычислить с помощью [`CMSG_SPACE()`](https://python-all.ru/3.3/library/socket.html#socket.CMSG_SPACE) или [`CMSG_LEN()`](https://python-all.ru/3.3/library/socket.html#socket.CMSG_LEN); элементы, не помещающиеся в буфер, могут быть обрезаны или отброшены. Аргумент *flags* по умолчанию равен 0 и имеет то же значение, что и для [`recv()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recv).518519Возвращаемое значение – кортеж из 4 элементов: `(data, ancdata, msg_flags, address)`. Элемент *data* – объект [`bytes`](https://python-all.ru/3.3/library/functions.html#bytes), содержащий принятые невспомогательные данные. Элемент *ancdata* – список из нуля или более кортежей `(cmsg_level, cmsg_type, cmsg_data)`, представляющих полученные вспомогательные данные (управляющие сообщения): *cmsg\_level* и *cmsg\_type* – целые числа, задающие уровень протокола и тип в рамках протокола соответственно, а *cmsg\_data* – объект [`bytes`](https://python-all.ru/3.3/library/functions.html#bytes) с соответствующими данными. Элемент *msg\_flags* – побитовое ИЛИ различных флагов, указывающих на условия полученного сообщения; подробности смотрите в системной документации. Если принимающий сокет не подключён, *address* – адрес отправляющего сокета, если он доступен; в противном случае его значение не определено.520521В некоторых системах [`sendmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.sendmsg) и [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg) можно использовать для передачи файловых дескрипторов между процессами через сокет [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX). При использовании этой возможности (она часто ограничена сокетами [`SOCK_STREAM`](https://python-all.ru/3.3/library/socket.html#socket.SOCK_STREAM)) [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg) вернёт во вспомогательных данных элементы вида `(socket.SOL_SOCKET, socket.SCM_RIGHTS, fds)`, где *fds* – объект [`bytes`](https://python-all.ru/3.3/library/functions.html#bytes), представляющий новые файловые дескрипторы в виде двоичного массива нативного типа C `int`. Если [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg) вызывает исключение после возврата системного вызова, она сначала попытается закрыть все файловые дескрипторы, полученные через этот механизм.522523Некоторые системы не указывают усечённую длину элементов вспомогательных данных, которые были получены лишь частично. Если элемент выходит за пределы буфера, [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg) выдаст [`RuntimeWarning`](https://python-all.ru/3.3/library/exceptions.html#RuntimeWarning) и вернёт ту часть, которая находится в буфере, при условии, что он не был усечён до начала своих данных.524525В системах, поддерживающих механизм `SCM_RIGHTS`, следующая функция будет получать до *maxfds* файловых дескрипторов, возвращая данные сообщения и список с дескрипторами (игнорируя неожиданные ситуации, такие как получение посторонних управляющих сообщений). См. также [`sendmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.sendmsg).526527```python528import socket, array529530def recv_fds(sock, msglen, maxfds):531    fds = array.array("i")   # Массив целых чисел532    msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize))533    for cmsg_level, cmsg_type, cmsg_data in ancdata:534        if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS):535            # Добавить данные, игнорируя любые усечённые целые числа в конце.536            fds.fromstring(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])537    return msg, list(fds)538```539540Доступность: большинство платформ Unix, возможно, и другие.541542Новое в версии 3.3.543544#### `socket.recvmsg_into(buffers[, ancbufsize[, flags]])`545546Получает из сокета обычные и вспомогательные данные, ведя себя как [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg), но разбрасывает невспомогательные данные по нескольким буферам, а не возвращает новый объект bytes. Аргумент *buffers* должен быть итерируемым объектом, элементы которого предоставляют буферы для записи (например, объекты [`bytearray`](https://python-all.ru/3.3/library/functions.html#bytearray)); они будут заполняться последовательными частями невспомогательных данных, пока те не будут полностью записаны или не кончатся буферы. Операционная система может устанавливать ограничение (значение [`sysconf()`](https://python-all.ru/3.3/library/os.html#os.sysconf) `SC_IOV_MAX`) на количество используемых буферов. Аргументы *ancbufsize* и *flags* имеют то же значение, что и для [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg).547548Возвращаемое значение – кортеж из 4 элементов: `(nbytes, ancdata, msg_flags, address)`, где *nbytes* – общее количество байт невспомогательных данных, записанных в буферы, а *ancdata*, *msg\_flags* и *address* такие же, как для [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg).549550Пример:551552```python553>>> import socket554>>> s1, s2 = socket.socketpair()555>>> b1 = bytearray(b'----')556>>> b2 = bytearray(b'0123456789')557>>> b3 = bytearray(b'--------------')558>>> s1.send(b'Mary had a little lamb')55922560>>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3])561(22, [], 0, None)562>>> [b1, b2, b3]563[bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]564```565566Доступность: большинство платформ Unix, возможно, и другие.567568Новое в версии 3.3.569570#### `socket.recvfrom_into(buffer[, nbytes[, flags]])`571572Receive data from the socket, writing it into *buffer* instead of creating a new bytestring. The return value is a pair `(nbytes, address)` where *nbytes* is the number of bytes received and *address* is the address of the socket sending the data. See the Unix manual page *recv(2)* for the meaning of the optional argument *flags*; it defaults to zero. (The format of *address* depends on the address family – see above.)573574#### `socket.recv_into(buffer[, nbytes[, flags]])`575576Получает из сокета до *nbytes* байтов, сохраняя данные в буфер, а не создавая новую строку байтов. Если *nbytes* не указан (или равен 0), принимает столько байтов, сколько помещается в переданный буфер. Возвращает количество полученных байтов. Значение необязательного аргумента *flags* описано на странице руководства Unix *recv(2)*; по умолчанию он равен нулю.577578#### `socket.send(bytes[, flags])`579580Отправляет данные в сокет. Сокет должен быть подключён к удалённому сокету. Необязательный аргумент *flags* имеет то же значение, что и для [`recv()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recv) выше. Возвращает количество отправленных байт. Приложения должны проверять, что все данные были отправлены; если передана только часть данных, приложению необходимо попытаться доставить остаток. Дополнительную информацию по этой теме можно найти в [*Socket Programming HOWTO*](https://python-all.ru/3.3/howto/sockets.html#socket-howto).581582#### `socket.sendall(bytes[, flags])`583584Отправляет данные в сокет. Сокет должен быть подключён к удалённому сокету. Необязательный аргумент *flags* имеет то же значение, что и для [`recv()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recv) выше. В отличие от [`send()`](https://python-all.ru/3.3/library/socket.html#socket.socket.send), этот метод продолжает отправлять данные из *bytes*, пока не будут отправлены все данные или не возникнет ошибка. В случае успеха возвращается `None`. При ошибке вызывается исключение, и невозможно определить, сколько данных (если вообще было) было успешно отправлено.585586#### `socket.sendto(bytes, address)`587588#### `socket.sendto(bytes, flags, address)`589590Отправляет данные в сокет. Сокет не должен быть подключён к удалённому сокету, так как целевой сокет задаётся аргументом *address*. Необязательный аргумент *flags* имеет то же значение, что и для [`recv()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recv) выше. Возвращает количество отправленных байт. (Формат *address* зависит от семейства адресов – см. выше.)591592#### `socket.sendmsg(buffers[, ancdata[, flags[, address]]])`593594Отправляет обычные и вспомогательные данные в сокет, собирая не-вспомогательные данные из серии буферов и объединяя их в одно сообщение. Аргумент *buffers* задаёт не-вспомогательные данные в виде итерабильного набора объектов, совместимых с буферами (например, объекты [`bytes`](https://python-all.ru/3.3/library/functions.html#bytes)); операционная система может установить ограничение (значение [`sysconf()`](https://python-all.ru/3.3/library/os.html#os.sysconf) `SC_IOV_MAX`) на количество используемых буферов. Аргумент *ancdata* задаёт вспомогательные данные (управляющие сообщения) в виде итерабильного набора из нуля или более кортежей `(cmsg_level, cmsg_type, cmsg_data)`, где *cmsg\_level* и *cmsg\_type* – целые числа, задающие уровень протокола и тип протокола соответственно, а *cmsg\_data* – объект, совместимый с буфером, содержащий соответствующие данные. Обратите внимание, что некоторые системы (в частности, системы без [`CMSG_SPACE()`](https://python-all.ru/3.3/library/socket.html#socket.CMSG_SPACE)) могут поддерживать отправку только одного управляющего сообщения за вызов. Аргумент *flags* по умолчанию равен 0 и имеет тот же смысл, что и для [`send()`](https://python-all.ru/3.3/library/socket.html#socket.socket.send). Если указан *address* и он не равен `None`, он задаёт адрес назначения сообщения. Возвращаемое значение – количество отправленных байт не-вспомогательных данных.595596Следующая функция отправляет список файловых дескрипторов *fds* через сокет [`AF_UNIX`](https://python-all.ru/3.3/library/socket.html#socket.AF_UNIX) в системах, поддерживающих механизм `SCM_RIGHTS`. См. также [`recvmsg()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recvmsg).597598```python599import socket, array600601def send_fds(sock, msg, fds):602    return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])603```604605Доступность: большинство платформ Unix, возможно, и другие.606607Новое в версии 3.3.608609#### `socket.setblocking(flag)`610611Устанавливает блокирующий или неблокирующий режим сокета: если *flag* равен false, сокет переводится в неблокирующий режим, иначе в блокирующий.612613Этот метод является сокращением для некоторых вызовов [`settimeout()`](https://python-all.ru/3.3/library/socket.html#socket.socket.settimeout):614615- `sock.setblocking(True)` эквивалентно `sock.settimeout(None)`616- `sock.setblocking(False)` эквивалентно `sock.settimeout(0.0)`617618#### `socket.settimeout(value)`619620Устанавливает тайм-аут для блокирующих операций с сокетом. Аргумент *value* может быть неотрицательным числом с плавающей запятой, выражающим секунды, или `None`. Если задано ненулевое значение, последующие операции с сокетом будут вызывать исключение [`timeout`](https://python-all.ru/3.3/library/socket.html#socket.timeout), если период тайм-аута *value* истек до завершения операции. Если задан ноль, сокет переводится в неблокирующий режим. Если задано `None`, сокет переводится в блокирующий режим.621622Для получения дополнительной информации обратитесь к [*заметкам о тайм-аутах сокетов*](https://python-all.ru/3.3/library/socket.html#socket-timeouts).623624#### `socket.setsockopt(level, optname, value)`625626Устанавливает значение указанной опции сокета (см. страницу руководства Unix *setsockopt(2)*). Необходимые символические константы определены в модуле [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket) (`SO_*` и т.д.). Значение может быть целым числом или объектом bytes, представляющим буфер. В последнем случае вызывающий должен убедиться, что последовательность байтов содержит правильные биты (см. опциональный встроенный модуль [`struct`](https://python-all.ru/3.3/library/struct.html#module-struct) для способа кодирования C-структур в виде байтовых строк).627628#### `socket.shutdown(how)`629630Завершает одну или обе половины соединения. Если *how* равно `SHUT_RD`, дальнейший приём запрещён. Если *how* равно `SHUT_WR`, дальнейшая отправка запрещена. Если *how* равно `SHUT_RDWR`, дальнейшие отправка и приём запрещены.631632#### `socket.share(process_id)`633634Дублирует сокет и подготавливает его для передачи целевому процессу. Целевой процесс должен быть указан с помощью *process\_id*. Полученный объект bytes затем может быть передан целевому процессу с использованием какой-либо формы межпроцессного взаимодействия, и сокет может быть воссоздан там с помощью [`fromshare()`](https://python-all.ru/3.3/library/socket.html#socket.fromshare). После вызова этого метода сокет можно безопасно закрыть, так как операционная система уже продублировала его для целевого процесса.635636Доступность: Windows.637638Новое в версии 3.3.639640Обратите внимание, что методов `read()` или `write()` не существует; вместо них используйте [`recv()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recv) и [`send()`](https://python-all.ru/3.3/library/socket.html#socket.socket.send) без аргумента *flags*.641642Объекты сокетов также имеют следующие (только для чтения) атрибуты, которые соответствуют значениям, переданным конструктору [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket).643644#### `socket.family`645646Семейство сокета.647648#### `socket.type`649650Тип сокета.651652#### `socket.proto`653654Протокол сокета.655656## 18.1.4. Замечания по тайм-аутам сокетов657658Объект сокета может находиться в одном из трёх режимов: блокирующем, неблокирующем или с тайм-аутом. По умолчанию сокеты всегда создаются в блокирующем режиме, но это можно изменить, вызвав [`setdefaulttimeout()`](https://python-all.ru/3.3/library/socket.html#socket.setdefaulttimeout).659660- В *блокирующем режиме* операции блокируются до завершения или пока система не вернет ошибку (например, истекло время соединения).661- В *неблокирующем режиме* операции завершаются ошибкой (с ошибкой, которая, к сожалению, зависит от системы), если их нельзя выполнить немедленно: функции из модуля [`select`](https://python-all.ru/3.3/library/select.html#module-select) можно использовать, чтобы узнать, когда и доступен ли сокет для чтения или записи.662- В *режиме с тайм-аутом* операции завершаются ошибкой, если их нельзя выполнить в течение тайм-аута, указанного для сокета (они вызывают исключение [`timeout`](https://python-all.ru/3.3/library/socket.html#socket.timeout)), или если система возвращает ошибку.663664> **Примечание**665>666> На уровне операционной системы сокеты в *режиме с тайм-аутом* внутренне устанавливаются в неблокирующий режим. Кроме того, блокирующий режим и режим тайм-аута разделяются между файловыми дескрипторами и объектами сокетов, которые относятся к одной и той же сетевой конечной точке. Эта деталь реализации может иметь заметные последствия, если, например, вы решите использовать [`fileno()`](https://python-all.ru/3.3/library/socket.html#socket.socket.fileno) сокета.667668### 18.1.4.1. Тайм-ауты и метод `connect`669670Операция [`connect()`](https://python-all.ru/3.3/library/socket.html#socket.socket.connect) также подчиняется настройке тайм-аута, и в целом рекомендуется вызывать [`settimeout()`](https://python-all.ru/3.3/library/socket.html#socket.socket.settimeout) перед вызовом [`connect()`](https://python-all.ru/3.3/library/socket.html#socket.socket.connect) или передавать параметр тайм-аута в [`create_connection()`](https://python-all.ru/3.3/library/socket.html#socket.create_connection). Однако сетевой стек системы также может вернуть собственную ошибку тайм-аута соединения независимо от любой настройки тайм-аута сокета Python.671672### 18.1.4.2. Тайм-ауты и метод `accept`673674Если [`getdefaulttimeout()`](https://python-all.ru/3.3/library/socket.html#socket.getdefaulttimeout) не равно [`None`](https://python-all.ru/3.3/library/constants.html#None), сокеты, возвращаемые методом [`accept()`](https://python-all.ru/3.3/library/socket.html#socket.socket.accept), наследуют этот тайм-аут. В противном случае поведение зависит от настроек прослушивающего сокета:675676- если прослушивающий сокет находится в *блокирующем режиме* или в *режиме с тайм-аутом*, сокет, возвращённый [`accept()`](https://python-all.ru/3.3/library/socket.html#socket.socket.accept), находится в *блокирующем режиме*;677- если прослушивающий сокет находится в *неблокирующем режиме*, то, будет ли сокет, возвращённый [`accept()`](https://python-all.ru/3.3/library/socket.html#socket.socket.accept), в блокирующем или неблокирующем режиме, зависит от операционной системы. Если вы хотите обеспечить кроссплатформенное поведение, рекомендуется вручную переопределить эту настройку.678679## 18.1.5. Пример680681Вот четыре минимальных примера программ, использующих протокол TCP/IP: сервер, который отправляет обратно все полученные данные (обслуживая только одного клиента), и клиент, использующий его. Обратите внимание, что сервер должен выполнить последовательность [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket), [`bind()`](https://python-all.ru/3.3/library/socket.html#socket.socket.bind), [`listen()`](https://python-all.ru/3.3/library/socket.html#socket.socket.listen), [`accept()`](https://python-all.ru/3.3/library/socket.html#socket.socket.accept) (возможно, повторяя [`accept()`](https://python-all.ru/3.3/library/socket.html#socket.socket.accept) для обслуживания более одного клиента), в то время как клиенту нужна только последовательность [`socket()`](https://python-all.ru/3.3/library/socket.html#socket.socket), [`connect()`](https://python-all.ru/3.3/library/socket.html#socket.socket.connect). Также обратите внимание, что сервер не вызывает [`sendall()`](https://python-all.ru/3.3/library/socket.html#socket.socket.sendall)/[`recv()`](https://python-all.ru/3.3/library/socket.html#socket.socket.recv) на сокете, который он прослушивает, а на новом сокете, возвращённом [`accept()`](https://python-all.ru/3.3/library/socket.html#socket.socket.accept).682683Первые два примера поддерживают только IPv4.684685```python686# Программа эхо-сервера687import socket688689HOST = ''                 # Символическое имя, обозначающее все доступные интерфейсы690PORT = 50007              # Произвольный непривилегированный порт691s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)692s.bind((HOST, PORT))693s.listen(1)694conn, addr = s.accept()695print('Connected by', addr)696while True:697    data = conn.recv(1024)698    if not data: break699    conn.sendall(data)700conn.close()701```702703```python704# Программа эхо-клиента705import socket706707HOST = 'daring.cwi.nl'    # Удалённый хост708PORT = 50007              # Тот же порт, что и у сервера709s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)710s.connect((HOST, PORT))711s.sendall(b'Hello, world')712data = s.recv(1024)713s.close()714print('Received', repr(data))715```716717Следующие два примера идентичны двум предыдущим, но поддерживают как IPv4, так и IPv6. Серверная сторона будет прослушивать первое доступное семейство адресов (ей следовало бы прослушивать оба). На большинстве систем, готовых к IPv6, IPv6 будет иметь приоритет, и сервер может не принимать IPv4-трафик. Клиентская сторона попытается подключиться ко всем адресам, полученным в результате разрешения имен, и отправляет трафик на первый успешно подключенный.718719```python720# Программа эхо-сервера721import socket722import sys723724HOST = None               # Символическое имя, обозначающее все доступные интерфейсы725PORT = 50007              # Произвольный непривилегированный порт726s = None727for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,728                              socket.SOCK_STREAM, 0, socket.AI_PASSIVE):729    af, socktype, proto, canonname, sa = res730    try:731        s = socket.socket(af, socktype, proto)732    except OSError as msg:733        s = None734        continue735    try:736        s.bind(sa)737        s.listen(1)738    except OSError as msg:739        s.close()740        s = None741        continue742    break743if s is None:744    print('could not open socket')745    sys.exit(1)746conn, addr = s.accept()747print('Connected by', addr)748while True:749    data = conn.recv(1024)750    if not data: break751    conn.send(data)752conn.close()753```754755```python756# Программа эхо-клиента757import socket758import sys759760HOST = 'daring.cwi.nl'    # Удалённый хост761PORT = 50007              # Тот же порт, что и у сервера762s = None763for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):764    af, socktype, proto, canonname, sa = res765    try:766        s = socket.socket(af, socktype, proto)767    except OSError as msg:768        s = None769        continue770    try:771        s.connect(sa)772    except OSError as msg:773        s.close()774        s = None775        continue776    break777if s is None:778    print('could not open socket')779    sys.exit(1)780s.sendall(b'Hello, world')781data = s.recv(1024)782s.close()783print('Received', repr(data))784```785786Следующий пример показывает, как написать очень простой снифер сети с помощью сырых сокетов в Windows. Для изменения интерфейса пример требует прав администратора:787788```python789import socket790791# общедоступный сетевой интерфейс792HOST = socket.gethostbyname(socket.gethostname())793794# создать сырой сокет и привязать его к общедоступному интерфейсу795s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)796s.bind((HOST, 0))797798# Включать IP-заголовки799s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)800801# принять все пакеты802s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)803804# принять пакет805print(s.recvfrom(65565))806807# неразборчивый режим отключён808s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)809```810811Последний пример показывает, как использовать интерфейс сокетов для взаимодействия с сетью CAN. Для этого примера могут потребоваться специальные привилегии:812813```python814import socket815import struct816817# Упаковка/распаковка CAN-фреймов (см. 'struct can_frame' в <linux/can.h>)818819can_frame_fmt = "=IB3x8s"820can_frame_size = struct.calcsize(can_frame_fmt)821822def build_can_frame(can_id, data):823    can_dlc = len(data)824    data = data.ljust(8, b'\x00')825    return struct.pack(can_frame_fmt, can_id, can_dlc, data)826827def dissect_can_frame(frame):828    can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)829    return (can_id, can_dlc, data[:can_dlc])830831# создать сырой сокет и привязать его к интерфейсу 'vcan0'832s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW)833s.bind(('vcan0',))834835while True:836    cf, addr = s.recvfrom(can_frame_size)837838    print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))839840    try:841        s.send(cf)842    except OSError:843        print('Error sending CAN frame')844845    try:846        s.send(build_can_frame(0x01, b'\x01\x02\x03'))847    except OSError:848        print('Error sending CAN frame')849```850851Запуск примера несколько раз со слишком маленькой задержкой между выполнениями может привести к этой ошибке:852853```python854OSError: [Errno 98] Address already in use855```856857Это связано с тем, что предыдущее выполнение оставило сокет в состоянии `TIME_WAIT`, и его нельзя сразу использовать повторно.858859Существует флаг [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket), который можно установить, чтобы предотвратить это: `socket.SO_REUSEADDR`860861```python862s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)863s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)864s.bind((HOST, PORT))865```866867флаг `SO_REUSEADDR` указывает ядру повторно использовать локальный сокет в состоянии `TIME_WAIT`, не дожидаясь истечения его естественного тайм-аута.868869> **См. также**870>871> Для ознакомления с программированием сокетов (на C) см. следующие статьи:872>873> - *Вводное руководство по межпроцессному взаимодействию в 4.3BSD*, Стюарт Сечрест874> - *Продвинутое руководство по межпроцессному взаимодействию в 4.3BSD*, Сэмюэл Дж. Леффлер и др.875>876> Оба находятся в UNIX Programmer’s Manual, Supplementary Documents 1 (разделы PS1:7 и PS1:8). Справочные материалы по сокетным системным вызовам для конкретных платформ также являются ценным источником информации о деталях семантики сокетов. Для Unix обращайтесь к страницам руководства; для Windows – к спецификации WinSock (или Winsock 2). Для API с поддержкой IPv6 читателю может быть полезно обратиться к [**RFC 3493**](https://python-all.ru/3.3/library/socket.html) под названием Basic Socket Interface Extensions for IPv6.877