connection module

Sputnik Connection Implementation

This module provides the Sputnik Connection implementation. This is a base class that defines several helper functions for common tasks related to transport-level interactions, such as message encoding and message passing.

class connection.Connection

Bases: asyncio.protocols.Protocol

A generic instance of a network connection.

A Connection is a base class that represents an instance of a network connection. The Connection implements commonly used actions that may be performed on messages.

decode(line)

Attempts to decode a line as UTF-8, with fallback to Latin-1.

We try to maintain a full-Unicode presence where possible. However, not all IRC servers are encoding using UTF-8, so we shadow str.decode() and provide a fallback to Latin-1 when needed.

Parameters:line (str) – A byte-string message to decode. Returns:A decoded message. Return type:str

normalize(line, ending='\r\n')

Ensures that a line is terminated with the correct line endings.

The IRC protocol specifies that line endings should use CRLF line endings. This ensures that lines conform to this standard. In the event of a server that does not conform to the specification, we preserve the ability to provide an alternative line ending character sequence.

Args:

line (str): A message to be sent to the IRC network. ending (str, optional): The line ending. Defaults to ``“

“``.

send(*args)

Writes a message to the connected interface.

Messages are typically of the form <command> <message>. This encapsulates the IRC messaging protocol by concatenating messages and checking their line endings before encoding the message into raw bytes, as part of the asyncio transport mechanism.

Parameters:args (list of str) – A list of strings to concatenate.