socket
— Low-level networking interface¶
Source code: Lib/socket.py
This module provides access to the BSD socket interface. It is available on all modern Unix systems, Windows, MacOS, and probably additional platforms.
Note
Some behavior may be platform dependent, since calls are made to the operating system socket APIs.
Availability: not WASI.
This module does not work or is not available on WebAssembly. See WebAssembly platforms for more information.
The Python interface is a straightforward transliteration of the Unix system
call and library interface for sockets to Python’s object-oriented style: the
socket()
function returns a socket object whose methods implement
the various socket system calls. Parameter types are somewhat higher-level than
in the C interface: as with read()
and write()
operations on Python
files, buffer allocation on receive operations is automatic, and buffer length
is implicit on send operations.
See also
- Module
socketserver
Classes that simplify writing network servers.
- Module
ssl
A TLS/SSL wrapper for socket objects.
Socket families¶
Depending on the system and the build options, various socket families are supported by this module.
The address format required by a particular socket object is automatically selected based on the address family specified when the socket object was created. Socket addresses are represented as follows:
The address of an
AF_UNIX
socket bound to a file system node is represented as a string, using the file system encoding and the'surrogateescape'
error handler (see PEP 383). An address in Linux’s abstract namespace is returned as a bytes-like object with an initial null byte; note that sockets in this namespace can communicate with normal file system sockets, so programs intended to run on Linux may need to deal with both types of address. A string or bytes-like object can be used for either type of address when passing it as an argument.Changed in version 3.3: Previously,
AF_UNIX
socket paths were assumed to use UTF-8 encoding.Changed in version 3.5: Writable bytes-like object is now accepted.
A pair
(host, port)
is used for theAF_INET
address family, where host is a string representing either a hostname in internet domain notation like'daring.cwi.nl'
or an IPv4 address like'100.50.200.5'
, and port is an integer.For IPv4 addresses, two special forms are accepted instead of a host address:
''
representsINADDR_ANY
, which is used to bind to all interfaces, and the string'<broadcast>'
representsINADDR_BROADCAST
. This behavior is not compatible with IPv6, therefore, you may want to avoid these if you intend to support IPv6 with your Python programs.
For
AF_INET6
address family, a four-tuple(host, port, flowinfo, scope_id)
is used, where flowinfo and scope_id represent thesin6_flowinfo
andsin6_scope_id
members instruct sockaddr_in6
in C. Forsocket
module methods, flowinfo and scope_id can be omitted just for backward compatibility. Note, however, omission of scope_id can cause problems in manipulating scoped IPv6 addresses.Changed in version 3.7: For multicast addresses (with scope_id meaningful) address may not contain
%scope_id
(orzone id
) part. This information is superfluous and may be safely omitted (recommended).AF_NETLINK
sockets are represented as pairs(pid, groups)
.Linux-only support for TIPC is available using the
AF_TIPC
address family. TIPC is an open, non-IP based networked protocol designed for use in clustered computer environments. Addresses are represented by a tuple, and the fields depend on the address type. The general tuple form is(addr_type, v1, v2, v3 [, scope])
, where:addr_type is one of
TIPC_ADDR_NAMESEQ
,TIPC_ADDR_NAME
, orTIPC_ADDR_ID
.scope is one of
TIPC_ZONE_SCOPE
,TIPC_CLUSTER_SCOPE
, andTIPC_NODE_SCOPE
.If addr_type is
TIPC_ADDR_NAME
, then v1 is the server type, v2 is the port identifier, and v3 should be 0.If addr_type is
TIPC_ADDR_NAMESEQ
, then v1 is the server type, v2 is the lower port number, and v3 is the upper port number.If addr_type is
TIPC_ADDR_ID
, then v1 is the node, v2 is the reference, and v3 should be set to 0.
A tuple
(interface, )
is used for theAF_CAN
address family, where interface is a string representing a network interface name like'can0'
. The network interface name''
can be used to receive packets from all network interfaces of this family.CAN_ISOTP
protocol require a tuple(interface, rx_addr, tx_addr)
where both additional parameters are unsigned long integer that represent a CAN identifier (standard or extended).CAN_J1939
protocol require a tuple(interface, name, pgn, addr)
where additional parameters are 64-bit unsigned integer representing the ECU name, a 32-bit unsigned integer representing the Parameter Group Number (PGN), and an 8-bit integer representing the address.
A string or a tuple
(id, unit)
is used for theSYSPROTO_CONTROL
protocol of thePF_SYSTEM
family. The string is the name of a kernel control using a dynamically assigned ID. The tuple can be used if ID and unit number of the kernel control are known or if a registered ID is used.Added in version 3.3.
AF_BLUETOOTH
supports the following protocols and address formats:BTPROTO_L2CAP
accepts(bdaddr, psm)
wherebdaddr
is the Bluetooth address as a string andpsm
is an integer.BTPROTO_RFCOMM
accepts(bdaddr, channel)
wherebdaddr
is the Bluetooth address as a string andchannel
is an integer.BTPROTO_HCI
accepts a format that depends on your OS.On Linux it accepts a tuple
(device_id,)
wheredevice_id
is an integer specifying the number of the Bluetooth device.On FreeBSD, NetBSD and DragonFly BSD it accepts
bdaddr
wherebdaddr
is the Bluetooth address as a string.
Changed in version 3.2: NetBSD and DragonFlyBSD support added.
Changed in version 3.13.3: FreeBSD support added.
BTPROTO_SCO
acceptsbdaddr
wherebdaddr
is the Bluetooth address as a string or abytes
object. (ex.'12:23:34:45:56:67'
orb'12:23:34:45:56:67'
) This protocol is not supported under FreeBSD.
AF_ALG
is a Linux-only socket based interface to Kernel cryptography. An algorithm socket is configured with a tuple of two to four elements(type, name [, feat [, mask]])
, where:type is the algorithm type as string, e.g.
aead
,hash
,skcipher
orrng
.name is the algorithm name and operation mode as string, e.g.
sha256
,hmac(sha256)
,cbc(aes)
ordrbg_nopr_ctr_aes256
.feat and mask are unsigned 32bit integers.
Availability: Linux >= 2.6.38.
Some algorithm types require more recent Kernels.
Added in version 3.6.
AF_VSOCK
allows communication between virtual machines and their hosts. The sockets are represented as a(CID, port)
tuple where the context ID or CID and port are integers.Availability: Linux >= 3.9
See vsock(7)
Added in version 3.7.
AF_PACKET
is a low-level interface directly to network devices. The addresses are represented by the tuple(ifname, proto[, pkttype[, hatype[, addr]]])
where:ifname - String specifying the device name.
proto - The Ethernet protocol number. May be
ETH_P_ALL
to capture all protocols, one of the ETHERTYPE_* constants or any other Ethernet protocol number.pkttype - Optional integer specifying the packet type:
PACKET_HOST
(the default) - Packet addressed to the local host.PACKET_BROADCAST
- Physical-layer broadcast packet.PACKET_MULTICAST
- Packet sent to a physical-layer multicast address.PACKET_OTHERHOST
- Packet to some other host that has been caught by a device driver in promiscuous mode.PACKET_OUTGOING
- Packet originating from the local host that is looped back to a packet socket.
hatype - Optional integer specifying the ARP hardware address type.
addr - Optional bytes-like object specifying the hardware physical address, whose interpretation depends on the device.
Availability: Linux >= 2.2.
AF_QIPCRTR
is a Linux-only socket based interface for communicating with services running on co-processors in Qualcomm platforms. The address family is represented as a(node, port)
tuple where the node and port are non-negative integers.Availability: Linux >= 4.7.
Added in version 3.8.
IPPROTO_UDPLITE
is a variant of UDP which allows you to specify what portion of a packet is covered with the checksum. It adds two socket options that you can change.self.setsockopt(IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, length)
will change what portion of outgoing packets are covered by the checksum andself.setsockopt(IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, length)
will filter out packets which cover too little of their data. In both caseslength
should be inrange(8, 2**16, 8)
.Such a socket should be constructed with
socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE)
for IPv4 orsocket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE)
for IPv6.Availability: Linux >= 2.6.20, FreeBSD >= 10.1
Added in version 3.9.
AF_HYPERV
is a Windows-only socket based interface for communicating with Hyper-V hosts and guests. The address family is represented as a(vm_id, service_id)
tuple where thevm_id
andservice_id
are UUID strings.The
vm_id
is the virtual machine identifier or a set of known VMID values if the target is not a specific virtual machine. Known VMID constants defined onsocket
are:HV_GUID_ZERO
HV_GUID_BROADCAST
HV_GUID_WILDCARD
- Used to bind on itself and accept connections from all partitions.HV_GUID_CHILDREN
- Used to bind on itself and accept connection from child partitions.HV_GUID_LOOPBACK
- Used as a target to itself.HV_GUID_PARENT
- When used as a bind accepts connection from the parent partition. When used as an address target it will connect to the parent partition.
The
service_id
is the service identifier of the registered service.Added in version 3.12.
If you use a hostname in the host portion of IPv4/v6 socket address, the program may show a nondeterministic behavior, as Python uses the first address returned from the DNS resolution. The socket address will be resolved differently into an actual IPv4/v6 address, depending on the results from DNS resolution and/or the host configuration. For deterministic behavior use a numeric address in host portion.
All errors raise exceptions. The normal exceptions for invalid argument types
and out-of-memory conditions can be raised. Errors
related to socket or address semantics raise OSError
or one of its
subclasses.
Non-blocking mode is supported through setblocking()
. A
generalization of this based on timeouts is supported through
settimeout()
.
Module contents¶
The module socket
exports the following elements.
Exceptions¶
- exception socket.herror¶
A subclass of
OSError
, this exception is raised for address-related errors, i.e. for functions that use h_errno in the POSIX C API, includinggethostbyname_ex()
andgethostbyaddr()
. The accompanying value is a pair(h_errno, string)
representing an error returned by a library call. h_errno is a numeric value, while string represents the description of h_errno, as returned by thehstrerror()
C function.Changed in version 3.3: This class was made a subclass of
OSError
.
- exception socket.gaierror¶
A subclass of
OSError
, this exception is raised for address-related errors bygetaddrinfo()
andgetnameinfo()
. The accompanying value is a pair(error, string)
representing an error returned by a library call. string represents the description of error, as returned by thegai_strerror()
C function. The numeric error value will match one of theEAI_*
constants defined in this module.Changed in version 3.3: This class was made a subclass of
OSError
.
- exception socket.timeout¶
A deprecated alias of
TimeoutError
.A subclass of
OSError
, this exception is raised when a timeout occurs on a socket which has had timeouts enabled via a prior call tosettimeout()
(or implicitly throughsetdefaulttimeout()
). The accompanying value is a string whose value is currently always “timed out”.Changed in version 3.3: This class was made a subclass of
OSError
.Changed in version 3.10: This class was made an alias of
TimeoutError
.
Constants¶
The AF_* and SOCK_* constants are now AddressFamily
and
SocketKind
IntEnum
collections.
Added in version 3.4.
- socket.AF_UNIX¶
- socket.AF_INET¶
- socket.AF_INET6¶
These constants represent the address (and protocol) families, used for the first argument to
socket()
. If theAF_UNIX
constant is not defined then this protocol is unsupported. More constants may be available depending on the system.
- socket.AF_UNSPEC¶
AF_UNSPEC
means thatgetaddrinfo()
should return socket addresses for any address family (either IPv4, IPv6, or any other) that can be used.
- socket.SOCK_STREAM¶
- socket.SOCK_DGRAM¶
- socket.SOCK_RAW¶
- socket.SOCK_RDM¶
- socket.SOCK_SEQPACKET¶
These constants represent the socket types, used for the second argument to
socket()
. More constants may be available depending on the system. (OnlySOCK_STREAM
andSOCK_DGRAM
appear to be generally useful.)
- socket.SOCK_CLOEXEC¶
- socket.SOCK_NONBLOCK¶
These two constants, if defined, can be combined with the socket types and allow you to set some flags atomically (thus avoiding possible race conditions and the need for separate calls).
See also
Secure File Descriptor Handling for a more thorough explanation.
Availability: Linux >= 2.6.27.
Added in version 3.2.
- SO_*
- socket.SOMAXCONN¶
- MSG_*
- SOL_*
- SCM_*
- IPPROTO_*
- IPPORT_*
- INADDR_*
- IP_*
- IPV6_*
- EAI_*
- AI_*
- NI_*
- TCP_*
Many constants of these forms, documented in the Unix documentation on sockets and/or the IP protocol, are also defined in the socket module. They are generally used in arguments to the
setsockopt()
andgetsockopt()
methods of socket objects. In most cases, only those symbols that are defined in the Unix header files are defined; for a few symbols, default values are provided.Changed in version 3.6:
SO_DOMAIN
,SO_PROTOCOL
,SO_PEERSEC
,SO_PASSSEC
,TCP_USER_TIMEOUT
,TCP_CONGESTION
were added.Changed in version 3.6.5: On Windows,
TCP_FASTOPEN
,TCP_KEEPCNT
appear if run-time Windows supports.Changed in version 3.7:
TCP_NOTSENT_LOWAT
was added.On Windows,
TCP_KEEPIDLE
,TCP_KEEPINTVL
appear if run-time Windows supports.Changed in version 3.10:
IP_RECVTOS
was added. AddedTCP_KEEPALIVE
. On MacOS this constant can be used in the same way thatTCP_KEEPIDLE
is used on Linux.Changed in version 3.11: Added
TCP_CONNECTION_INFO
. On MacOS this constant can be used in the same way thatTCP_INFO
is used on Linux and BSD.Changed in version 3.12: Added
SO_RTABLE
andSO_USER_COOKIE
. On OpenBSD and FreeBSD respectively those constants can be used in the same way thatSO_MARK
is used on Linux. Also added missing TCP socket options from Linux:TCP_MD5SIG
,TCP_THIN_LINEAR_TIMEOUTS
,TCP_THIN_DUPACK
,TCP_REPAIR
,TCP_REPAIR_QUEUE
,TCP_QUEUE_SEQ
,TCP_REPAIR_OPTIONS
,TCP_TIMESTAMP
,TCP_CC_INFO
,TCP_SAVE_SYN
,TCP_SAVED_SYN
,TCP_REPAIR_WINDOW
,TCP_FASTOPEN_CONNECT
,TCP_ULP
,TCP_MD5SIG_EXT
,TCP_FASTOPEN_KEY
,TCP_FASTOPEN_NO_COOKIE
,TCP_ZEROCOPY_RECEIVE
,TCP_INQ
,TCP_TX_DELAY
. AddedIP_PKTINFO
,IP_UNBLOCK_SOURCE
,IP_BLOCK_SOURCE
,IP_ADD_SOURCE_MEMBERSHIP
,IP_DROP_SOURCE_MEMBERSHIP
.Changed in version 3.13: Added
SO_BINDTOIFINDEX
. On Linux this constant can be used in the same way thatSO_BINDTODEVICE
is used, but with the index of a network interface instead of its name.
- socket.AF_CAN¶
- socket.PF_CAN¶
- SOL_CAN_*
- CAN_*
Many constants of these forms, documented in the Linux documentation, are also defined in the socket module.
Availability: Linux >= 2.6.25, NetBSD >= 8.
Added in version 3.3.
Changed in version 3.11: NetBSD support was added.
Changed in version 3.13.4: Restored missing
CAN_RAW_ERR_FILTER
on Linux.
- socket.CAN_BCM¶
- CAN_BCM_*
CAN_BCM, in the CAN protocol family, is the broadcast manager (BCM) protocol. Broadcast manager constants, documented in the Linux documentation, are also defined in the socket module.
Availability: Linux >= 2.6.25.
Note
The
CAN_BCM_CAN_FD_FRAME
flag is only available on Linux >= 4.8.Added in version 3.4.
- socket.CAN_RAW_FD_FRAMES¶
Enables CAN FD support in a CAN_RAW socket. This is disabled by default. This allows your application to send both CAN and CAN FD frames; however, you must accept both CAN and CAN FD frames when reading from the socket.
This constant is documented in the Linux documentation.
Availability: Linux >= 3.6.
Added in version 3.5.
- socket.CAN_RAW_JOIN_FILTERS¶
Joins the applied CAN filters such that only CAN frames that match all given CAN filters are passed to user space.
This constant is documented in the Linux documentation.
Availability: Linux >= 4.1.
Added in version 3.9.
- socket.CAN_ISOTP¶
CAN_ISOTP, in the CAN protocol family, is the ISO-TP (ISO 15765-2) protocol. ISO-TP constants, documented in the Linux documentation.
Availability: Linux >= 2.6.25.
Added in version 3.7.
- socket.CAN_J1939¶
CAN_J1939, in the CAN protocol family, is the SAE J1939 protocol. J1939 constants, documented in the Linux documentation.
Availability: Linux >= 5.4.
Added in version 3.9.
- socket.AF_DIVERT¶
- socket.PF_DIVERT¶
These two constants, documented in the FreeBSD divert(4) manual page, are also defined in the socket module.
Availability: FreeBSD >= 14.0.
Added in version 3.12.
- socket.AF_PACKET¶
- socket.PF_PACKET¶
- PACKET_*
Many constants of these forms, documented in the Linux documentation, are also defined in the socket module.
Availability: Linux >= 2.2.
- socket.ETH_P_ALL¶
ETH_P_ALL
can be used in thesocket
constructor as proto for theAF_PACKET
family in order to capture every packet, regardless of protocol.For more information, see the packet(7) manpage.
Availability: Linux.
Added in version 3.12.
- socket.AF_RDS¶
- socket.PF_RDS¶
- socket.SOL_RDS¶
- RDS_*
Many constants of these forms, documented in the Linux documentation, are also defined in the socket module.
Availability: Linux >= 2.6.30.
Added in version 3.3.
- socket.SIO_RCVALL¶
- socket.SIO_KEEPALIVE_VALS¶
- socket.SIO_LOOPBACK_FAST_PATH¶
- RCVALL_*
Constants for Windows’ WSAIoctl(). The constants are used as arguments to the
ioctl()
method of socket objects.Changed in version 3.6:
SIO_LOOPBACK_FAST_PATH
was added.
- TIPC_*
TIPC related constants, matching the ones exported by the C socket API. See the TIPC documentation for more information.
- socket.AF_ALG¶
- socket.SOL_ALG¶
- ALG_*
Constants for Linux Kernel cryptography.
Availability: Linux >= 2.6.38.
Added in version 3.6.
- socket.AF_VSOCK¶
- socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID¶
- VMADDR*
- SO_VM*
Constants for Linux host/guest communication.
Availability: Linux >= 4.8.
Added in version 3.7.
- socket.AF_LINK¶
Availability: BSD, macOS.
Added in version 3.4.
- socket.has_ipv6¶
This constant contains a boolean value which indicates if IPv6 is supported on this platform.
- socket.BDADDR_ANY¶
- socket.BDADDR_LOCAL¶
These are string constants containing Bluetooth addresses with special meanings. For example,
BDADDR_ANY
can be used to indicate any address when specifying the binding socket withBTPROTO_RFCOMM
.
- socket.HCI_FILTER¶
- socket.HCI_TIME_STAMP¶
- socket.HCI_DATA_DIR¶
For use with
BTPROTO_HCI
.HCI_FILTER
is only available on Linux and FreeBSD.HCI_TIME_STAMP
andHCI_DATA_DIR
are only available on Linux.
- socket.AF_QIPCRTR¶
Constant for Qualcomm’s IPC router protocol, used to communicate with service providing remote processors.
Availability: Linux >= 4.7.
- socket.SCM_CREDS2¶
- socket.LOCAL_CREDS¶
- socket.LOCAL_CREDS_PERSISTENT¶
LOCAL_CREDS and LOCAL_CREDS_PERSISTENT can be used with SOCK_DGRAM, SOCK_STREAM sockets, equivalent to Linux/DragonFlyBSD SO_PASSCRED, while LOCAL_CREDS sends the credentials at first read, LOCAL_CREDS_PERSISTENT sends for each read, SCM_CREDS2 must be then used for the latter for the message type.
Added in version 3.11.
Availability: FreeBSD.
- socket.SO_INCOMING_CPU¶
Constant to optimize CPU locality, to be used in conjunction with
SO_REUSEPORT
.Added in version 3.11.
Availability: Linux >= 3.9
- socket.AF_HYPERV¶
- socket.HV_PROTOCOL_RAW¶
- socket.HVSOCKET_CONNECT_TIMEOUT¶
- socket.HVSOCKET_CONNECT_TIMEOUT_MAX¶
- socket.HVSOCKET_CONNECTED_SUSPEND¶
- socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU¶
- socket.HV_GUID_ZERO¶
- socket.HV_GUID_WILDCARD¶
- socket.HV_GUID_BROADCAST¶
- socket.HV_GUID_CHILDREN¶
- socket.HV_GUID_LOOPBACK¶
- socket.HV_GUID_PARENT¶
Constants for Windows Hyper-V sockets for host/guest communications.
Availability: Windows.
Added in version 3.12.
- socket.ETHERTYPE_ARP¶
- socket.ETHERTYPE_IP¶
- socket.ETHERTYPE_IPV6¶
- socket.ETHERTYPE_VLAN¶
IEEE 802.3 protocol number. constants.
Availability: Linux, FreeBSD, macOS.
Added in version 3.12.
- socket.SHUT_RD¶
- socket.SHUT_WR¶
- socket.SHUT_RDWR¶
These constants are used by the
shutdown()
method of socket objects.Availability: not WASI.
Functions¶
Creating sockets¶
The following functions all create socket objects.
- class socket.socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)¶
Create a new socket using the given address family, socket type and protocol number. The address family should be
AF_INET
(the default),AF_INET6
,AF_UNIX
,AF_CAN
,AF_PACKET
, orAF_RDS
. The socket type should beSOCK_STREAM
(the default),SOCK_DGRAM
,SOCK_RAW
or perhaps one of the otherSOCK_
constants. The protocol number is usually zero and may be omitted or in the case where the address family isAF_CAN
the protocol should be one ofCAN_RAW
,CAN_BCM
,CAN_ISOTP
orCAN_J1939
.If fileno is specified, the values for family, type, and proto are auto-detected from the specified file descriptor. Auto-detection can be overruled by calling the function with explicit family, type, or proto arguments. This only affects how Python represents e.g. the return value of
socket.getpeername()
but not the actual OS resource. Unlikesocket.fromfd()
, fileno will return the same socket and not a duplicate. This may help close a detached socket usingsocket.close()
.The newly created socket is non-inheritable.
Raises an auditing event
socket.__new__
with argumentsself
,family
,type
,protocol
.Changed in version 3.3: The AF_CAN family was added. The AF_RDS family was added.
Changed in version 3.4: The CAN_BCM protocol was added.
Changed in version 3.4: The returned socket is now non-inheritable.
Changed in version 3.7: The CAN_ISOTP protocol was added.
Changed in version 3.7: When
SOCK_NONBLOCK
orSOCK_CLOEXEC
bit flags are applied to type they are cleared, andsocket.type
will not reflect them. They are still passed to the underlying systemsocket()
call. Therefore,sock = socket.socket( socket.AF_INET, socket.SOCK_STREAM | socket.SOCK_NONBLOCK)
will still create a non-blocking socket on OSes that support
SOCK_NONBLOCK
, butsock.type
will be set tosocket.SOCK_STREAM
.Changed in version 3.9: The CAN_J1939 protocol was added.
Changed in version 3.10: The IPPROTO_MPTCP protocol was added.
- socket.socketpair([family[, type[, proto]]])¶
Build a pair of connected socket objects using the given address family, socket type, and protocol number. Address family, socket type, and protocol number are as for the
socket()
function above. The default family isAF_UNIX
if defined on the platform; otherwise, the default isAF_INET
.The newly created sockets are non-inheritable.
Changed in version 3.2: The returned socket objects now support the whole socket API, rather than a subset.
Changed in version 3.4: The returned sockets are now non-inheritable.
Changed in version 3.5: Windows support added.
- socket.create_connection(address, timeout=GLOBAL_DEFAULT, source_address=None, *, all_errors=False)¶
Connect to a TCP service listening on the internet address (a 2-tuple
(host, port)
), and return the socket object. This is a higher-level function thansocket.connect()
: if host is a non-numeric hostname, it will try to resolve it for bothAF_INET
andAF_INET6
, and then try to connect to all possible addresses in turn until a connection succeeds. This makes it easy to write clients that are compatible to both IPv4 and IPv6.Passing the optional timeout parameter will set the timeout on the socket instance before attempting to connect. If no timeout is supplied, the global default timeout setting returned by
getdefaulttimeout()
is used.If supplied, source_address must be a 2-tuple
(host, port)
for the socket to bind to as its source address before connecting. If host or port are ‘’ or 0 respectively the OS default behavior will be used.When a connection cannot be created, an exception is raised. By default, it is the exception from the last address in the list. If all_errors is
True
, it is anExceptionGroup
containing the errors of all attempts.Changed in version 3.2: source_address was added.
Changed in version 3.11: all_errors was added.
- socket.create_server(address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False)¶
Convenience function which creates a TCP socket bound to address (a 2-tuple
(host, port)
) and returns the socket object.family should be either
AF_INET
orAF_INET6
. backlog is the queue size passed to