Data Transport Adapters

Low-level transports module.

Abstract Base Classes 

Low-level transports interfaces module.

class easynetwork.lowlevel.api_sync.transports.abc.BaseTransport

Bases: TypedAttributeProvider

Base class for a data transport.

__exit__(exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None) → None

Calls close().

abstract close() → None

Closes the transport.

abstract is_closed() → bool

Checks if close() has been called.

Returns:: True if the transport is closed.
Return type:: bool

class easynetwork.lowlevel.api_sync.transports.abc.DatagramReadTransport

Bases: BaseTransport

A reader transport of unreliable packets of data.

abstract recv(timeout: float) → bytes

Read and return the next available packet.

Parameters:

timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

Returns:

some bytes.

Return type:

bytes

class easynetwork.lowlevel.api_sync.transports.abc.DatagramTransport

Bases: DatagramWriteTransport, DatagramReadTransport

A transport of unreliable packets of data.

class easynetwork.lowlevel.api_sync.transports.abc.DatagramWriteTransport

Bases: BaseTransport

A writer transport of unreliable packets of data.

abstract send(data: bytes | bytearray | memoryview, timeout: float) → None

Send the data bytes to the remote peer.

Parameters:

data (bytes | bytearray | memoryview) – the bytes to send.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

class easynetwork.lowlevel.api_sync.transports.abc.StreamReadTransport

Bases: BaseTransport

A continuous stream data reader transport.

recv(bufsize: int, timeout: float) → bytes

Read and return up to bufsize bytes.

Parameters:

bufsize (int) – the maximum buffer size.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative bufsize.
ValueError – Negative timeout.
TimeoutError – Operation timed out.

Returns:

some bytes.

If bufsize is greater than zero and an empty byte buffer is returned, this indicates an EOF.

Return type:

bytes

abstract recv_into(buffer: bytearray | memoryview | collections.abc.Buffer, timeout: float) → int

Read into the given buffer.

Parameters:

buffer (bytearray | memoryview | collections.abc.Buffer) – where to write the received bytes.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

Returns:

the number of bytes written.

Returning 0 for a non-zero buffer indicates an EOF.

Return type:

int

class easynetwork.lowlevel.api_sync.transports.abc.StreamTransport

Bases: StreamWriteTransport, StreamReadTransport

A continuous stream data transport.

abstract send_eof() → None

Closes the write end of the stream after the buffered write data is flushed.

This method does nothing if the transport is closed.

class easynetwork.lowlevel.api_sync.transports.abc.StreamWriteTransport

Bases: BaseTransport

A continuous stream data writer transport.

abstract send(data: bytes | bytearray | memoryview, timeout: float) → int

Send the data bytes to the remote peer.

Parameters:

data (bytes | bytearray | memoryview) – the bytes to send.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

Returns:

the number of sent bytes.

Return type:

int

send_all(data: bytes | bytearray | memoryview, timeout: float) → None

Send the data bytes to the remote peer.

Unlike send(), this method continues to send data from bytes until either all data has been sent or an error occurs. None is returned on success. On error, an exception is raised, and there is no way to determine how much data, if any, was successfully sent.

Parameters:

data (bytes | bytearray | memoryview) – the bytes to send.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

send_all_from_iterable(iterable_of_data: Iterable[bytes | bytearray | memoryview], timeout: float) → None

An efficient way to send a bunch of data via the transport.

Like send_all(), this method continues to send data from bytes until either all data has been sent or an error occurs. None is returned on success. On error, an exception is raised, and there is no way to determine how much data, if any, was successfully sent.

Parameters:

iterable_of_data (Iterable[bytes | bytearray | memoryview]) – An iterable yielding the bytes to send.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

`selectors`-based transports 

Socket Transport Implementations 

Transport implementations module wrapping sockets.

class easynetwork.lowlevel.api_sync.transports.socket.SSLStreamTransport

Bases: SelectorStreamTransport

A stream data transport implementation which wraps a stream socket.

__init__(sock: socket.socket, ssl_context: SSLContext, retry_interval: float, *, handshake_timeout: float | None = None, shutdown_timeout: float | None = None, server_side: bool | None = None, server_hostname: str | None = None, standard_compatible: bool = True, session: SSLSession | None = None, selector_factory: Callable[[], selectors.BaseSelector] | None = None) → None

Parameters:

sock (socket.socket) – The SOCK_STREAM socket to wrap.
ssl_context (SSLContext) – a ssl.SSLContext object to use to create the transport.
retry_interval (float) – The maximum wait time to wait for a blocking operation before retrying. Set it to math.inf to disable this feature.
handshake_timeout (float | None) – The time in seconds to wait for the TLS handshake to complete before aborting the connection. 60.0 seconds if None (default).
shutdown_timeout (float | None) – The time in seconds to wait for the SSL shutdown to complete before aborting the connection. 30.0 seconds if None (default).
server_side (bool | None) – Indicates whether we are a client or a server for the handshake part. If it is set to None, it is deduced according to server_hostname.
server_hostname (str | None) – sets or overrides the hostname that the target server’s certificate will be matched against. If server_side is True, you must pass a value for server_hostname.
standard_compatible (bool) – If False, skip the closing handshake when closing the connection, and don’t raise an exception if the peer does the same.
session (SSLSession | None) – If an SSL session already exits, use it insead.
selector_factory (Callable[[], selectors.BaseSelector] | None) – If given, the callable object to use to create a new selectors.BaseSelector instance.

is_closed() → bool

Checks if close() has been called.

Returns:: True if the transport is closed.
Return type:: bool

close() → None

Closes the transport.

recv_noblock(bufsize: int) → bytes

Read and return up to bufsize bytes.

Parameters:

bufsize (int) – the maximum buffer size.

Raises:

ValueError – Negative bufsize.
WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Returns:

some bytes.

If bufsize is greater than zero and an empty byte buffer is returned, this indicates an EOF.

Return type:

bytes

recv_noblock_into(buffer: bytearray | memoryview | collections.abc.Buffer) → int

Read into the given buffer.

Parameters:

buffer (bytearray | memoryview | collections.abc.Buffer) – where to write the received bytes.

Raises:

WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Returns:

the number of bytes written.

Returning 0 for a non-zero buffer indicates an EOF.

Return type:

int

send_noblock(data: bytes | bytearray | memoryview) → int

Send the data bytes to the remote peer.

Parameters:

data (bytes | bytearray | memoryview) – the bytes to send.

Raises:

WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Return type:

int

send_all_from_iterable(iterable_of_data: Iterable[bytes | bytearray | memoryview], timeout: float) → None

An efficient way to send a bunch of data via the transport.

Like send_all(), this method continues to send data from bytes until either all data has been sent or an error occurs. None is returned on success. On error, an exception is raised, and there is no way to determine how much data, if any, was successfully sent.

Parameters:

iterable_of_data (Iterable[bytes | bytearray | memoryview]) – An iterable yielding the bytes to send.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

send_eof() → None

Closes the write end of the stream after the buffered write data is flushed.

This method does nothing if the transport is closed.

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

class easynetwork.lowlevel.api_sync.transports.socket.SocketDatagramTransport

Bases: SelectorDatagramTransport

A datagram transport implementation which wraps a datagram socket.

__init__(sock: socket, retry_interval: float, *, max_datagram_size: int = constants.MAX_DATAGRAM_BUFSIZE, selector_factory: Callable[[], BaseSelector] | None = None) → None

Parameters:

sock (socket) – The SOCK_DGRAM socket to wrap.
retry_interval (float) – The maximum wait time to wait for a blocking operation before retrying. Set it to math.inf to disable this feature.
max_datagram_size (int) – The maximum packet size supported by recvfrom(2) for the current socket.
selector_factory (Callable[[], BaseSelector] | None) – If given, the callable object to use to create a new selectors.BaseSelector instance.

is_closed() → bool

Checks if close() has been called.

Returns:: True if the transport is closed.
Return type:: bool

close() → None

Closes the transport.

recv_noblock() → bytes

Read and return the next available packet.

Raises:

WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Returns:

some bytes.

Return type:

bytes

send_noblock(data: bytes | bytearray | memoryview) → None

Send the data bytes to the remote peer.

Parameters:

data (bytes | bytearray | memoryview) – the bytes to send.

Raises:

WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

class easynetwork.lowlevel.api_sync.transports.socket.SocketStreamTransport

Bases: SelectorStreamTransport

A stream data transport implementation which wraps a stream socket.

__init__(sock: socket, retry_interval: float, *, selector_factory: Callable[[], BaseSelector] | None = None) → None

Parameters:

sock (socket) – The SOCK_STREAM socket to wrap.
retry_interval (float) – The maximum wait time to wait for a blocking operation before retrying. Set it to math.inf to disable this feature.
selector_factory (Callable[[], BaseSelector] | None) – If given, the callable object to use to create a new selectors.BaseSelector instance.

is_closed() → bool

Checks if close() has been called.

Returns:: True if the transport is closed.
Return type:: bool

close() → None

Closes the transport.

recv_noblock(bufsize: int) → bytes

Read and return up to bufsize bytes.

Parameters:

bufsize (int) – the maximum buffer size.

Raises:

ValueError – Negative bufsize.
WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Returns:

some bytes.

If bufsize is greater than zero and an empty byte buffer is returned, this indicates an EOF.

Return type:

bytes

recv_noblock_into(buffer: bytearray | memoryview | collections.abc.Buffer) → int

Read into the given buffer.

Parameters:

buffer (bytearray | memoryview | collections.abc.Buffer) – where to write the received bytes.

Raises:

WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Returns:

the number of bytes written.

Returning 0 for a non-zero buffer indicates an EOF.

Return type:

int

send_noblock(data: bytes | bytearray | memoryview) → int

Send the data bytes to the remote peer.

Parameters:

data (bytes | bytearray | memoryview) – the bytes to send.

Raises:

WouldBlockOnRead – the operation would block when reading the pipe.
WouldBlockOnWrite – the operation would block when writing on the pipe.

Return type:

int

send_all_from_iterable(iterable_of_data: Iterable[bytes | bytearray | memoryview], timeout: float) → None

An efficient way to send a bunch of data via the transport.

Like send_all(), this method continues to send data from bytes until either all data has been sent or an error occurs. None is returned on success. On error, an exception is raised, and there is no way to determine how much data, if any, was successfully sent.

Parameters:

iterable_of_data (Iterable[bytes | bytearray | memoryview]) – An iterable yielding the bytes to send.
timeout (float) – the allowed time (in seconds) for blocking operations. Can be set to math.inf.

Raises:

ValueError – Negative timeout.
TimeoutError – Operation timed out.

send_eof() → None

Closes the write end of the stream after the buffered write data is flushed.

This method does nothing if the transport is closed.

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

Data Transport Adapters

Abstract Base Classes

selectors-based transports

Socket Transport Implementations

Abstract Base Classes 

`selectors`-based transports 

Socket Transport Implementations 