GitHub

Registry

API reference for Registry.

The adapters a server speaks, in the order given.

Attributes

AttributeTypeDescription
protocolstuple[AnyProtocolAdapter, ...]
versionstuple[str, ...]

Functions

__init__

__init__(protocols) -> None
ParameterTypeDescription
protocolstuple[AnyProtocolAdapter, ...]

select

select(offered) -> AnyProtocolAdapter

The adapter of the offered version, else the first one.

ParameterTypeDescription
offeredstr | None

Returns AnyProtocolAdapter

def select(self, offered: str | None) -> AnyProtocolAdapter:
    """The adapter of the ``offered`` version, else the first one."""
    for protocol in self.protocols:
        if protocol.protocol_version == offered:
            return protocol
    return self.protocols[0]

find

find(version) -> AnyProtocolAdapter | None

The adapter of version, if the server speaks it.

ParameterTypeDescription
versionstr

Returns AnyProtocolAdapter | None

def find(self, version: str) -> AnyProtocolAdapter | None:
    """The adapter of ``version``, if the server speaks it."""
    return next((p for p in self.protocols if p.protocol_version == version), None)

select_stateful

select_stateful(offered) -> AnyProtocolAdapter | None

The stateful adapter of offered, else the first stateful one.

ParameterTypeDescription
offeredstr | None

Returns AnyProtocolAdapter | None

def select_stateful(self, offered: str | None) -> AnyProtocolAdapter | None:
    """The stateful adapter of ``offered``, else the first stateful one."""
    stateful = [p for p in self.protocols if not p.is_stateless]
    found = next((p for p in stateful if p.protocol_version == offered), None)
    return found or (stateful[0] if stateful else None)