""" Socket module. MicroPython module: https://docs.micropython.org/en/v1.21.0/library/socket.html CPython module: :mod:`python:socket` https://docs.python.org/3/library/socket.html . This module provides access to the BSD socket interface. Difference to CPython For efficiency and consistency, socket objects in MicroPython implement a `stream` (file-like) interface directly. In CPython, you need to convert a socket to a file-like object using `makefile()` method. This method is still supported by MicroPython (but is a no-op), so where compatibility with CPython matters, be sure to use it. """ from _typeshed import Incomplete, Incomplete as Incomplete from stdlib.socket import * from typing import Any, IO, Optional, Tuple SOCK_STREAM: int SOCK_RAW: int SOCK_DGRAM: int SOL_SOCKET: int SO_BROADCAST: int SO_REUSEADDR: int AF_INET6: int AF_INET: int IP_DROP_MEMBERSHIP: int IPPROTO_IP: int IP_ADD_MEMBERSHIP: int def reset(*args, **kwargs) -> Incomplete: ... def print_pcbs(*args, **kwargs) -> Incomplete: ... def getaddrinfo(host, port, af=0, type=0, proto=0, flags=0, /) -> Incomplete: """ 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. Arguments *af*, *type*, and *proto* (which have the same meaning as for the `socket()` function) can be used to filter which kind of addresses are returned. If a parameter is not specified or zero, all combinations of addresses can be returned (requiring filtering on the user side). The resulting list of 5-tuples has the following structure:: (family, type, proto, canonname, sockaddr) The following example shows how to connect to a given url:: s = socket.socket() # This assumes that if "type" is not specified, an address for # SOCK_STREAM will be returned, which may be not true s.connect(socket.getaddrinfo('www.micropython.org', 80)[0][-1]) Recommended use of filtering params:: s = socket.socket() # Guaranteed to return an address which can be connect'ed to for # stream operation. s.connect(socket.getaddrinfo('www.micropython.org', 80, 0, SOCK_STREAM)[0][-1]) Difference to CPython CPython raises a ``socket.gaierror`` exception (`OSError` subclass) in case of error in this function. MicroPython doesn't have ``socket.gaierror`` and raises OSError directly. Note that error numbers of `getaddrinfo()` form a separate namespace and may not match error numbers from the :mod:`errno` module. To distinguish `getaddrinfo()` errors, they are represented by negative numbers, whereas standard system errors are positive numbers (error numbers are accessible using ``e.args[0]`` property from an exception object). The use of negative values is a provisional detail which may change in the future. """ ... def callback(*args, **kwargs) -> Incomplete: ... class socket: """ Create a new socket using the given address family, socket type and protocol number. Note that specifying *proto* in most cases is not required (and not recommended, as some MicroPython ports may omit ``IPPROTO_*`` constants). Instead, *type* argument will select needed protocol automatically:: # Create STREAM TCP socket socket(AF_INET, SOCK_STREAM) # Create DGRAM UDP socket socket(AF_INET, SOCK_DGRAM) """ def recvfrom(self, bufsize) -> Tuple: """ 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. """ ... def recv(self, bufsize) -> bytes: """ Receive data from the socket. The return value is a bytes object representing the data received. The maximum amount of data to be received at once is specified by bufsize. """ ... def makefile(self, mode="rb", buffering=0, /) -> IO: """ Return a file object associated with the socket. The exact returned type depends on the arguments given to makefile(). The support is limited to binary modes only ('rb', 'wb', and 'rwb'). CPython's arguments: *encoding*, *errors* and *newline* are not supported. Difference to CPython As MicroPython doesn't support buffered streams, values of *buffering* parameter is ignored and treated as if it was 0 (unbuffered). Difference to CPython Closing the file object returned by makefile() WILL close the original socket as well. """ ... def listen(self, backlog: Optional[Any] = None) -> None: """ Enable a server to accept connections. If *backlog* is specified, it must be at least 0 (if it's lower, it will be set to 0); and specifies the number of unaccepted connections that the system will allow before refusing new connections. If not specified, a default reasonable value is chosen. """ ... def settimeout(self, value) -> Incomplete: """ **Note**: Not every port supports this method, see below. Set a timeout on blocking socket operations. The value argument can be a nonnegative floating point number expressing seconds, or None. If a non-zero value is given, subsequent socket operations will raise an `OSError` exception if the timeout period value has elapsed before the operation has completed. If zero is given, the socket is put in non-blocking mode. If None is given, the socket is put in blocking mode. Not every :term:`MicroPython port` supports this method. A more portable and generic solution is to use `select.poll` object. This allows to wait on multiple objects at the same time (and not just on sockets, but on generic `stream` objects which support polling). Example:: # Instead of: s.settimeout(1.0) # time in seconds s.read(10) # may timeout # Use: poller = select.poll() poller.register(s, select.POLLIN) res = poller.poll(1000) # time in milliseconds if not res: # s is still not ready for input, i.e. operation timed out Difference to CPython CPython raises a ``socket.timeout`` exception in case of timeout, which is an `OSError` subclass. MicroPython raises an OSError directly instead. If you use ``except OSError:`` to catch the exception, your code will work both in MicroPython and CPython. """ ... def sendall(self, bytes) -> int: """ Send all data to the socket. The socket must be connected to a remote socket. Unlike `send()`, this method will try to send all of data, by sending data chunk by chunk consecutively. The behaviour of this method on non-blocking sockets is undefined. Due to this, on MicroPython, it's recommended to use `write()` method instead, which has the same "no short writes" policy for blocking sockets, and will return number of bytes sent on non-blocking sockets. """ ... def setsockopt(self, level, optname, value) -> None: """ Set the value of the given socket option. The needed symbolic constants are defined in the socket module (SO_* etc.). The *value* can be an integer or a bytes-like object representing a buffer. """ ... def setblocking(self, flag) -> Incomplete: """ Set blocking or non-blocking mode of the socket: if flag is false, the socket is set to non-blocking, else to blocking mode. This method is a shorthand for certain `settimeout()` calls: * ``sock.setblocking(True)`` is equivalent to ``sock.settimeout(None)`` * ``sock.setblocking(False)`` is equivalent to ``sock.settimeout(0)`` """ ... def sendto(self, bytes, address) -> None: """ Send data to the socket. The socket should not be connected to a remote socket, since the destination socket is specified by *address*. """ ... def readline(self) -> Incomplete: """ Read a line, ending in a newline character. Return value: the line read. """ ... def readinto(self, buf, nbytes: Optional[Any] = None) -> int: """ Read bytes into the *buf*. If *nbytes* is specified then read at most that many bytes. Otherwise, read at most *len(buf)* bytes. Just as `read()`, this method follows "no short reads" policy. Return value: number of bytes read and stored into *buf*. """ ... def read(self, size: Optional[Any] = None) -> bytes: """ Read up to size bytes from the socket. Return a bytes object. If *size* is not given, it reads all data available from the socket until EOF; as such the method will not return until the socket is closed. This function tries to read as much data as requested (no "short reads"). This may be not possible with non-blocking socket though, and then less data will be returned. """ ... def close(self) -> Incomplete: """ Mark the socket closed and release all resources. Once that happens, all future operations on the socket object will fail. The remote end will receive EOF indication if supported by protocol. Sockets are automatically closed when they are garbage-collected, but it is recommended to `close()` them explicitly as soon you finished working with them. """ ... def connect(self, address) -> None: """ Connect to a remote socket at *address*. """ ... def send(self, bytes) -> int: """ Send data to the socket. The socket must be connected to a remote socket. Returns number of bytes sent, which may be smaller than the length of data ("short write"). """ ... def bind(self, address) -> Incomplete: """ Bind the socket to *address*. The socket must not already be bound. """ ... def accept(self) -> Tuple: """ Accept a connection. The socket must be bound to an address and listening for connections. The return value is a pair (conn, address) where conn is a new socket object usable to send and receive data on the connection, and address is the address bound to the socket on the other end of the connection. """ ... def write(self, buf) -> int: """ Write the buffer of bytes to the socket. This function will try to write all data to a socket (no "short writes"). This may be not possible with a non-blocking socket though, and returned value will be less than the length of *buf*. Return value: number of bytes written. """ ... def __init__(self, af=AF_INET, type=SOCK_STREAM, proto=IPPROTO_TCP, /) -> None: ...