Содержание страницы
18.1. socket – Low-level networking interface¶
Этот модуль предоставляет доступ к интерфейсу сокетов BSD. Он доступен во всех современных системах Unix, Windows, MacOS и, возможно, на других платформах.
Примечание
Некоторые аспекты поведения могут зависеть от платформы, поскольку вызовы выполняются через API сокетов операционной системы.
Интерфейс Python представляет собой прямую трансляцию системных вызовов и библиотечного интерфейса сокетов Unix в объектно-ориентированном стиле Python: функция socket() возвращает объект сокета, методы которого реализуют различные системные вызовы сокетов. Типы параметров находятся на более высоком уровне, чем в интерфейсе C: как и при операциях read() и write() с файлами Python, выделение буфера при приёме происходит автоматически, а длина буфера при отправке подразумевается неявно.
См. также
- Модуль socketserver
- Классы, упрощающие написание сетевых серверов.
- Модуль ssl
- Обёртка TLS/SSL для объектов сокетов.
18.1.1. Семейства сокетов¶Socket families
В зависимости от системы и параметров сборки этим модулем поддерживаются различные семейства сокетов.
Формат адреса, требуемый для конкретного объекта сокета, автоматически выбирается на основе семейства адресов, указанного при создании объекта сокета. Адреса сокетов представляются следующим образом:
Адрес сокета AF_UNIX, привязанного к узлу файловой системы, представляется в виде строки с использованием кодировки файловой системы и обработчика ошибок 'surrogateescape' (см. PEP 383). Адрес в абстрактном пространстве имён Linux возвращается как объект bytes с начальным нулевым байтом; учтите, что сокеты в этом пространстве имён могут взаимодействовать с обычными сокетами файловой системы, поэтому программам, предназначенным для работы в Linux, возможно, придётся работать с обоими типами адресов. Строку или объект bytes можно использовать для адресов любого типа при передаче в качестве аргумента.
Изменено в версии 3.3: Ранее пути сокетов AF_UNIX считались использующими кодировку UTF-8.
Пара (host, port) используется для семейства адресов AF_INET, где host – строка, представляющая либо имя хоста в доменной нотации Интернета, например 'daring.cwi.nl', либо IPv4-адрес, например '100.50.200.5', а port – целое число.
Для семейства адресов AF_INET6 используется кортеж из четырёх элементов (host, port, flowinfo, scopeid), где flowinfo и scopeid соответствуют полям sin6_flowinfo и sin6_scope_id в структуре struct sockaddr_in6 в C. Для методов модуля socket flowinfo и scopeid можно опускать для обратной совместимости. Однако учтите, что пропуск scopeid может вызвать проблемы при работе с адресами IPv6, имеющими зону действия.
Сокеты AF_NETLINK представляются в виде пар (pid, groups).
Поддержка TIPC только для Linux доступна с использованием семейства адресов AF_TIPC. TIPC – это открытый сетевой протокол, не основанный на IP, предназначенный для использования в кластерных вычислительных средах. Адреса представляются в виде кортежа, и поля зависят от типа адреса. Общая форма кортежа: (addr_type, v1, v2, v3 [, scope]), где:
addr_type – одно из TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, или TIPC_ADDR_ID.
scope – одно из TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE и TIPC_NODE_SCOPE.
Если addr_type – TIPC_ADDR_NAME, то v1 – тип сервера, v2 – идентификатор порта, а v3 должно быть равно 0.
Если addr_type – TIPC_ADDR_NAMESEQ, то v1 – тип сервера, v2 – нижний номер порта, а v3 – верхний номер порта.
Если addr_type – TIPC_ADDR_ID, то v1 – узел, v2 – ссылка, а v3 должно быть установлено в 0.
Кортеж (interface, ) используется для семейства адресов AF_CAN, где interface – строка, представляющая имя сетевого интерфейса, например 'can0'. Имя сетевого интерфейса '' можно использовать для получения пакетов со всех сетевых интерфейсов этого семейства.
Строка или кортеж (id, unit) используется для протокола SYSPROTO_CONTROL семейства PF_SYSTEM. Строка – это имя элемента управления ядра с динамически назначаемым идентификатором. Кортеж можно использовать, если идентификатор и номер модуля элемента управления ядра известны или используется зарегистрированный идентификатор.
Новое в версии 3.3.
AF_BLUETOOTH поддерживает следующие протоколы и форматы адресов:
BTPROTO_L2CAP принимает (bdaddr, psm), где bdaddr – Bluetooth-адрес в виде строки, а psm – целое число.
BTPROTO_RFCOMM принимает (bdaddr, channel), где bdaddr – Bluetooth-адрес в виде строки, а channel – целое число.
BTPROTO_HCI принимает (device_id,), где device_id – либо целое число, либо строка с Bluetooth-адресом интерфейса. (Зависит от ОС; NetBSD и DragonFlyBSD ожидают Bluetooth-адрес, а все остальные – целое число.)
Изменено в версии 3.2: Добавлена поддержка NetBSD и DragonFlyBSD.
BTPROTO_SCO принимает bdaddr, где bdaddr – объект bytes, содержащий Bluetooth-адрес в строковом формате (например, b'12:23:34:45:56:67'). Этот протокол не поддерживается в FreeBSD.
Некоторые другие семейства адресов (AF_PACKET, AF_CAN) поддерживают особые представления.
Для IPv4-адресов вместо адреса хоста принимаются две специальные формы: пустая строка обозначает INADDR_ANY, а строка '<broadcast>' обозначает INADDR_BROADCAST. Такое поведение несовместимо с IPv6, поэтому от этих форм лучше отказаться, если планируется поддержка IPv6 в программах на Python.
Если в части узел адреса сокета IPv4/v6 указано имя узла, программа может демонстрировать недетерминированное поведение, так как Python использует первый адрес, возвращённый при разрешении DNS. Адрес сокета будет разрешаться по-разному в фактический IPv4/v6-адрес в зависимости от результатов разрешения DNS и/или конфигурации узла. Для детерминированного поведения используйте числовой адрес в части узел.
Все ошибки порождают исключения. Могут возникать обычные исключения для недопустимых типов аргументов и нехватки памяти; начиная с Python 3.3 ошибки, связанные с семантикой сокетов или адресов, порождают OSError или один из его подклассов (ранее они порождали socket.error).
Неподдерживаемый режим поддерживается через setblocking(). Более общий подход на основе тайм-аутов поддерживается через settimeout().
18.1.2. Содержание модуля¶Module contents
Модуль socket экспортирует следующие элементы.
18.1.2.1. Исключения¶Exceptions
- exception socket.herror¶
Подкласс OSError, это исключение возникает при ошибках, связанных с адресами, то есть для функций, использующих h_errno в C POSIX API, включая gethostbyname_ex() и gethostbyaddr(). Сопутствующее значение – это пара (h_errno, string), представляющая ошибку, возвращённую вызовом библиотеки. h_errno – числовое значение, а string – описание h_errno, возвращаемое функцией hstrerror() из C.
Изменено в версии 3.3: Этот класс стал подклассом OSError.
- exception socket.gaierror¶
Подкласс OSError, это исключение вызывается для ошибок, связанных с адресами, функциями getaddrinfo() и getnameinfo().\nСопутствующее значение – пара (error, string), представляющая ошибку, возвращённую библиотечным вызовом. string содержит описание error, возвращённое C-функцией gai_strerror(). Числовое значение error соответствует одной из констант EAI_*, определённых в этом модуле.
Изменено в версии 3.3: Этот класс стал подклассом OSError.
- exception socket.timeout¶
Подкласс OSError, это исключение вызывается, когда на сокете, для которого были включены тайм-ауты с помощью предыдущего вызова settimeout() (или неявно через setdefaulttimeout()), происходит тайм-аут. Сопутствующее значение – строка, значением которой в настоящее время всегда является «истекло время ожидания».
Изменено в версии 3.3: Этот класс стал подклассом OSError.
18.1.2.2. Константы¶Constants
Константы AF_* и SOCK_* теперь являются AddressFamily и\nSocketKind коллекциями IntEnum.
Новое в версии 3.4.
- socket.AF_UNIX¶
- socket.AF_INET¶
- socket.AF_INET6¶
Эти константы представляют семейства адресов (и протоколов), используемые для первого аргумента socket(). Если константа AF_UNIX не определена, то этот протокол не поддерживается. В зависимости от системы могут быть доступны дополнительные константы.
- socket.SOCK_STREAM¶
- socket.SOCK_DGRAM¶
- socket.SOCK_RAW¶
- socket.SOCK_RDM¶
- socket.SOCK_SEQPACKET¶
Эти константы представляют типы сокетов, используемые для второго аргумента socket(). В зависимости от системы могут быть доступны дополнительные константы. (Обычно полезными считаются только SOCK_STREAM и SOCK_DGRAM.)
- socket.SOCK_CLOEXEC¶
- socket.SOCK_NONBLOCK¶
Эти две константы, если они определены, можно комбинировать с типами сокетов, что позволяет устанавливать некоторые флаги атомарно (тем самым избегая возможных состояний гонки и необходимости отдельных вызовов).
См. также
Безопасная обработка файловых дескрипторов для более подробного объяснения.
Доступность: Linux >= 2.6.27.
Новое в версии 3.2.
- SO_*
- socket.SOMAXCONN¶
- MSG_*
- SOL_*
- SCM_*
- IPPROTO_*
- IPPORT_*
- INADDR_*
- IP_*
- IPV6_*
- EAI_*
- AI_*
- NI_*
- TCP_*
Многие константы этих форм, описанные в документации Unix по сокетам и/или протоколу IP, также определены в модуле socket. Они обычно используются в аргументах методов setsockopt() и getsockopt() объектов сокетов. В большинстве случаев определены только те символы, которые есть в заголовочных файлах Unix; для некоторых символов заданы значения по умолчанию.
- socket.AF_CAN¶
- socket.PF_CAN¶
- SOL_CAN_*
- CAN_*
Множество констант такого вида, описанных в документации Linux, также определены в модуле socket.
Доступность: Linux >= 2.6.25.
Новое в версии 3.3.
- socket.CAN_BCM¶
- CAN_BCM_*
CAN_BCM в семействе протоколов CAN – это протокол broadcast manager (BCM). Константы broadcast manager, описанные в документации Linux, также определены в модуле socket.
Доступность: Linux >= 2.6.25.
Новое в версии 3.4.
- socket.AF_RDS¶
- socket.PF_RDS¶
- socket.SOL_RDS¶
- RDS_*
Множество констант такого вида, описанных в документации Linux, также определены в модуле socket.
Доступность: Linux >= 2.6.30.
Новое в версии 3.3.
- SIO_*
- RCVALL_*
Константы для функции WSAIoctl() в Windows. Эти константы используются как аргументы метода ioctl() объектов сокетов.
- TIPC_*
Константы, связанные с TIPC, соответствующие тем, что экспортируются C API сокетов. Дополнительную информацию см. в документации TIPC.
- socket.AF_LINK¶
Доступность: BSD, OSX.
Новое в версии 3.4.
- socket.has_ipv6¶
Эта константа содержит логическое значение, указывающее, поддерживается ли IPv6 на данной платформе.
- socket.BDADDR_ANY¶
- socket.BDADDR_LOCAL¶
Это строковые константы, содержащие Bluetooth-адреса со специальным значением. Например, BDADDR_ANY можно использовать для указания любого адреса при привязке сокета к BTPROTO_RFCOMM.
- socket.HCI_FILTER¶
- socket.HCI_TIME_STAMP¶
- socket.HCI_DATA_DIR¶
Для использования с BTPROTO_HCI. HCI_FILTER недоступен в NetBSD или DragonFlyBSD. HCI_TIME_STAMP и HCI_DATA_DIR недоступны в FreeBSD, NetBSD или DragonFlyBSD.
18.1.2.3. Функции¶Functions
18.1.2.3.1. Создание сокетов¶Creating sockets
Все следующие функции создают объекты сокетов.
- socket.socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)¶
Создаёт новый сокет с указанным семейством адресов, типом сокета и номером протокола. Семейство адресов должно быть AF_INET (по умолчанию), AF_INET6, AF_UNIX, AF_CAN или AF_RDS. Тип сокета должен быть SOCK_STREAM (по умолчанию), SOCK_DGRAM, SOCK_RAW или, возможно, одной из других констант SOCK_. Номер протокола обычно равен нулю и может быть опущен; в случае, когда семейство адресов – AF_CAN, протокол должен быть одним из CAN_RAW или CAN_BCM. Если указан fileno, остальные аргументы игнорируются, и возвращается сокет с указанным файловым дескриптором. В отличие от socket.fromfd(), fileno возвращает тот же сокет, а не его дубликат. Это может помочь закрыть отсоединённый сокет с помощью socket.close().
Новый созданный сокет ненаследуемый.
Изменено в версии 3.3: Добавлено семейство AF_CAN. Добавлено семейство AF_RDS.
Изменено в версии 3.4: Добавлен протокол CAN_BCM.
Изменено в версии 3.4: Возвращаемый сокет теперь ненаследуемый.
- socket.socketpair([family[, type[, proto]]])¶
Создаёт пару соединённых объектов сокетов, используя указанное семейство адресов, тип сокета и номер протокола. Семейство адресов, тип сокета и номер протокола такие же, как для функции socket() выше. Семейство по умолчанию – AF_UNIX, если оно определено на платформе; в противном случае по умолчанию используется AF_INET. Доступность: Unix.
Новые созданные сокеты ненаследуемые.
Изменено в версии 3.2: Возвращаемые объекты сокетов теперь поддерживают полный API сокетов, а не подмножество.
Изменено в версии 3.4: Возвращаемые сокеты теперь являются ненаследуемыми.
- socket.create_connection(address[, timeout[, source_address]])¶
Подключается к TCP-сервису, ожидающему по адресу address в Интернете (кортеж из двух элементов (host, port)), и возвращает объект сокета. Это функция более высокого уровня, чем socket.connect(): если host – нечисловое имя хоста, она попытается разрешить его и для AF_INET, и для AF_INET6, а затем попробует подключиться ко всем возможным адресам по очереди, пока не произойдёт успешное подключение. Это упрощает написание клиентов, совместимых с IPv4 и IPv6.
Передача необязательного параметра timeout установит тайм-аут для экземпляра сокета перед попыткой подключения. Если timeout не указан, используется глобальная настройка тайм-аута по умолчанию, возвращаемая функцией getdefaulttimeout().
Если указан, то source_address должен быть кортежем из двух элементов (host, port), чтобы сокет привязывался к нему как к исходному адресу перед подключением. Если host или port равны ‘’ или 0 соответственно, будет использовано поведение ОС по умолчанию.
Изменено в версии 3.2: Добавлен параметр source_address.
Изменено в версии 3.2: добавлена поддержка оператора with.
- socket.fromfd(fd, family, type, proto=0)¶
Дублирует файловый дескриптор fd (целое число, возвращаемое методом fileno() объекта файла) и создаёт из результата объект сокета. Семейство адресов, тип сокета и номер протокола такие же, как у функции socket() выше. Файловый дескриптор должен ссылаться на сокет, но это не проверяется – последующие операции с объектом могут завершиться ошибкой, если файловый дескриптор некорректен. Эта функция требуется редко, но может использоваться для получения или установки параметров сокета, переданного программе как стандартный ввод или вывод (например, сервер, запущенный демоном inet в Unix). Предполагается, что сокет находится в блокирующем режиме.
Новый созданный сокет ненаследуемый.
Изменено в версии 3.4: Возвращаемый сокет теперь ненаследуемый.
Создаёт экземпляр сокета из данных, полученных методом socket.share(). Предполагается, что сокет находится в блокирующем режиме.
Доступность: Windows.
Новое в версии 3.3.
- socket.SocketType¶
Это объект типа Python, представляющий тип объекта сокета. Он эквивалентен type(socket(...)).
18.1.2.3.2. Другие функции¶Other functions
Модуль socket также предоставляет различные сетевые сервисы:
- socket.getaddrinfo(host, port, family=0, type=0, proto=0, flags=0)¶
Преобразует аргументы host/port в последовательность кортежей из 5 элементов, содержащих все необходимые аргументы для создания сокета, подключённого к этой службе. host – это доменное имя, строковое представление IPv4/v6-адреса или None. port – это строковое имя службы, например 'http', числовой номер порта или None. Передавая None в качестве значения host и port, можно передать NULL в нижележащий C API.
Аргументы family, type и proto можно указать необязательно, чтобы сузить список возвращаемых адресов. Если передать ноль в качестве значения каждого из этих аргументов, будут выбраны все возможные результаты. Аргумент flags может содержать одну или несколько констант AI_* и влияет на то, как вычисляются и возвращаются результаты. Например, AI_NUMERICHOST отключает разрешение доменных имён и вызовет ошибку, если host является доменным именем.
Функция возвращает список кортежей из 5 элементов со следующей структурой:
(family, type, proto, canonname, sockaddr)
В этих кортежах family, type, proto – целые числа, и их следует передавать функции socket(). canonname будет строкой, представляющей каноническое имя host, если AI_CANONNAME входит в аргумент flags; в противном случае canonname будет пустым. sockaddr – это кортеж, описывающий адрес сокета, формат которого зависит от возвращённого family (кортеж из 2 элементов (address, port) для AF_INET, кортеж из 4 элементов (address, port, flow info, scope id) для AF_INET6), и предназначен для передачи методу socket.connect().
Следующий пример получает информацию об адресе для гипотетического TCP-подключения к example.org на порту 80 (результаты могут отличаться в вашей системе, если IPv6 не включён):
>>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP) [(<AddressFamily.AF_INET6: 10>, <SocketType.SOCK_STREAM: 1>, 6, '', ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)), (<AddressFamily.AF_INET: 2>, <SocketType.SOCK_STREAM: 1>, 6, '', ('93.184.216.34', 80))]
Изменено в версии 3.2: теперь параметры можно передавать в виде именованных аргументов.
- socket.getfqdn([name])¶
Возвращает полное доменное имя для name. Если name опущен или пуст, он интерпретируется как локальный хост. Чтобы найти полное имя, проверяется имя хоста, возвращённое gethostbyaddr(), а затем, при наличии, псевдонимы хоста. Выбирается первое имя, содержащее точку. Если полное доменное имя недоступно, возвращается имя хоста, полученное через gethostname().
- socket.gethostbyname(hostname)¶
Преобразует имя хоста в формат IPv4-адреса. IPv4-адрес возвращается в виде строки, например '100.50.200.5'. Если само имя хоста является IPv4-адресом, оно возвращается без изменений. См. gethostbyname_ex() для более полного интерфейса. gethostbyname() не поддерживает разрешение имён IPv6, поэтому для поддержки dual stack IPv4/v6 следует использовать getaddrinfo().
- socket.gethostbyname_ex(hostname)¶
Преобразует имя хоста в формат IPv4-адреса, расширенный интерфейс. Возвращает тройку (hostname, aliaslist, ipaddrlist), где hostname – основное имя хоста, отвечающего на заданный ip_address, aliaslist – (возможно, пустой) список альтернативных имён хоста для того же адреса, а ipaddrlist – список IPv4-адресов того же интерфейса на том же хосте (часто, но не всегда, один адрес). gethostbyname_ex() не поддерживает разрешение имён IPv6, поэтому для поддержки dual stack IPv4/v6 следует использовать getaddrinfo().
- socket.gethostname()¶
Возвращает строку, содержащую имя хоста машины, на которой в данный момент выполняется интерпретатор Python.
Если нужно узнать IP-адрес текущей машины, можно использовать gethostbyname(gethostname()). Эта операция предполагает, что существует корректное отображение адреса на хост, и это предположение выполняется не всегда.
Примечание: gethostname() не всегда возвращает полное доменное имя; для этого используйте getfqdn().
- socket.gethostbyaddr(ip_address)¶
Возвращает тройку (hostname, aliaslist, ipaddrlist), где hostname – основное имя хоста, отвечающего на заданный ip_address, aliaslist – (возможно, пустой) список альтернативных имён хоста для того же адреса, а ipaddrlist – список IPv4/v6-адресов того же интерфейса на том же хосте (скорее всего, содержащий только один адрес). Чтобы найти полное доменное имя, используйте функцию getfqdn(). gethostbyaddr() поддерживает как IPv4, так и IPv6.
- socket.getnameinfo(sockaddr, flags)¶
Преобразует адрес сокета sockaddr в кортеж из двух элементов (host, port). В зависимости от настроек flags результат может содержать полное доменное имя или числовое представление адреса в host. Аналогично, port может содержать строковое имя порта или числовой номер порта.
- socket.getprotobyname(protocolname)¶
Преобразует имя интернет-протокола (например, 'icmp') в константу, пригодную для передачи в качестве (необязательного) третьего аргумента функции socket(). Обычно это требуется только для сокетов, открытых в «сыром» режиме (SOCK_RAW); для обычных режимов сокета правильный протокол выбирается автоматически, если протокол опущен или равен нулю.
- socket.getservbyname(servicename[, protocolname])¶
Преобразует имя интернет-службы и имя протокола в номер порта для этой службы. Необязательное имя протокола, если указано, должно быть 'tcp' или 'udp', в противном случае подойдёт любой протокол.
- socket.getservbyport(port[, protocolname])¶
Преобразует номер порта и имя протокола в имя службы для этой службы. Необязательное имя протокола, если указано, должно быть 'tcp' или 'udp', иначе подойдет любой протокол.
- socket.ntohl(x)¶
Преобразует 32-битные положительные целые числа из сетевого порядка байтов в порядок байтов хоста. На машинах, где порядок байтов хоста совпадает с сетевым, эта операция ничего не делает; в противном случае выполняется перестановка 4 байтов.
- socket.ntohs(x)¶
Преобразует 16-битные положительные целые числа из сетевого порядка байтов в порядок байтов хоста. На машинах, где порядок байтов хоста совпадает с сетевым, эта функция ничего не делает; в противном случае она выполняет обмен двух байтов.
- socket.htonl(x)¶
Преобразует 32-битные положительные целые числа из порядка байтов хоста в сетевой порядок. На машинах, где порядок байтов хоста совпадает с сетевым, эта функция ничего не делает; в противном случае она выполняет обмен четырёх байтов.
- socket.htons(x)¶
Преобразует 16-битные положительные целые числа из порядка байтов хоста в сетевой порядок. На машинах, где порядок байтов хоста совпадает с сетевым, эта функция ничего не делает; в противном случае она выполняет обмен двух байтов.
- socket.inet_aton(ip_string)¶
Преобразует IPv4-адрес из строкового формата с точками (например, '123.45.67.89') в 32-битный упакованный двоичный формат в виде объекта bytes длиной четыре символа. Это полезно при взаимодействии с программой, использующей стандартную библиотеку C и требующей объекты типа struct in_addr, который является типом C для 32-битного упакованного двоичного представления, возвращаемого этой функцией.
inet_aton() также принимает строки с менее чем тремя точками; подробнее см. в руководстве Unix inet(3).
Если переданная этой функции строка IPv4-адреса недействительна, будет возбуждено OSError. Обратите внимание, что точное определение допустимости зависит от базовой реализации C функции inet_aton().
inet_aton() не поддерживает IPv6, и для поддержки двойного стека IPv4/IPv6 вместо него следует использовать inet_pton().
- socket.inet_ntoa(packed_ip)¶
Преобразует 32-битный упакованный IPv4-адрес (объект bytes длиной четыре символа) в его стандартное строковое представление с точками (например, '123.45.67.89'). Это полезно при взаимодействии с программой, использующей стандартную библиотеку C и требующей объекты типа struct in_addr, который является типом C для 32-битных упакованных двоичных данных, принимаемых этой функцией в качестве аргумента.
Если переданная этой функции последовательность байтов имеет длину не ровно 4 байта, будет возбуждено OSError. inet_ntoa() не поддерживает IPv6, и для поддержки двойного стека IPv4/IPv6 вместо него следует использовать inet_ntop().
- socket.inet_pton(address_family, ip_string)¶
Преобразует IP-адрес из строкового формата, зависящего от семейства, в упакованный двоичный формат. inet_pton() полезен, когда библиотека или сетевой протокол требует объект типа struct in_addr (аналогично inet_aton()) или struct in6_addr.
В настоящее время поддерживаемыми значениями для address_family являются AF_INET и AF_INET6. Если строка IP-адреса ip_string недействительна, будет возбуждено OSError. Обратите внимание, что точное определение допустимости зависит как от значения address_family, так и от базовой реализации inet_pton().
Доступность: Unix (возможно, не все платформы), Windows.
Изменено в версии 3.4: Добавлена поддержка Windows
- socket.inet_ntop(address_family, packed_ip)¶
Convert 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() is useful when a library or network protocol returns an object of type struct in_addr (similar to inet_ntoa()) or struct in6_addr.
Supported values for address_family are currently AF_INET and AF_INET6. If the string packed_ip is not the correct length for the specified address family, ValueError will be raised. OSError is raised for errors from the call to inet_ntop().
Доступность: Unix (возможно, не все платформы), Windows.
Изменено в версии 3.4: Добавлена поддержка Windows
- socket.CMSG_LEN(length)¶
Возвращает общую длину (без завершающего выравнивания) элемента вспомогательных данных с соответствующими данными заданной length. Это значение часто можно использовать как размер буфера для recvmsg() для получения одного элемента вспомогательных данных, но RFC 3542 требует от переносимых приложений использования CMSG_SPACE() и, таким образом, включения пространства для выравнивания, даже если элемент будет последним в буфере. Возбуждает OverflowError, если length выходит за допустимый диапазон значений.
Доступность: большинство платформ Unix, возможно, и другие.
Новое в версии 3.3.
- socket.CMSG_SPACE(length)¶
Возвращает размер буфера, необходимый для recvmsg() для получения элемента вспомогательных данных с соответствующими данными заданной length, включая любое завершающее выравнивание. Пробел буфера, необходимый для получения нескольких элементов, представляет собой сумму значений CMSG_SPACE() для соответствующих длин данных. Возбуждает OverflowError, если length выходит за допустимый диапазон значений.
Обратите внимание, что некоторые системы могут поддерживать вспомогательные данные, не предоставляя эту функцию. Также обратите внимание, что установка размера буфера с использованием результатов этой функции может не точно ограничить объём принимаемых вспомогательных данных, поскольку дополнительные данные могут поместиться в область выравнивания.
Доступность: большинство платформ Unix, возможно, и другие.
Новое в версии 3.3.
- socket.getdefaulttimeout()¶
Возвращает тайм-аут по умолчанию в секундах (float) для новых сокетов. Значение None означает, что новые сокеты не имеют тайм-аута. При первом импорте модуля socket значение по умолчанию равно None.
- socket.setdefaulttimeout(timeout)¶
Устанавливает тайм-аут по умолчанию в секундах (float) для новых сокетов. При первом импорте модуля socket значение по умолчанию равно None. См. settimeout() для возможных значений и их соответствующих значений.
- socket.sethostname(name)¶
Устанавливает имя хоста машины в name. Если прав недостаточно, будет возбуждено OSError.
Доступность: Unix.
Новое в версии 3.3.
- socket.if_nameindex()¶
Возвращает список кортежей с информацией о сетевых интерфейсах (индекс int, имя string). OSError, если системный вызов завершается неудачей.
Доступность: Unix.
Новое в версии 3.3.
18.1.3. Объекты сокетов¶Socket Objects
Объекты сокетов имеют следующие методы. За исключением makefile(), они соответствуют системным вызовам Unix, применимым к сокетам.
- socket.accept()¶
Принимает соединение. Сокет должен быть привязан к адресу и прослушивать соединения. Возвращаемое значение – пара (conn, address), где conn – это новый объект сокета, который можно использовать для отправки и получения данных по соединению, а address – это адрес, привязанный к сокету на другом конце соединения.
Новый созданный сокет ненаследуемый.
Изменено в версии 3.4: Сокет теперь ненаследуемый.
- socket.bind(address)¶
Привязывает сокет к address. Сокет не должен быть уже привязан. (Формат address зависит от семейства адресов – см. выше.)
- socket.close()¶
Помечает сокет как закрытый. Базовый системный ресурс (например, файловый дескриптор) также закрывается, когда все файловые объекты из makefile() закрыты. Как только это происходит, все последующие операции с объектом сокета завершаются ошибкой. Удаленная сторона больше не будет получать данные (после сброса поставленных в очередь данных).
Сокеты автоматически закрываются при сборке мусора, но рекомендуется явно закрывать их с помощью close() или использовать оператор with для работы с ними.
Примечание
close() освобождает ресурс, связанный с соединением, но не обязательно закрывает соединение немедленно. Если требуется вовремя закрыть соединение, вызовите shutdown() перед close().
- socket.connect(address)¶
Подключается к удалённому сокету по адресу address. (Формат address зависит от семейства адресов – см. выше.)
- socket.connect_ex(address)¶
Как и connect(address), но возвращает индикатор ошибки вместо вызова исключения для ошибок, возвращаемых вызовом connect() на уровне C (другие проблемы, такие как «хост не найден», по-прежнему могут вызывать исключения). Индикатор ошибки равен 0, если операция выполнена успешно, в противном случае – значению переменной errno. Это полезно, например, для поддержки асинхронных соединений.
- socket.detach()¶
Переводит объект сокета в закрытое состояние без фактического закрытия базового файлового дескриптора. Файловый дескриптор возвращается и может быть повторно использован для других целей.
Новое в версии 3.2.
- socket.dup()¶
Дублирует сокет.
Новый созданный сокет ненаследуемый.
Изменено в версии 3.4: Сокет теперь ненаследуемый.
- socket.fileno()¶
Возвращает файловый дескриптор сокета (небольшое целое число). Это полезно с select.select().
В Windows небольшое целое число, возвращаемое этим методом, нельзя использовать там, где может использоваться файловый дескриптор (например, в os.fdopen()). В Unix такого ограничения нет.
- socket.get_inheritable()¶
Возвращает флаг наследуемости файлового дескриптора сокета или дескриптора сокета: True, если сокет может наследоваться в дочерних процессах, и False – если нет.
Новое в версии 3.4.
- socket.getpeername()¶
Возвращает удалённый адрес, к которому подключён сокет. Это полезно, например, для определения номера порта удалённого сокета IPv4/v6. (Формат возвращаемого адреса зависит от семейства адресов – см. выше.) На некоторых системах эта функция не поддерживается.
- socket.getsockname()¶
Возвращает собственный адрес сокета. Это полезно, например, для определения номера порта сокета IPv4/v6. (Формат возвращаемого адреса зависит от семейства адресов – см. выше.)
- socket.getsockopt(level, optname[, buflen])¶
Возвращает значение указанной опции сокета (см. страницу man Unix getsockopt(2)). Необходимые символьные константы (SO_* и т.д.) определены в этом модуле. Если buflen отсутствует, предполагается целочисленная опция, и функция возвращает её целочисленное значение. Если buflen присутствует, он задает максимальную длину буфера для получения опции, и этот буфер возвращается в виде объекта bytes. Вызывающий код должен сам декодировать содержимое буфера (см. опциональный встроенный модуль struct для способа декодирования структур C, закодированных как байтовые строки).
- socket.gettimeout()¶
Возвращает тайм-аут в секундах (число с плавающей точкой), связанный с операциями сокета, или None, если тайм-аут не установлен. Это значение отражает последний вызов setblocking() или settimeout().
- socket.ioctl(control, option)¶
Платформа: Windows Метод ioctl() представляет собой ограниченный интерфейс к системному интерфейсу WSAIoctl. Для получения дополнительной информации обратитесь к документации Win32.
On other platforms, the generic fcntl.fcntl() and fcntl.ioctl() functions may be used; they accept a socket object as their first argument.
- socket.listen(backlog)¶
Ожидает подключения к сокету. Аргумент backlog задаёт максимальное количество ожидающих соединений в очереди и должен быть не меньше 0; максимальное значение зависит от системы (обычно 5), минимальное принудительно устанавливается в 0.
- socket.makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)¶
Возвращает файловый объект, связанный с сокетом. Точный возвращаемый тип зависит от аргументов, переданных в makefile(). Эти аргументы интерпретируются так же, как и встроенной функцией open().
Сокет должен быть в блокирующем режиме; можно установить тайм-аут, но при его срабатывании внутренний буфер файлового объекта может оказаться в несогласованном состоянии.
Закрытие файлового объекта, возвращённого makefile(), не закроет исходный сокет, пока не будут закрыты все остальные файловые объекты и для объекта сокета не будет вызван socket.close().
Примечание
В Windows файлоподобный объект, созданный makefile(), нельзя использовать там, где требуется файловый объект с файловым дескриптором, например в аргументах потока subprocess.Popen().
- socket.recv(bufsize[, flags])¶
Получает данные из сокета. Возвращает объект bytes с полученными данными. Максимальный объём данных за одно получение задаётся параметром bufsize. Значение необязательного аргумента flags описано на странице руководства Unix recv(2); по умолчанию он равен нулю.
Примечание
Для наилучшего соответствия реальным характеристикам оборудования и сети значение bufsize должно быть относительно небольшой степенью двойки, например, 4096.
- socket.recvfrom(bufsize[, flags])¶
Receive 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.)
- socket.recvmsg(bufsize[, ancbufsize[, flags]])¶
Получает из сокета обычные данные (до bufsize байт) и вспомогательные данные. Аргумент ancbufsize задаёт размер внутреннего буфера для вспомогательных данных в байтах; по умолчанию равен 0, то есть вспомогательные данные не принимаются. Подходящие размеры буфера для вспомогательных данных можно вычислить с помощью CMSG_SPACE() или CMSG_LEN(); элементы, не помещающиеся в буфер, могут быть обрезаны или отброшены. Аргумент flags по умолчанию равен 0 и имеет то же значение, что и для recv().
Возвращаемое значение – кортеж из 4 элементов: (data, ancdata, msg_flags, address). Элемент data – объект bytes, содержащий принятые невспомогательные данные. Элемент ancdata – список из нуля или более кортежей (cmsg_level, cmsg_type, cmsg_data), представляющих полученные вспомогательные данные (управляющие сообщения): cmsg_level и cmsg_type – целые числа, задающие уровень протокола и тип в рамках протокола соответственно, а cmsg_data – объект bytes с соответствующими данными. Элемент msg_flags – побитовое ИЛИ различных флагов, указывающих на условия полученного сообщения; подробности смотрите в системной документации. Если принимающий сокет не подключён, address – адрес отправляющего сокета, если он доступен; в противном случае его значение не определено.
В некоторых системах sendmsg() и recvmsg() можно использовать для передачи файловых дескрипторов между процессами через сокет AF_UNIX. При использовании этой возможности (она часто ограничена сокетами SOCK_STREAM) recvmsg() вернёт во вспомогательных данных элементы вида (socket.SOL_SOCKET, socket.SCM_RIGHTS, fds), где fds – объект bytes, представляющий новые файловые дескрипторы в виде двоичного массива нативного типа C int. Если recvmsg() вызывает исключение после возврата системного вызова, она сначала попытается закрыть все файловые дескрипторы, полученные через этот механизм.
Некоторые системы не указывают усечённую длину элементов вспомогательных данных, которые были получены лишь частично. Если элемент выходит за пределы буфера, recvmsg() выдаст RuntimeWarning и вернёт ту часть, которая находится в буфере, при условии, что он не был усечён до начала своих данных.
В системах, поддерживающих механизм SCM_RIGHTS, следующая функция будет получать до maxfds файловых дескрипторов, возвращая данные сообщения и список с дескрипторами (игнорируя неожиданные ситуации, такие как получение посторонних управляющих сообщений). См. также sendmsg().
import socket, array def recv_fds(sock, msglen, maxfds): fds = array.array("i") # Массив целых чисел msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize)) for cmsg_level, cmsg_type, cmsg_data in ancdata: if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS): # Добавить данные, игнорируя любые усечённые целые числа в конце. fds.fromstring(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) return msg, list(fds)
Доступность: большинство платформ Unix, возможно, и другие.
Новое в версии 3.3.
- socket.recvmsg_into(buffers[, ancbufsize[, flags]])¶
Получает из сокета обычные и вспомогательные данные, ведя себя как recvmsg(), но разбрасывает невспомогательные данные по нескольким буферам, а не возвращает новый объект bytes. Аргумент buffers должен быть итерируемым объектом, элементы которого предоставляют буферы для записи (например, объекты bytearray); они будут заполняться последовательными частями невспомогательных данных, пока те не будут полностью записаны или не кончатся буферы. Операционная система может устанавливать ограничение (значение sysconf() SC_IOV_MAX) на количество используемых буферов. Аргументы ancbufsize и flags имеют то же значение, что и для recvmsg().
Возвращаемое значение – кортеж из 4 элементов: (nbytes, ancdata, msg_flags, address), где nbytes – общее количество байт невспомогательных данных, записанных в буферы, а ancdata, msg_flags и address такие же, как для recvmsg().
Пример:
>>> import socket >>> s1, s2 = socket.socketpair() >>> b1 = bytearray(b'----') >>> b2 = bytearray(b'0123456789') >>> b3 = bytearray(b'--------------') >>> s1.send(b'Mary had a little lamb') 22 >>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3]) (22, [], 0, None) >>> [b1, b2, b3] [bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]
Доступность: большинство платформ Unix, возможно, и другие.
Новое в версии 3.3.
- socket.recvfrom_into(buffer[, nbytes[, flags]])¶
Receive 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.)
- socket.recv_into(buffer[, nbytes[, flags]])¶
Получает из сокета до nbytes байтов, сохраняя данные в буфер, а не создавая новую строку байтов. Если nbytes не указан (или равен 0), принимает столько байтов, сколько помещается в переданный буфер. Возвращает количество полученных байтов. Значение необязательного аргумента flags описано на странице руководства Unix recv(2); по умолчанию он равен нулю.
- socket.send(bytes[, flags])¶
Отправляет данные в сокет. Сокет должен быть подключён к удалённому сокету. Необязательный аргумент flags имеет то же значение, что и для recv() выше. Возвращает количество отправленных байт. Приложения должны проверять, что все данные были отправлены; если передана только часть данных, приложению необходимо попытаться доставить остаток. Дополнительную информацию по этой теме можно найти в Socket Programming HOWTO.
- socket.sendall(bytes[, flags])¶
Отправляет данные в сокет. Сокет должен быть подключён к удалённому сокету. Необязательный аргумент flags имеет то же значение, что и для recv() выше. В отличие от send(), этот метод продолжает отправлять данные из bytes, пока не будут отправлены все данные или не возникнет ошибка. В случае успеха возвращается None. При ошибке вызывается исключение, и невозможно определить, сколько данных (если вообще было) было успешно отправлено.
- socket.sendto(bytes, address)¶
- socket.sendto(bytes, flags, address)
Отправляет данные в сокет. Сокет не должен быть подключён к удалённому сокету, так как целевой сокет задаётся аргументом address. Необязательный аргумент flags имеет то же значение, что и для recv() выше. Возвращает количество отправленных байт. (Формат address зависит от семейства адресов – см. выше.)
- socket.sendmsg(buffers[, ancdata[, flags[, address]]])¶
Отправляет в сокет обычные и вспомогательные данные, собирая невспомогательные данные из нескольких буферов и объединяя их в одно сообщение. Аргумент buffers задаёт невспомогательные данные как итерируемый объект из bytes-like объектов (например, объекты bytes); операционная система может устанавливать ограничение (значение sysconf() SC_IOV_MAX) на количество используемых буферов. Аргумент ancdata задаёт вспомогательные данные (управляющие сообщения) как итерируемый объект из нуля или более кортежей (cmsg_level, cmsg_type, cmsg_data), где cmsg_level и cmsg_type – целые числа, задающие уровень протокола и тип в рамках протокола соответственно, а cmsg_data – bytes-like объект с соответствующими данными. Обратите внимание, что некоторые системы (в частности, системы без CMSG_SPACE()) могут поддерживать отправку только одного управляющего сообщения за вызов. Аргумент flags по умолчанию равен 0 и имеет то же значение, что и для send(). Если address указан и не равен None, он задаёт адрес назначения сообщения. Возвращаемое значение – количество отправленных байт невспомогательных данных.
Следующая функция отправляет список файловых дескрипторов fds через сокет AF_UNIX в системах, поддерживающих механизм SCM_RIGHTS. См. также recvmsg().
import socket, array def send_fds(sock, msg, fds): return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])
Доступность: большинство платформ Unix, возможно, и другие.
Новое в версии 3.3.
- socket.set_inheritable(inheritable)¶
Устанавливает флаг наследования файлового дескриптора сокета или дескриптора сокета.
Новое в версии 3.4.
- socket.setblocking(flag)¶
Устанавливает блокирующий или неблокирующий режим сокета: если flag равен false, сокет переводится в неблокирующий режим, иначе в блокирующий.
Этот метод является сокращением для некоторых вызовов settimeout():
- sock.setblocking(True) эквивалентно sock.settimeout(None)
- sock.setblocking(False) эквивалентно sock.settimeout(0.0)
- socket.settimeout(value)¶
Устанавливает тайм-аут для блокирующих операций с сокетом. Аргумент value может быть неотрицательным числом с плавающей запятой, выражающим секунды, или None. Если задано ненулевое значение, последующие операции с сокетом будут вызывать исключение timeout, если период тайм-аута value истек до завершения операции. Если задан ноль, сокет переводится в неблокирующий режим. Если задано None, сокет переводится в блокирующий режим.
Для получения дополнительной информации обратитесь к заметкам о тайм-аутах сокетов.
- socket.setsockopt(level, optname, value)¶
Устанавливает значение указанной опции сокета (см. страницу руководства Unix setsockopt(2)). Необходимые символические константы определены в модуле socket (SO_* и т.д.). Значение может быть целым числом или объектом bytes, представляющим буфер. В последнем случае вызывающий должен убедиться, что последовательность байтов содержит правильные биты (см. опциональный встроенный модуль struct для способа кодирования C-структур в виде байтовых строк).
- socket.shutdown(how)¶
Завершает одну или обе половины соединения. Если how равно SHUT_RD, дальнейший приём запрещён. Если how равно SHUT_WR, дальнейшая отправка запрещена. Если how равно SHUT_RDWR, дальнейшие отправка и приём запрещены.
Дублирует сокет и подготавливает его для передачи целевому процессу. Целевой процесс должен быть указан с помощью process_id. Полученный объект bytes затем может быть передан целевому процессу с использованием какой-либо формы межпроцессного взаимодействия, и сокет может быть воссоздан там с помощью fromshare(). После вызова этого метода сокет можно безопасно закрыть, так как операционная система уже продублировала его для целевого процесса.
Доступность: Windows.
Новое в версии 3.3.
Обратите внимание, что методов read() или write() не существует; вместо них используйте recv() и send() без аргумента flags.
Объекты сокетов также имеют следующие (только для чтения) атрибуты, которые соответствуют значениям, переданным конструктору socket.
- socket.family¶
Семейство сокета.
- socket.type¶
Тип сокета.
- socket.proto¶
Протокол сокета.
18.1.4. Замечания по тайм-аутам сокетов¶Notes on socket timeouts
Объект сокета может находиться в одном из трёх режимов: блокирующем, неблокирующем или с тайм-аутом. По умолчанию сокеты всегда создаются в блокирующем режиме, но это можно изменить, вызвав setdefaulttimeout().
- В блокирующем режиме операции блокируются до завершения или пока система не вернет ошибку (например, истекло время соединения).
- В неблокирующем режиме операции завершаются ошибкой (с ошибкой, которая, к сожалению, зависит от системы), если их нельзя выполнить немедленно: функции из модуля select можно использовать, чтобы узнать, когда и доступен ли сокет для чтения или записи.
- В режиме с тайм-аутом операции завершаются ошибкой, если их нельзя выполнить в течение тайм-аута, указанного для сокета (они вызывают исключение timeout), или если система возвращает ошибку.
Примечание
На уровне операционной системы сокеты в режиме с тайм-аутом внутренне устанавливаются в неблокирующий режим. Кроме того, блокирующий режим и режим тайм-аута разделяются между файловыми дескрипторами и объектами сокетов, которые относятся к одной и той же сетевой конечной точке. Эта деталь реализации может иметь заметные последствия, если, например, вы решите использовать fileno() сокета.
18.1.4.1. Тайм-ауты и метод connect¶Timeouts and the connect method
Операция connect() также подчиняется настройке тайм-аута, и в целом рекомендуется вызывать settimeout() перед вызовом connect() или передавать параметр тайм-аута в create_connection(). Однако сетевой стек системы также может вернуть собственную ошибку тайм-аута соединения независимо от любой настройки тайм-аута сокета Python.
18.1.4.2. Тайм-ауты и метод accept¶Timeouts and the accept method
Если getdefaulttimeout() не равно None, сокеты, возвращаемые методом accept(), наследуют этот тайм-аут. В противном случае поведение зависит от настроек прослушивающего сокета:
- если прослушивающий сокет находится в блокирующем режиме или в режиме с тайм-аутом, сокет, возвращённый accept(), находится в блокирующем режиме;
- если прослушивающий сокет находится в неблокирующем режиме, то, будет ли сокет, возвращённый accept(), в блокирующем или неблокирующем режиме, зависит от операционной системы. Если вы хотите обеспечить кроссплатформенное поведение, рекомендуется вручную переопределить эту настройку.
18.1.5. Пример¶Example
Вот четыре минимальных примера программ, использующих протокол TCP/IP: сервер, который отправляет обратно все полученные данные (обслуживая только одного клиента), и клиент, использующий его. Обратите внимание, что сервер должен выполнить последовательность socket(), bind(), listen(), accept() (возможно, повторяя accept() для обслуживания более одного клиента), в то время как клиенту нужна только последовательность socket(), connect(). Также обратите внимание, что сервер не вызывает sendall()/recv() на сокете, который он прослушивает, а на новом сокете, возвращённом accept().
Первые два примера поддерживают только IPv4.
# Программа эхо-сервера
import socket
HOST = '' # Символическое имя, обозначающее все доступные интерфейсы
PORT = 50007 # Произвольный непривилегированный порт
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.bind((HOST, PORT))
s.listen(1)
conn, addr = s.accept()
print('Connected by', addr)
while True:
data = conn.recv(1024)
if not data: break
conn.sendall(data)
conn.close()
# Программа эхо-клиента
import socket
HOST = 'daring.cwi.nl' # Удалённый хост
PORT = 50007 # Тот же порт, что и у сервера
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect((HOST, PORT))
s.sendall(b'Hello, world')
data = s.recv(1024)
s.close()
print('Received', repr(data))
Следующие два примера идентичны двум предыдущим, но поддерживают как IPv4, так и IPv6. Серверная сторона будет прослушивать первое доступное семейство адресов (ей следовало бы прослушивать оба). На большинстве систем, готовых к IPv6, IPv6 будет иметь приоритет, и сервер может не принимать IPv4-трафик. Клиентская сторона попытается подключиться ко всем адресам, полученным в результате разрешения имен, и отправляет трафик на первый успешно подключенный.
# Программа эхо-сервера
import socket
import sys
HOST = None # Символическое имя, обозначающее все доступные интерфейсы
PORT = 50007 # Произвольный непривилегированный порт
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,
socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
af, socktype, proto, canonname, sa = res
try:
s = socket.socket(af, socktype, proto)
except OSError as msg:
s = None
continue
try:
s.bind(sa)
s.listen(1)
except OSError as msg:
s.close()
s = None
continue
break
if s is None:
print('could not open socket')
sys.exit(1)
conn, addr = s.accept()
print('Connected by', addr)
while True:
data = conn.recv(1024)
if not data: break
conn.send(data)
conn.close()
# Программа эхо-клиента
import socket
import sys
HOST = 'daring.cwi.nl' # Удалённый хост
PORT = 50007 # Тот же порт, что и у сервера
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
af, socktype, proto, canonname, sa = res
try:
s = socket.socket(af, socktype, proto)
except OSError as msg:
s = None
continue
try:
s.connect(sa)
except OSError as msg:
s.close()
s = None
continue
break
if s is None:
print('could not open socket')
sys.exit(1)
s.sendall(b'Hello, world')
data = s.recv(1024)
s.close()
print('Received', repr(data))
Следующий пример показывает, как написать очень простой снифер сети с помощью сырых сокетов в Windows. Для изменения интерфейса пример требует прав администратора:
import socket
# общедоступный сетевой интерфейс
HOST = socket.gethostbyname(socket.gethostname())
# создать сырой сокет и привязать его к общедоступному интерфейсу
s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
s.bind((HOST, 0))
# Включать IP-заголовки
s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)
# принять все пакеты
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)
# принять пакет
print(s.recvfrom(65565))
# неразборчивый режим отключён
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)
Последний пример показывает, как использовать интерфейс сокетов для обмена данными с сетью CAN с помощью протокола сырых сокетов. Чтобы вместо этого использовать CAN с протоколом широковещательного менеджера, откройте сокет:
socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)
После привязки (CAN_RAW) или подключения (CAN_BCM) сокета вы можете использовать операции socket.send() и socket.recv() (а также их аналоги) на объекте сокета как обычно.
Для этого примера могут потребоваться особые привилегии:
import socket
import struct
# Упаковка/распаковка CAN-фреймов (см. 'struct can_frame' в <linux/can.h>)
can_frame_fmt = "=IB3x8s"
can_frame_size = struct.calcsize(can_frame_fmt)
def build_can_frame(can_id, data):
can_dlc = len(data)
data = data.ljust(8, b'\x00')
return struct.pack(can_frame_fmt, can_id, can_dlc, data)
def dissect_can_frame(frame):
can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)
return (can_id, can_dlc, data[:can_dlc])
# создать сырой сокет и привязать его к интерфейсу 'vcan0'
s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
s.bind(('vcan0',))
while True:
cf, addr = s.recvfrom(can_frame_size)
print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))
try:
s.send(cf)
except OSError:
print('Error sending CAN frame')
try:
s.send(build_can_frame(0x01, b'\x01\x02\x03'))
except OSError:
print('Error sending CAN frame')
Запуск примера несколько раз со слишком маленькой задержкой между выполнениями может привести к этой ошибке:
OSError: [Errno 98] Address already in use
Это связано с тем, что предыдущее выполнение оставило сокет в состоянии TIME_WAIT, и его нельзя сразу использовать повторно.
Существует флаг socket, который можно установить, чтобы предотвратить это: socket.SO_REUSEADDR
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((HOST, PORT))
флаг SO_REUSEADDR указывает ядру повторно использовать локальный сокет в состоянии TIME_WAIT, не дожидаясь истечения его естественного тайм-аута.
См. также
Для ознакомления с программированием сокетов (на C) см. следующие статьи:
- Вводное руководство по межпроцессному взаимодействию в 4.3BSD, Стюарт Сечрест
- Продвинутое руководство по межпроцессному взаимодействию в 4.3BSD, Сэмюэл Дж. Леффлер и др.
Оба находятся в UNIX Programmer’s Manual, Supplementary Documents 1 (разделы PS1:7 и PS1:8). Справочные материалы по сокетным системным вызовам для конкретных платформ также являются ценным источником информации о деталях семантики сокетов. Для Unix обращайтесь к страницам руководства; для Windows – к спецификации WinSock (или Winsock 2). Для API с поддержкой IPv6 читателю может быть полезно обратиться к RFC 3493 под названием Basic Socket Interface Extensions for IPv6.