mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-08 04:54:47 +08:00
796 lines
21 KiB
Python
796 lines
21 KiB
Python
import sys
|
|
from _typeshed import ReadableBuffer, WriteableBuffer
|
|
from collections.abc import Iterable
|
|
from socket import error as error, gaierror as gaierror, herror as herror, timeout as timeout
|
|
from typing import Any, SupportsIndex, overload
|
|
from typing_extensions import TypeAlias
|
|
|
|
_CMSG: TypeAlias = tuple[int, int, bytes]
|
|
_CMSGArg: TypeAlias = tuple[int, int, ReadableBuffer]
|
|
|
|
# Addresses can be either tuples of varying lengths (AF_INET, AF_INET6,
|
|
# AF_NETLINK, AF_TIPC) or strings/buffers (AF_UNIX).
|
|
# See getsockaddrarg() in socketmodule.c.
|
|
_Address: TypeAlias = tuple[Any, ...] | str | ReadableBuffer
|
|
_RetAddress: TypeAlias = Any
|
|
|
|
# ===== Constants =====
|
|
# This matches the order in the CPython documentation
|
|
# https://docs.python.org/3/library/socket.html#constants
|
|
|
|
if sys.platform != "win32":
|
|
AF_UNIX: int
|
|
|
|
AF_INET: int
|
|
AF_INET6: int
|
|
|
|
AF_UNSPEC: int
|
|
|
|
SOCK_STREAM: int
|
|
SOCK_DGRAM: int
|
|
SOCK_RAW: int
|
|
SOCK_RDM: int
|
|
SOCK_SEQPACKET: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.27
|
|
SOCK_CLOEXEC: int
|
|
SOCK_NONBLOCK: int
|
|
|
|
# --------------------
|
|
# Many constants of these forms, documented in the Unix documentation on
|
|
# sockets and/or the IP protocol, are also defined in the socket module.
|
|
# SO_*
|
|
# socket.SOMAXCONN
|
|
# MSG_*
|
|
# SOL_*
|
|
# SCM_*
|
|
# IPPROTO_*
|
|
# IPPORT_*
|
|
# INADDR_*
|
|
# IP_*
|
|
# IPV6_*
|
|
# EAI_*
|
|
# AI_*
|
|
# NI_*
|
|
# TCP_*
|
|
# --------------------
|
|
|
|
SO_ACCEPTCONN: int
|
|
SO_BROADCAST: int
|
|
SO_DEBUG: int
|
|
SO_DONTROUTE: int
|
|
SO_ERROR: int
|
|
SO_KEEPALIVE: int
|
|
SO_LINGER: int
|
|
SO_OOBINLINE: int
|
|
SO_RCVBUF: int
|
|
SO_RCVLOWAT: int
|
|
SO_RCVTIMEO: int
|
|
SO_REUSEADDR: int
|
|
SO_SNDBUF: int
|
|
SO_SNDLOWAT: int
|
|
SO_SNDTIMEO: int
|
|
SO_TYPE: int
|
|
SO_USELOOPBACK: int
|
|
if sys.platform == "win32":
|
|
SO_EXCLUSIVEADDRUSE: int
|
|
if sys.platform != "win32":
|
|
SO_REUSEPORT: int
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
SO_BINDTODEVICE: int
|
|
SO_DOMAIN: int
|
|
SO_MARK: int
|
|
SO_PASSCRED: int
|
|
SO_PASSSEC: int
|
|
SO_PEERCRED: int
|
|
SO_PEERSEC: int
|
|
SO_PRIORITY: int
|
|
SO_PROTOCOL: int
|
|
SO_SETFIB: int
|
|
|
|
SOMAXCONN: int
|
|
|
|
MSG_CTRUNC: int
|
|
MSG_DONTROUTE: int
|
|
MSG_OOB: int
|
|
MSG_PEEK: int
|
|
MSG_TRUNC: int
|
|
MSG_WAITALL: int
|
|
if sys.platform != "win32":
|
|
MSG_DONTWAIT: int
|
|
MSG_EOF: int
|
|
MSG_EOR: int
|
|
MSG_NOSIGNAL: int # Sometimes this exists on darwin, sometimes not
|
|
if sys.platform != "darwin":
|
|
MSG_BCAST: int
|
|
MSG_ERRQUEUE: int
|
|
MSG_MCAST: int
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
MSG_BTAG: int
|
|
MSG_CMSG_CLOEXEC: int
|
|
MSG_CONFIRM: int
|
|
MSG_ETAG: int
|
|
MSG_FASTOPEN: int
|
|
MSG_MORE: int
|
|
MSG_NOTIFICATION: int
|
|
|
|
SOL_IP: int
|
|
SOL_SOCKET: int
|
|
SOL_TCP: int
|
|
SOL_UDP: int
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
SOL_ATALK: int
|
|
SOL_AX25: int
|
|
SOL_HCI: int
|
|
SOL_IPX: int
|
|
SOL_NETROM: int
|
|
SOL_ROSE: int
|
|
|
|
if sys.platform != "win32":
|
|
SCM_CREDS: int
|
|
SCM_RIGHTS: int
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
SCM_CREDENTIALS: int
|
|
|
|
IPPROTO_ICMP: int
|
|
IPPROTO_IP: int
|
|
IPPROTO_RAW: int
|
|
IPPROTO_TCP: int
|
|
IPPROTO_UDP: int
|
|
IPPROTO_AH: int
|
|
IPPROTO_DSTOPTS: int
|
|
IPPROTO_EGP: int
|
|
IPPROTO_ESP: int
|
|
IPPROTO_FRAGMENT: int
|
|
IPPROTO_GGP: int
|
|
IPPROTO_HOPOPTS: int
|
|
IPPROTO_ICMPV6: int
|
|
IPPROTO_IDP: int
|
|
IPPROTO_IGMP: int
|
|
IPPROTO_IPV4: int
|
|
IPPROTO_IPV6: int
|
|
IPPROTO_MAX: int
|
|
IPPROTO_ND: int
|
|
IPPROTO_NONE: int
|
|
IPPROTO_PIM: int
|
|
IPPROTO_PUP: int
|
|
IPPROTO_ROUTING: int
|
|
IPPROTO_SCTP: int
|
|
if sys.platform != "darwin":
|
|
IPPROTO_CBT: int
|
|
IPPROTO_ICLFXBM: int
|
|
IPPROTO_IGP: int
|
|
IPPROTO_L2TP: int
|
|
IPPROTO_PGM: int
|
|
IPPROTO_RDP: int
|
|
IPPROTO_ST: int
|
|
if sys.platform != "win32":
|
|
IPPROTO_EON: int
|
|
IPPROTO_GRE: int
|
|
IPPROTO_HELLO: int
|
|
IPPROTO_IPCOMP: int
|
|
IPPROTO_IPIP: int
|
|
IPPROTO_RSVP: int
|
|
IPPROTO_TP: int
|
|
IPPROTO_XTP: int
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
IPPROTO_BIP: int
|
|
IPPROTO_MOBILE: int
|
|
IPPROTO_VRRP: int
|
|
if sys.version_info >= (3, 9) and sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.20, FreeBSD >= 10.1
|
|
IPPROTO_UDPLITE: int
|
|
if sys.version_info >= (3, 10) and sys.platform == "linux":
|
|
IPPROTO_MPTCP: int
|
|
|
|
IPPORT_RESERVED: int
|
|
IPPORT_USERRESERVED: int
|
|
|
|
INADDR_ALLHOSTS_GROUP: int
|
|
INADDR_ANY: int
|
|
INADDR_BROADCAST: int
|
|
INADDR_LOOPBACK: int
|
|
INADDR_MAX_LOCAL_GROUP: int
|
|
INADDR_NONE: int
|
|
INADDR_UNSPEC_GROUP: int
|
|
|
|
IP_ADD_MEMBERSHIP: int
|
|
IP_DROP_MEMBERSHIP: int
|
|
IP_HDRINCL: int
|
|
IP_MULTICAST_IF: int
|
|
IP_MULTICAST_LOOP: int
|
|
IP_MULTICAST_TTL: int
|
|
IP_OPTIONS: int
|
|
IP_RECVDSTADDR: int
|
|
if sys.version_info >= (3, 10):
|
|
IP_RECVTOS: int
|
|
elif sys.platform != "win32" and sys.platform != "darwin":
|
|
IP_RECVTOS: int
|
|
IP_TOS: int
|
|
IP_TTL: int
|
|
if sys.platform != "win32":
|
|
IP_DEFAULT_MULTICAST_LOOP: int
|
|
IP_DEFAULT_MULTICAST_TTL: int
|
|
IP_MAX_MEMBERSHIPS: int
|
|
IP_RECVOPTS: int
|
|
IP_RECVRETOPTS: int
|
|
IP_RETOPTS: int
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
IP_TRANSPARENT: int
|
|
IP_BIND_ADDRESS_NO_PORT: int
|
|
if sys.version_info >= (3, 12):
|
|
IP_ADD_SOURCE_MEMBERSHIP: int
|
|
IP_BLOCK_SOURCE: int
|
|
IP_DROP_SOURCE_MEMBERSHIP: int
|
|
IP_PKTINFO: int
|
|
IP_UNBLOCK_SOURCE: int
|
|
|
|
IPV6_CHECKSUM: int
|
|
IPV6_JOIN_GROUP: int
|
|
IPV6_LEAVE_GROUP: int
|
|
IPV6_MULTICAST_HOPS: int
|
|
IPV6_MULTICAST_IF: int
|
|
IPV6_MULTICAST_LOOP: int
|
|
IPV6_RECVTCLASS: int
|
|
IPV6_TCLASS: int
|
|
IPV6_UNICAST_HOPS: int
|
|
IPV6_V6ONLY: int
|
|
if sys.version_info >= (3, 9) or sys.platform != "darwin":
|
|
IPV6_DONTFRAG: int
|
|
IPV6_HOPLIMIT: int
|
|
IPV6_HOPOPTS: int
|
|
IPV6_PKTINFO: int
|
|
IPV6_RECVRTHDR: int
|
|
IPV6_RTHDR: int
|
|
if sys.platform != "win32":
|
|
IPV6_RTHDR_TYPE_0: int
|
|
if sys.version_info >= (3, 9) or sys.platform != "darwin":
|
|
IPV6_DSTOPTS: int
|
|
IPV6_NEXTHOP: int
|
|
IPV6_PATHMTU: int
|
|
IPV6_RECVDSTOPTS: int
|
|
IPV6_RECVHOPLIMIT: int
|
|
IPV6_RECVHOPOPTS: int
|
|
IPV6_RECVPATHMTU: int
|
|
IPV6_RECVPKTINFO: int
|
|
IPV6_RTHDRDSTOPTS: int
|
|
IPV6_USE_MIN_MTU: int
|
|
|
|
EAI_AGAIN: int
|
|
EAI_BADFLAGS: int
|
|
EAI_FAIL: int
|
|
EAI_FAMILY: int
|
|
EAI_MEMORY: int
|
|
EAI_NODATA: int
|
|
EAI_NONAME: int
|
|
EAI_SERVICE: int
|
|
EAI_SOCKTYPE: int
|
|
if sys.platform != "win32":
|
|
EAI_ADDRFAMILY: int
|
|
EAI_BADHINTS: int
|
|
EAI_MAX: int
|
|
EAI_OVERFLOW: int
|
|
EAI_PROTOCOL: int
|
|
EAI_SYSTEM: int
|
|
|
|
AI_ADDRCONFIG: int
|
|
AI_ALL: int
|
|
AI_CANONNAME: int
|
|
AI_NUMERICHOST: int
|
|
AI_NUMERICSERV: int
|
|
AI_PASSIVE: int
|
|
AI_V4MAPPED: int
|
|
if sys.platform != "win32":
|
|
AI_DEFAULT: int
|
|
AI_MASK: int
|
|
AI_V4MAPPED_CFG: int
|
|
|
|
NI_DGRAM: int
|
|
NI_MAXHOST: int
|
|
NI_MAXSERV: int
|
|
NI_NAMEREQD: int
|
|
NI_NOFQDN: int
|
|
NI_NUMERICHOST: int
|
|
NI_NUMERICSERV: int
|
|
|
|
TCP_FASTOPEN: int
|
|
TCP_KEEPCNT: int
|
|
TCP_KEEPINTVL: int
|
|
TCP_MAXSEG: int
|
|
TCP_NODELAY: int
|
|
if sys.platform != "win32":
|
|
TCP_NOTSENT_LOWAT: int
|
|
if sys.platform != "darwin":
|
|
TCP_KEEPIDLE: int
|
|
if sys.version_info >= (3, 10) and sys.platform == "darwin":
|
|
TCP_KEEPALIVE: int
|
|
if sys.version_info >= (3, 11) and sys.platform == "darwin":
|
|
TCP_CONNECTION_INFO: int
|
|
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
TCP_CONGESTION: int
|
|
TCP_CORK: int
|
|
TCP_DEFER_ACCEPT: int
|
|
TCP_INFO: int
|
|
TCP_LINGER2: int
|
|
TCP_QUICKACK: int
|
|
TCP_SYNCNT: int
|
|
TCP_USER_TIMEOUT: int
|
|
TCP_WINDOW_CLAMP: int
|
|
|
|
# --------------------
|
|
# Specifically documented constants
|
|
# --------------------
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.25, NetBSD >= 8
|
|
AF_CAN: int
|
|
PF_CAN: int
|
|
SOL_CAN_BASE: int
|
|
SOL_CAN_RAW: int
|
|
CAN_EFF_FLAG: int
|
|
CAN_EFF_MASK: int
|
|
CAN_ERR_FLAG: int
|
|
CAN_ERR_MASK: int
|
|
CAN_RAW: int
|
|
CAN_RAW_ERR_FILTER: int
|
|
CAN_RAW_FILTER: int
|
|
CAN_RAW_LOOPBACK: int
|
|
CAN_RAW_RECV_OWN_MSGS: int
|
|
CAN_RTR_FLAG: int
|
|
CAN_SFF_MASK: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.25
|
|
CAN_BCM: int
|
|
CAN_BCM_TX_SETUP: int
|
|
CAN_BCM_TX_DELETE: int
|
|
CAN_BCM_TX_READ: int
|
|
CAN_BCM_TX_SEND: int
|
|
CAN_BCM_RX_SETUP: int
|
|
CAN_BCM_RX_DELETE: int
|
|
CAN_BCM_RX_READ: int
|
|
CAN_BCM_TX_STATUS: int
|
|
CAN_BCM_TX_EXPIRED: int
|
|
CAN_BCM_RX_STATUS: int
|
|
CAN_BCM_RX_TIMEOUT: int
|
|
CAN_BCM_RX_CHANGED: int
|
|
CAN_BCM_SETTIMER: int
|
|
CAN_BCM_STARTTIMER: int
|
|
CAN_BCM_TX_COUNTEVT: int
|
|
CAN_BCM_TX_ANNOUNCE: int
|
|
CAN_BCM_TX_CP_CAN_ID: int
|
|
CAN_BCM_RX_FILTER_ID: int
|
|
CAN_BCM_RX_CHECK_DLC: int
|
|
CAN_BCM_RX_NO_AUTOTIMER: int
|
|
CAN_BCM_RX_ANNOUNCE_RESUME: int
|
|
CAN_BCM_TX_RESET_MULTI_IDX: int
|
|
CAN_BCM_RX_RTR_FRAME: int
|
|
CAN_BCM_CAN_FD_FRAME: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 3.6
|
|
CAN_RAW_FD_FRAMES: int
|
|
|
|
if sys.platform == "linux" and sys.version_info >= (3, 9):
|
|
# Availability: Linux >= 4.1
|
|
CAN_RAW_JOIN_FILTERS: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.25
|
|
CAN_ISOTP: int
|
|
|
|
if sys.platform == "linux" and sys.version_info >= (3, 9):
|
|
# Availability: Linux >= 5.4
|
|
CAN_J1939: int
|
|
|
|
J1939_MAX_UNICAST_ADDR: int
|
|
J1939_IDLE_ADDR: int
|
|
J1939_NO_ADDR: int
|
|
J1939_NO_NAME: int
|
|
J1939_PGN_REQUEST: int
|
|
J1939_PGN_ADDRESS_CLAIMED: int
|
|
J1939_PGN_ADDRESS_COMMANDED: int
|
|
J1939_PGN_PDU1_MAX: int
|
|
J1939_PGN_MAX: int
|
|
J1939_NO_PGN: int
|
|
|
|
SO_J1939_FILTER: int
|
|
SO_J1939_PROMISC: int
|
|
SO_J1939_SEND_PRIO: int
|
|
SO_J1939_ERRQUEUE: int
|
|
|
|
SCM_J1939_DEST_ADDR: int
|
|
SCM_J1939_DEST_NAME: int
|
|
SCM_J1939_PRIO: int
|
|
SCM_J1939_ERRQUEUE: int
|
|
|
|
J1939_NLA_PAD: int
|
|
J1939_NLA_BYTES_ACKED: int
|
|
J1939_EE_INFO_NONE: int
|
|
J1939_EE_INFO_TX_ABORT: int
|
|
J1939_FILTER_MAX: int
|
|
|
|
if sys.version_info >= (3, 12) and sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin":
|
|
# Availability: FreeBSD >= 14.0
|
|
AF_DIVERT: int
|
|
PF_DIVERT: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.2
|
|
AF_PACKET: int
|
|
PF_PACKET: int
|
|
PACKET_BROADCAST: int
|
|
PACKET_FASTROUTE: int
|
|
PACKET_HOST: int
|
|
PACKET_LOOPBACK: int
|
|
PACKET_MULTICAST: int
|
|
PACKET_OTHERHOST: int
|
|
PACKET_OUTGOING: int
|
|
|
|
if sys.version_info >= (3, 12) and sys.platform == "linux":
|
|
ETH_P_ALL: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.30
|
|
AF_RDS: int
|
|
PF_RDS: int
|
|
SOL_RDS: int
|
|
RDS_CANCEL_SENT_TO: int
|
|
RDS_CMSG_RDMA_ARGS: int
|
|
RDS_CMSG_RDMA_DEST: int
|
|
RDS_CMSG_RDMA_MAP: int
|
|
RDS_CMSG_RDMA_STATUS: int
|
|
RDS_CMSG_RDMA_UPDATE: int
|
|
RDS_CONG_MONITOR: int
|
|
RDS_FREE_MR: int
|
|
RDS_GET_MR: int
|
|
RDS_GET_MR_FOR_DEST: int
|
|
RDS_RDMA_DONTWAIT: int
|
|
RDS_RDMA_FENCE: int
|
|
RDS_RDMA_INVALIDATE: int
|
|
RDS_RDMA_NOTIFY_ME: int
|
|
RDS_RDMA_READWRITE: int
|
|
RDS_RDMA_SILENT: int
|
|
RDS_RDMA_USE_ONCE: int
|
|
RDS_RECVERR: int
|
|
|
|
if sys.platform == "win32":
|
|
SIO_RCVALL: int
|
|
SIO_KEEPALIVE_VALS: int
|
|
SIO_LOOPBACK_FAST_PATH: int
|
|
RCVALL_MAX: int
|
|
RCVALL_OFF: int
|
|
RCVALL_ON: int
|
|
RCVALL_SOCKETLEVELONLY: int
|
|
|
|
if sys.platform == "linux":
|
|
AF_TIPC: int
|
|
SOL_TIPC: int
|
|
TIPC_ADDR_ID: int
|
|
TIPC_ADDR_NAME: int
|
|
TIPC_ADDR_NAMESEQ: int
|
|
TIPC_CFG_SRV: int
|
|
TIPC_CLUSTER_SCOPE: int
|
|
TIPC_CONN_TIMEOUT: int
|
|
TIPC_CRITICAL_IMPORTANCE: int
|
|
TIPC_DEST_DROPPABLE: int
|
|
TIPC_HIGH_IMPORTANCE: int
|
|
TIPC_IMPORTANCE: int
|
|
TIPC_LOW_IMPORTANCE: int
|
|
TIPC_MEDIUM_IMPORTANCE: int
|
|
TIPC_NODE_SCOPE: int
|
|
TIPC_PUBLISHED: int
|
|
TIPC_SRC_DROPPABLE: int
|
|
TIPC_SUBSCR_TIMEOUT: int
|
|
TIPC_SUB_CANCEL: int
|
|
TIPC_SUB_PORTS: int
|
|
TIPC_SUB_SERVICE: int
|
|
TIPC_TOP_SRV: int
|
|
TIPC_WAIT_FOREVER: int
|
|
TIPC_WITHDRAWN: int
|
|
TIPC_ZONE_SCOPE: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 2.6.38
|
|
AF_ALG: int
|
|
SOL_ALG: int
|
|
ALG_OP_DECRYPT: int
|
|
ALG_OP_ENCRYPT: int
|
|
ALG_OP_SIGN: int
|
|
ALG_OP_VERIFY: int
|
|
ALG_SET_AEAD_ASSOCLEN: int
|
|
ALG_SET_AEAD_AUTHSIZE: int
|
|
ALG_SET_IV: int
|
|
ALG_SET_KEY: int
|
|
ALG_SET_OP: int
|
|
ALG_SET_PUBKEY: int
|
|
|
|
if sys.platform == "linux":
|
|
# Availability: Linux >= 4.8 (or maybe 3.9, CPython docs are confusing)
|
|
AF_VSOCK: int
|
|
IOCTL_VM_SOCKETS_GET_LOCAL_CID: int
|
|
VMADDR_CID_ANY: int
|
|
VMADDR_CID_HOST: int
|
|
VMADDR_PORT_ANY: int
|
|
SO_VM_SOCKETS_BUFFER_MAX_SIZE: int
|
|
SO_VM_SOCKETS_BUFFER_SIZE: int
|
|
SO_VM_SOCKETS_BUFFER_MIN_SIZE: int
|
|
VM_SOCKETS_INVALID_VERSION: int # undocumented
|
|
|
|
if sys.platform != "win32" or sys.version_info >= (3, 9):
|
|
# Documented as only available on BSD, macOS, but empirically sometimes
|
|
# available on Windows
|
|
AF_LINK: int
|
|
|
|
has_ipv6: bool
|
|
|
|
if sys.platform != "darwin":
|
|
if sys.platform != "win32" or sys.version_info >= (3, 9):
|
|
BDADDR_ANY: str
|
|
BDADDR_LOCAL: str
|
|
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
HCI_FILTER: int # not in NetBSD or DragonFlyBSD
|
|
HCI_TIME_STAMP: int # not in FreeBSD, NetBSD, or DragonFlyBSD
|
|
HCI_DATA_DIR: int # not in FreeBSD, NetBSD, or DragonFlyBSD
|
|
|
|
if sys.platform == "linux":
|
|
AF_QIPCRTR: int # Availability: Linux >= 4.7
|
|
|
|
if sys.version_info >= (3, 11) and sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin":
|
|
# FreeBSD
|
|
SCM_CREDS2: int
|
|
LOCAL_CREDS: int
|
|
LOCAL_CREDS_PERSISTENT: int
|
|
|
|
if sys.version_info >= (3, 11) and sys.platform == "linux":
|
|
SO_INCOMING_CPU: int # Availability: Linux >= 3.9
|
|
|
|
if sys.version_info >= (3, 12) and sys.platform == "win32":
|
|
# Availability: Windows
|
|
AF_HYPERV: int
|
|
HV_PROTOCOL_RAW: int
|
|
HVSOCKET_CONNECT_TIMEOUT: int
|
|
HVSOCKET_CONNECT_TIMEOUT_MAX: int
|
|
HVSOCKET_CONNECTED_SUSPEND: int
|
|
HVSOCKET_ADDRESS_FLAG_PASSTHRU: int
|
|
HV_GUID_ZERO: str
|
|
HV_GUID_WILDCARD: str
|
|
HV_GUID_BROADCAST: str
|
|
HV_GUID_CHILDREN: str
|
|
HV_GUID_LOOPBACK: str
|
|
HV_GUID_PARENT: str
|
|
|
|
if sys.version_info >= (3, 12):
|
|
if sys.platform != "win32":
|
|
# Availability: Linux, FreeBSD, macOS
|
|
ETHERTYPE_ARP: int
|
|
ETHERTYPE_IP: int
|
|
ETHERTYPE_IPV6: int
|
|
ETHERTYPE_VLAN: int
|
|
|
|
# --------------------
|
|
# Semi-documented constants
|
|
# These are alluded to under the "Socket families" section in the docs
|
|
# https://docs.python.org/3/library/socket.html#socket-families
|
|
# --------------------
|
|
|
|
if sys.platform == "linux":
|
|
# Netlink is defined by Linux
|
|
AF_NETLINK: int
|
|
NETLINK_ARPD: int
|
|
NETLINK_CRYPTO: int
|
|
NETLINK_DNRTMSG: int
|
|
NETLINK_FIREWALL: int
|
|
NETLINK_IP6_FW: int
|
|
NETLINK_NFLOG: int
|
|
NETLINK_ROUTE6: int
|
|
NETLINK_ROUTE: int
|
|
NETLINK_SKIP: int
|
|
NETLINK_TAPBASE: int
|
|
NETLINK_TCPDIAG: int
|
|
NETLINK_USERSOCK: int
|
|
NETLINK_W1: int
|
|
NETLINK_XFRM: int
|
|
|
|
if sys.platform == "darwin":
|
|
PF_SYSTEM: int
|
|
SYSPROTO_CONTROL: int
|
|
|
|
if sys.platform != "darwin":
|
|
if sys.version_info >= (3, 9) or sys.platform != "win32":
|
|
AF_BLUETOOTH: int
|
|
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
# Linux and some BSD support is explicit in the docs
|
|
# Windows and macOS do not support in practice
|
|
BTPROTO_HCI: int
|
|
BTPROTO_L2CAP: int
|
|
BTPROTO_SCO: int # not in FreeBSD
|
|
if sys.platform != "darwin":
|
|
if sys.version_info >= (3, 9) or sys.platform != "win32":
|
|
BTPROTO_RFCOMM: int
|
|
|
|
if sys.version_info >= (3, 9) and sys.platform == "linux":
|
|
UDPLITE_RECV_CSCOV: int
|
|
UDPLITE_SEND_CSCOV: int
|
|
|
|
# --------------------
|
|
# Documented under socket.shutdown
|
|
# --------------------
|
|
SHUT_RD: int
|
|
SHUT_RDWR: int
|
|
SHUT_WR: int
|
|
|
|
# --------------------
|
|
# Undocumented constants
|
|
# --------------------
|
|
|
|
# Undocumented address families
|
|
AF_APPLETALK: int
|
|
AF_DECnet: int
|
|
AF_IPX: int
|
|
AF_SNA: int
|
|
|
|
if sys.platform != "win32":
|
|
AF_ROUTE: int
|
|
AF_SYSTEM: int
|
|
|
|
if sys.platform != "darwin":
|
|
AF_IRDA: int
|
|
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
AF_AAL5: int
|
|
AF_ASH: int
|
|
AF_ATMPVC: int
|
|
AF_ATMSVC: int
|
|
AF_AX25: int
|
|
AF_BRIDGE: int
|
|
AF_ECONET: int
|
|
AF_KEY: int
|
|
AF_LLC: int
|
|
AF_NETBEUI: int
|
|
AF_NETROM: int
|
|
AF_PPPOX: int
|
|
AF_ROSE: int
|
|
AF_SECURITY: int
|
|
AF_WANPIPE: int
|
|
AF_X25: int
|
|
|
|
# Miscellaneous undocumented
|
|
|
|
if sys.platform != "win32":
|
|
LOCAL_PEERCRED: int
|
|
|
|
if sys.platform != "win32" and sys.platform != "darwin":
|
|
IPX_TYPE: int
|
|
|
|
# ===== Classes =====
|
|
|
|
class socket:
|
|
@property
|
|
def family(self) -> int: ...
|
|
@property
|
|
def type(self) -> int: ...
|
|
@property
|
|
def proto(self) -> int: ...
|
|
# F811: "Redefinition of unused `timeout`"
|
|
@property
|
|
def timeout(self) -> float | None: ... # noqa: F811
|
|
if sys.platform == "win32":
|
|
def __init__(
|
|
self, family: int = ..., type: int = ..., proto: int = ..., fileno: SupportsIndex | bytes | None = ...
|
|
) -> None: ...
|
|
else:
|
|
def __init__(self, family: int = ..., type: int = ..., proto: int = ..., fileno: SupportsIndex | None = ...) -> None: ...
|
|
|
|
def bind(self, address: _Address, /) -> None: ...
|
|
def close(self) -> None: ...
|
|
def connect(self, address: _Address, /) -> None: ...
|
|
def connect_ex(self, address: _Address, /) -> int: ...
|
|
def detach(self) -> int: ...
|
|
def fileno(self) -> int: ...
|
|
def getpeername(self) -> _RetAddress: ...
|
|
def getsockname(self) -> _RetAddress: ...
|
|
@overload
|
|
def getsockopt(self, level: int, optname: int, /) -> int: ...
|
|
@overload
|
|
def getsockopt(self, level: int, optname: int, buflen: int, /) -> bytes: ...
|
|
def getblocking(self) -> bool: ...
|
|
def gettimeout(self) -> float | None: ...
|
|
if sys.platform == "win32":
|
|
def ioctl(self, control: int, option: int | tuple[int, int, int] | bool, /) -> None: ...
|
|
|
|
def listen(self, backlog: int = ..., /) -> None: ...
|
|
def recv(self, bufsize: int, flags: int = ..., /) -> bytes: ...
|
|
def recvfrom(self, bufsize: int, flags: int = ..., /) -> tuple[bytes, _RetAddress]: ...
|
|
if sys.platform != "win32":
|
|
def recvmsg(self, bufsize: int, ancbufsize: int = ..., flags: int = ..., /) -> tuple[bytes, list[_CMSG], int, Any]: ...
|
|
def recvmsg_into(
|
|
self, buffers: Iterable[WriteableBuffer], ancbufsize: int = ..., flags: int = ..., /
|
|
) -> tuple[int, list[_CMSG], int, Any]: ...
|
|
|
|
def recvfrom_into(self, buffer: WriteableBuffer, nbytes: int = ..., flags: int = ...) -> tuple[int, _RetAddress]: ...
|
|
def recv_into(self, buffer: WriteableBuffer, nbytes: int = ..., flags: int = ...) -> int: ...
|
|
def send(self, data: ReadableBuffer, flags: int = ..., /) -> int: ...
|
|
def sendall(self, data: ReadableBuffer, flags: int = ..., /) -> None: ...
|
|
@overload
|
|
def sendto(self, data: ReadableBuffer, address: _Address, /) -> int: ...
|
|
@overload
|
|
def sendto(self, data: ReadableBuffer, flags: int, address: _Address, /) -> int: ...
|
|
if sys.platform != "win32":
|
|
def sendmsg(
|
|
self,
|
|
buffers: Iterable[ReadableBuffer],
|
|
ancdata: Iterable[_CMSGArg] = ...,
|
|
flags: int = ...,
|
|
address: _Address | None = ...,
|
|
/,
|
|
) -> int: ...
|
|
if sys.platform == "linux":
|
|
def sendmsg_afalg(
|
|
self, msg: Iterable[ReadableBuffer] = ..., *, op: int, iv: Any = ..., assoclen: int = ..., flags: int = ...
|
|
) -> int: ...
|
|
|
|
def setblocking(self, flag: bool, /) -> None: ...
|
|
def settimeout(self, value: float | None, /) -> None: ...
|
|
@overload
|
|
def setsockopt(self, level: int, optname: int, value: int | ReadableBuffer, /) -> None: ...
|
|
@overload
|
|
def setsockopt(self, level: int, optname: int, value: None, optlen: int, /) -> None: ...
|
|
if sys.platform == "win32":
|
|
def share(self, process_id: int, /) -> bytes: ...
|
|
|
|
def shutdown(self, how: int, /) -> None: ...
|
|
|
|
SocketType = socket
|
|
|
|
# ===== Functions =====
|
|
|
|
def close(fd: SupportsIndex, /) -> None: ...
|
|
def dup(fd: SupportsIndex, /) -> int: ...
|
|
|
|
# the 5th tuple item is an address
|
|
def getaddrinfo(
|
|
host: bytes | str | None,
|
|
port: bytes | str | int | None,
|
|
family: int = ...,
|
|
type: int = ...,
|
|
proto: int = ...,
|
|
flags: int = ...,
|
|
) -> list[tuple[int, int, int, str, tuple[str, int] | tuple[str, int, int, int]]]: ...
|
|
def gethostbyname(hostname: str, /) -> str: ...
|
|
def gethostbyname_ex(hostname: str, /) -> tuple[str, list[str], list[str]]: ...
|
|
def gethostname() -> str: ...
|
|
def gethostbyaddr(ip_address: str, /) -> tuple[str, list[str], list[str]]: ...
|
|
def getnameinfo(sockaddr: tuple[str, int] | tuple[str, int, int, int], flags: int, /) -> tuple[str, str]: ...
|
|
def getprotobyname(protocolname: str, /) -> int: ...
|
|
def getservbyname(servicename: str, protocolname: str = ..., /) -> int: ...
|
|
def getservbyport(port: int, protocolname: str = ..., /) -> str: ...
|
|
def ntohl(x: int, /) -> int: ... # param & ret val are 32-bit ints
|
|
def ntohs(x: int, /) -> int: ... # param & ret val are 16-bit ints
|
|
def htonl(x: int, /) -> int: ... # param & ret val are 32-bit ints
|
|
def htons(x: int, /) -> int: ... # param & ret val are 16-bit ints
|
|
def inet_aton(ip_addr: str, /) -> bytes: ... # ret val 4 bytes in length
|
|
def inet_ntoa(packed_ip: ReadableBuffer, /) -> str: ...
|
|
def inet_pton(address_family: int, ip_string: str, /) -> bytes: ...
|
|
def inet_ntop(address_family: int, packed_ip: ReadableBuffer, /) -> str: ...
|
|
def getdefaulttimeout() -> float | None: ...
|
|
|
|
# F811: "Redefinition of unused `timeout`"
|
|
def setdefaulttimeout(timeout: float | None, /) -> None: ... # noqa: F811
|
|
|
|
if sys.platform != "win32":
|
|
def sethostname(name: str, /) -> None: ...
|
|
def CMSG_LEN(length: int, /) -> int: ...
|
|
def CMSG_SPACE(length: int, /) -> int: ...
|
|
def socketpair(family: int = ..., type: int = ..., proto: int = ..., /) -> tuple[socket, socket]: ...
|
|
|
|
def if_nameindex() -> list[tuple[int, str]]: ...
|
|
def if_nametoindex(oname: str, /) -> int: ...
|
|
def if_indextoname(index: int, /) -> str: ...
|
|
|
|
CAPI: object
|