o
0i @ sX d Z ddlZddlT ddlZddlZddlZddlZddlmZmZ zddl Z W n e
y3 dZ Y nw e e ddZ e e ddZ
e e d dZg d
Zeee ed ed d
ededd
ededd
ededd
dZdZdd Zej dr
i Zded< ded < d ed < d ed < d!ed"< d#ed$< d%ed&< d'ed(< d)ed*< d+ed,< d-ed.< d/ed0< d1ed2< d3ed4< d5ed6< d7ed8< d9ed:< d;ed<< d=ed>< d?ed@< dAedB< dCedD< dEedF< dGedH< dIedJ< dKedL< dMedN< dOedP< dQedR< dSedT< dUedV< dWedX< dYedZ< d[ed\< d]ed^< d_ed`< daedb< dcedd< deedf< dgedh< diedj< dkedl< dmedn< doedp< dqedr< dsedt< duedv< dwedx< dyedz< d{ed|< d}ed~< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< edա G ddׄ de Z G ddل dej Z dddۄZ e ej d܃r5ddl!Z!dddބZ"edޡ e ej d߃rJddl!Z!dddZ#ed e ej drZdd Z$ed e%e&dfddZ'e edrqde&dfddZ(ne'Z(ed de(_ e
ehZ)G dd dej*Z+dddZ,e- Z.e.dfddZ/dd Z0e%ddddddZ1dddZ2dS )a This module provides socket operations and some related functions.
On Unix, it supports IP (Internet Protocol) and Unix domain sockets.
On other systems, it only supports IP. Functions specific for a
socket are available as methods of the socket object.
Functions:
socket() -- create a new socket object
socketpair() -- create a pair of new socket objects [*]
fromfd() -- create a socket object from an open file descriptor [*]
send_fds() -- Send file descriptor to the socket.
recv_fds() -- Recieve file descriptors from the socket.
fromshare() -- create a socket object from data received from socket.share() [*]
gethostname() -- return the current hostname
gethostbyname() -- map a hostname to its IP number
gethostbyaddr() -- map an IP number or hostname to DNS info
getservbyname() -- map a service name and a protocol name to a port number
getprotobyname() -- map a protocol name (e.g. 'tcp') to a number
ntohs(), ntohl() -- convert 16, 32 bit int from network to host byte order
htons(), htonl() -- convert 16, 32 bit int from host to network byte order
inet_aton() -- convert IP addr string (123.45.67.89) to 32-bit packed format
inet_ntoa() -- convert 32-bit packed format IP to string (123.45.67.89)
socket.getdefaulttimeout() -- get the default timeout value
socket.setdefaulttimeout() -- set the default timeout value
create_connection() -- connects to an address, with an optional timeout and
optional source address.
[*] not available on all platforms!
Special objects:
SocketType -- type object for socket objects
error -- exception raised for I/O errors
has_ipv6 -- boolean value indicating if IPv6 is supported
IntEnum constants:
AF_INET, AF_UNIX -- socket domains (first argument to socket() call)
SOCK_STREAM, SOCK_DGRAM, SOCK_RAW -- socket types (second argument)
Integer constants:
Many other constants may be defined; these may be used in calls to
the setsockopt() and getsockopt() methods.
N)*)IntEnumIntFlagEBADF EAGAIN EWOULDBLOCK)fromfdgetfqdncreate_connection
create_serverhas_dualstack_ipv6
AddressFamily
SocketKindr c C | o| dS )NZAF_isupper
startswithC r -/opt/alt/python310/lib64/python3.10/socket.pyN r r c C r )NZSOCK_r r r r r r S r ZMsgFlagc C r )NZMSG_r r r r r r X r Z AddressInfoc C r )NZAI_r r r r r r ] r z 127.0.0.1z::1c C s" z|| W S t y | Y S w )z{Convert a numeric family value to an IntEnum member.
If it's not a known member, return the numeric value itself.
)
ValueError)valueZ
enum_klassr r r _intenum_converterc s
r winz)Specified event object handle is invalid. z Insufficient memory available. z#One or more parameters are invalid.W z Overlapped operation aborted.i z2Overlapped I/O event object not in signaled state.i z)Overlapped operation will complete later.i z The operation was interrupted.i' z A bad file handle was passed.i' zPermission denied.i ' z!A fault occurred on the network??i ' z#An invalid operation was attempted.i&' zToo many open files.i(' z The socket operation would blocki3' z,A blocking operation is already in progress.i4' z Operation already in progress.i5' z Socket operation on nonsocket.i6' z Destination address required.i7' zMessage too long.i8' z Protocol wrong type for socket.i9' zBad protocol option.i:' zProtocol not supported.i;' zSocket type not supported.i<' zOperation not supported.i=' z Protocol family not supported.i>' z0Address family not supported by protocol family.i?' z The network address is in use.i@' z Cannot assign requested address.iA' zNetwork is down.iB' zNetwork is unreachable.iC' z$Network dropped connection on reset.iD' z!Software caused connection abort.iE' z The connection has been reset.iF' zNo buffer space available.iG' z Socket is already connected.iH' zSocket is not connected.iI' z The network has been shut down.iJ' zToo many references.iK' zThe operation timed out.iL' zConnection refused.iM' zCannot translate name.iN' zThe name is too long.iO' zThe host is down.iP' zThe host is unreachable.iQ' zDirectory not empty.iR' zToo many processes.iS' zUser quota exceeded.iT' zDisk quota exceeded.iU' z Stale file handle reference.iV' zItem is remote.iW' z!Network subsystem is unavailable.ik' z!Winsock.dll version out of range.il' z(Successful WSAStartup not yet performed.im' z Graceful shutdown in progress.iu' z*No more results from WSALookupServiceNext.iv' zCall has been canceled.iw' z Procedure call table is invalid.ix' z Service provider is invalid.iy' z&Service provider failed to initialize.iz' zSystem call failure.i{' zService not found.i|' zClass type not found.i}' i~' zCall was canceled.i' zDatabase query was refused.i' zHost not found.i* z Nonauthoritative host not found.i* z This is a nonrecoverable error.i* z*Valid name, no data record requested type.i* zQoS receivers.i* z QoS senders.i* zNo QoS senders.i* zQoS no receivers.i + zQoS request confirmed.i+ zQoS admission error.i+ zQoS policy failure.i+ zQoS bad style.i+ zQoS bad object.i+ zQoS traffic control error.i+ zQoS generic error.i+ zQoS service type error.i+ zQoS flowspec error.i + z Invalid QoS provider buffer.i
+ zInvalid QoS filter style.i + i + zIncorrect QoS filter count.i
+ zInvalid QoS object length.i+ zIncorrect QoS flow count.i+ zUnrecognized QoS object.i+ zInvalid QoS policy object.i+ z Invalid QoS flow descriptor.i+ z'Invalid QoS provider-specific flowspec.i+ z)Invalid QoS provider-specific filterspec.i+ z&Invalid QoS shape discard mode object.i+ z Invalid QoS shaping rate object.i+ z!Reserved policy QoS element type.i+ errorTabc @ s e Zd ZdS )_GiveupOnSendfileN)__name__
__module__ __qualname__r r r r r# s r# c s( e Zd ZdZg dZd7ddZdd Zd d
Zd d Zd
d Z dd Z
dd Z d8ddddddZ e
edr) getattr __class__r% r& r4 r1 r2 r3 getsocknamestrerror getpeername)r0 closedsZladdrZraddrr r r __repr__ s<
zsocket.__repr__c C s t d| jjd)Nzcannot pickle z object) TypeErrorr> r$ r6 r r r __getstate__ zsocket.__getstate__c C s6 t | }| j| j| j| j|d}|| |S )zdup() -> socket object
Duplicate the socket. Return a new socket object connected to the same
system resource. The new socket is non-inheritable.
r4 )dupr4 r> r1 r2 r3
settimeout
gettimeout)r0 fdsockr r r rJ s z
socket.dupc C sF | \}}t| j| j| j|d}t du r | r |d ||fS )zaccept() -> (socket object, address info)
Wait for an incoming connection. Return a new socket
representing the connection, and the address of the client.
For IP sockets, the address info is a pair (hostaddr, port).
rI NT)Z_acceptr' r1 r2 r3 ZgetdefaulttimeoutrL setblocking)r0 rM addrrN r r r accept s
z
socket.acceptr)encodingerrorsnewlinec
C s t |h dkstd|f d|v }d|v p| }|s |s J d|v }d} |r,| d7 } |r2| d7 } t| | }
| jd7 _|du rDd }|d
k rKtj}|d
krW|sUtd |
S |rc|rct|
|
|} n|rlt|
|} n
|spJ t|
|} |rz| S t |}t
| |||} || _ | S ) zmakefile(...) -> an I/O stream connected to the socket
The arguments are as for io.open() after the filename, except the only
supported mode values are 'r' (default), 'w' and 'b'.
> bwrR z&invalid mode %r (only r, w, b allowed)rW rR rV r; Nr+ r z!unbuffered streams must be binary) setr SocketIOr) ioDEFAULT_BUFFER_SIZEBufferedRWPairBufferedReaderBufferedWriter
text_encoding
TextIOWrappermode)
r0 rb bufferingrS rT rU ZwritingZreadingZbinaryZrawmoderawbuffertextr r r makefile. sB
zsocket.makefilesendfiler c
C s | ||| | }z| }W n ttjfy$ } zt|d }~ww zt|j}W n t y= } zt|d }~ww |sBdS t
|pF|d}| } | dkrUt dt
tdr_t }
nt }
|
|tj d} |
j} tj}
ze | r~| | s~td|r|| }|dkrn sent
Send a file until EOF is reached by using high-performance
os.sendfile() and return the total number of bytes which
were sent.
*file* must be a regular file object opened in binary mode.
If os.sendfile() is not available (e.g. Windows) or file is
not a regular file socket.send() will be used instead.
*offset* tells from where to start reading the file.
If specified, *count* is the total number of bytes to transmit
as opposed to sending the file until EOF is reached.
File position is updated on return or also in case of error in
which case file.tell() can be used to figure out the number of
bytes which were sent.
The socket must be of SOCK_STREAM type.
Non-blocking sockets are not supported.
)r r# r r r r r rh s
zsocket.sendfilec C s. | j dkr | j d8 _ | jr| d S d S )Nr rX )r) r* r8 r6 r r r _decref_socketios s
zsocket._decref_socketiosc C s | | d S r5 )r8 )r0 Z_ssr r r _real_close s zsocket._real_closec C s d| _ | jdkr| d S d S )NTr )r* r) r r6 r r r r8 s
z socket.closec s d| _ t S )a detach() -> file descriptor
Close the socket object without closing the underlying file descriptor.
The object cannot be used after this call, but the file descriptor
can be reused for other purposes. The file descriptor is returned.
T)r* superdetachr6 r> r r r s
z
socket.detachc t t jtS )z@Read-only access to the address family for this socket.
)r r r1 r r6 r r r r1 z
socket.familyc r )z-Read-only access to the socket type.
)r r r2 r r6 r r r r2 r z socket.typentc C t | S r5 )ro Zget_handle_inheritabler4 r6 r r r get_inheritable zsocket.get_inheritablec C t | | d S r5 )ro Zset_handle_inheritabler4 r0 Z inheritabler r r set_inheritable rH zsocket.set_inheritablec C r r5 )ro r r4 r6 r r r r r c C r r5 )ro r r4 r r r r r rH z&Get the inheritable flag of the socketz&Set the inheritable flag of the socket)r+ r+ r+ N)rR Nr N) r$ r% r& __doc__ __slots__r/ r7 r: rE rG rJ rQ rg rt ro r r rl rh r r. r' r r8 r propertyr1 r2 namer r
__classcell__r r r r r' sD
+
A
$
r' c C s t | }t||||S )z fromfd(fd, family, type[, proto]) -> socket object
Create a socket object from a duplicate of the given file
descriptor. The remaining arguments are the same as for socket().
)rJ r' )rM r1 r2 r3 Znfdr r r r
s r
sendmsgc C s | |tjtjtd|fgS )z send_fds(sock, buffers, fds[, flags[, address]]) -> integer
Send the list of file descriptors fds over an AF_UNIX socket.
i)r r.
SOL_SOCKET
SCM_RIGHTSarray)rN Zbuffersfdsflagsaddressr r r send_fds' s
r recvmsgc C s t d}| |t||j \}}}}|D ]!\}} }
|tjkr8| tjkr8||
dt|
t|
|j q|t |||fS )z recv_fds(sock, bufsize, maxfds[, flags]) -> (data, list of file
descriptors, msg_flags, address)
Receive up to maxfds file descriptors returning the message
data and a list containing the descriptors.
r N)
r r r. ZCMSG_LENitemsizer r Z frombytesr list) rN bufsizeZmaxfdsr r msgZancdatarP Z
cmsg_levelZ cmsg_typeZ cmsg_datar r r recv_fds3 s
r Zsharec C s t ddd| S )z fromshare(info) -> socket object
Create a socket object from the bytes object returned by
socket.share(pid).
r )r' )infor r r fromshareG s r c
C sJ | t krt}n | tkrt}ntd|tkrtd|dkr"tdt| ||}zQ||df | | d d \}}t| ||}z'|
d z | ||f W n t t
fy^ Y nw |
d | \}} W n | W | n| w z| | ks| | krtdW ||fS | | ) Nz?Only AF_INET and AF_INET6 socket address families are supportedz)Only SOCK_STREAM socket type is supportedr z Only protocol zero is supported FTzUnexpected peer connection)r,
_LOCALHOSTAF_INET6
_LOCALHOST_V6r r- r' bindlistenr? rO connectrx InterruptedErrorrQ r8 rB ConnectionError)
r1 r2 r3 hostZlsockrP portZcsockZssock_r r r _fallback_socketpairS sN
r
socketpairc C sf | d u rzt } W n ty t} Y nw t| ||\}}t| ||| }t| ||| }||fS r5 )ZAF_UNIX NameErrorr, r. r r' r )r1 r2 r3 arV r r r r s a8 socketpair([family[, type[, proto]]]) -> (socket object, socket object)
Create a pair of socket objects from the sockets returned by the platform
socketpair() function.
The arguments are the same as for socket() except the default family is AF_UNIX
if defined on the platform; otherwise, the default is AF_INET.
c sp e Zd ZdZdd Zdd Zdd Zdd Zd
d Z fd d
Z dd Z
e dd Z e dd Z
dd Z ZS )rZ zRaw I/O implementation for stream sockets.
This class supports the makefile() method on sockets. It provides
the raw I/O interface on top of a socket object.
c C sZ |dvr
t d| tj| || _d|vr|d7 }|| _d|v | _d|v | _d| _d S )N)rR rW ZrwrbwbZrwbzinvalid mode: %rrV rR rW F) r r[ RawIOBaser/ _sock_mode_reading_writing_timeout_occurred)r0 rN rb r r r r/ s
zSocketIO.__init__c
C sv | | | jrtd z| j|W S ty" d| _ ty: } z
|jt v r5W Y d}~dS d}~ww )a3 Read up to len(b) bytes into the writable buffer *b* and return
the number of bytes read. If the socket is non-blocking and no bytes
are available, None is returned.
If *b* is non-empty, a 0 return value indicates that the connection
was shutdown at the other end.
z!cannot read from timed out objectTN)
_checkClosed_checkReadabler rr r Z recv_intor~ rA errno_blocking_errnosr0 rV er r r readinto s
zSocketIO.readintoc
C sR | | z| j|W S ty( } z
|jtv r#W Y d}~dS d}~ww )a Write the given bytes or bytearray object *b* to the socket
and return the number of bytes written. This can be less than
len(b) if not all data could be written. If the socket is
non-blocking and no bytes could be written None is returned.
N)r _checkWritabler r rA r r r r r r write s
zSocketIO.writec C | j rtd| jS )z2True if the SocketIO is open for reading.
I/O operation on closed socket.)rC r r r6 r r r readable zSocketIO.readablec C r )z2True if the SocketIO is open for writing.
r )rC r r r6 r r r writable r zSocketIO.writablec s | j rtdt S )z2True if the SocketIO is open for seeking.
r )rC r r seekabler6 r r r r s
zSocketIO.seekablec C s | | j S )z=Return the file descriptor of the underlying socket.
)r r r4 r6 r r r r4 s
zSocketIO.filenoc C s | j s| S dS )Nr+ )rC r4 r6 r r r r s z
SocketIO.namec C s | j S r5 )r r6 r r r rb s z
SocketIO.modec C s* | j rdS tj| | j d| _dS )zClose the SocketIO object. This doesn't close the underlying
socket, except if all references to it have disappeared.
N)rC r[ r r8 r r r6 r r r r8 s
zSocketIO.close)r$ r% r& r r/ r r r r r r4 r r rb r8 r r r r r rZ s
rZ r; c C sn | } | r
| dv r
t } z t| \}}}W n
ty Y | S w |d| |D ] } d| v r2 | S q)|} | S )az Get fully qualified domain name from name.
An empty argument is interpreted as meaning the local host.
First the hostname returned by gethostbyaddr() is checked, then
possibly existing aliases. In case no FQDN is available and `name`
was given, it is returned unchanged. If `name` was empty, '0.0.0.0' or '::',
hostname from gethostname() is returned.
)z0.0.0.0z::r .)stripZ gethostnameZ
gethostbyaddrrA insert)r ZhostnamealiasesZipaddrsr r r r s"
r c C s | \}}d}t ||dtD ]I}|\}}} }
} d} z"t||| } |tur(| | |r/| | | | d}| W S tyV }
z|
}| durL| W Y d}
~
q
d}
~
ww |duraz|d}w td)ac Connect to *address* and return the socket object.
Convenience function. Connect to *address* (a 2-tuple ``(host,
port)``) and return the socket object. 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 :func:`getdefaulttimeout`
is used. If *source_address* is set it must be a tuple of (host, port)
for the socket to bind as a source address before making the connection.
A host of '' or port 0 tells the OS to use the default.
Nr z!getaddrinfo returns an empty list) getaddrinfor- r' _GLOBAL_DEFAULT_TIMEOUTrK r r rA r8 )r r~ Zsource_addressr r r| resafsocktyper3 canonnamesarN r r r r r 4 s2
r c C sv t r ttdr ttdsdS z"ttt} | ttd W d W dS 1 s)w Y W dS t y: Y dS w )zReturn True if the platform supports creating a SOCK_STREAM socket
which can handle both AF_INET and AF_INET6 (IPv4 / IPv6) connections.
IPPROTO_IPV6 IPV6_V6ONLYFr NT)
has_ipv6rt r. r' r r-
setsockoptr r rA )rN r r r r a s ( r F)r1 backlog
reuse_portdualstack_ipv6c
C sT |r t tds td|r t std|tkr tdt|t}z|tjdvr?t tdr?z | t
t d W n t y> Y nw |rH| t
t
d tri|tkri|rX| ttd nt td rit td
ri| ttd z|| W n t y } zd |j| f }t |j|d d }~ww |d u r| |W S || |W S t y | w )
a Convenience function which creates a SOCK_STREAM type socket
bound to *address* (a 2-tuple (host, port)) and return the socket
object.
*family* should be either AF_INET or AF_INET6.
*backlog* is the queue size passed to socket.listen().
*reuse_port* dictates whether to use the SO_REUSEPORT socket option.
*dualstack_ipv6*: if true and the platform supports it, it will
create an AF_INET6 socket able to accept both IPv4 or IPv6
connections. When false it will explicitly disable this option on
platforms that enable it by default (e.g. Linux).
>>> with create_server(('', 8000)) as server:
... while True:
... conn, addr = server.accept()
... # handle new connection
SO_REUSEPORTz+SO_REUSEPORT not supported on this platformz-dualstack_ipv6 not supported on this platformz'dualstack_ipv6 requires AF_INET6 family)r cygwin SO_REUSEADDRrX r r r z+%s (while attempting to bind on address %r)N)rt r. r r r r' r- ro r r r r rA r r r r r strerrorr r r8 )r r1 r r r rN r| r r r r r
q sX
r
c C sP g }t | |||||D ]}|\}} }}
} |t|tt| t||
| f q |S )a Resolve host and port into list of address info entries.
Translate the host/port argument into a sequence of 5-tuples that contain
all the necessary arguments for creating a socket connected to that service.
host is a domain name, a string representation of an IPv4/v6 address or
None. port is a string service name such as 'http', a numeric port number or
None. By passing None as the value of host and port, you can pass NULL to
the underlying C API.
The family, type and proto arguments can be optionally specified in order to
narrow the list of addresses returned. Passing zero as a value for each of
these arguments selects the full range of results.
)r. r appendr r r ) r r r1 r2 r3 r Zaddrlistr r r r r r r r r s r )r r )r; )r r r r )3r r. ro sysr[ ru enumr r r ImportErrorr= r r r __all__extend_get_exports_list _convert_r$ r r r platformlowerr r" r Exceptionr# r' r
rt r r r r r, r- r r r r rZ r objectr r r r
r r r r r sT /
G
6
u
- E