GitHub

address_resolver

API reference for address_resolver.

Socket addresses from endpoints (Effect's AddressResolver).

resolve turns a host:port (text, parts or HostPort) into the socket addresses to connect to: an IP literal directly, a scoped IPv6 literal with its zone looked up, a domain name through Dns. Socket addresses pass through, checked against family when given::

resolver = yield from AddressResolver()
addresses = yield from resolver.resolve("localhost:8080", family="IPv4")

Re-exports

Types

TypeDefinitionDescription
ScopeIdLookuptype ScopeIdLookup = Callable[[str], Effect[int | None, NetAddressError]]

The scope ID of the network interface named name, or None.

ResolveErrortype ResolveError = DnsError | NetAddressError

Classes

Functions

make

make(dns, *, scope_id=None) -> AddressResolverService

A resolver looking names up with dns; scope_id resolves named IPv6 zones (fe80::1%eth0), which fail without it.

ParameterTypeDescription
dnsDnsService
scope_idScopeIdLookup | None = None

Returns AddressResolverService

def make(dns: DnsService, *, scope_id: ScopeIdLookup | None = None) -> AddressResolverService:
    """A resolver looking names up with ``dns``; ``scope_id`` resolves named
    IPv6 zones (``fe80::1%eth0``), which fail without it."""
    return AddressResolverService(dns, scope_id)

layer

layer(*, scope_id=None) -> Layer[AddressResolver, Never, Dns]
ParameterTypeDescription
scope_idScopeIdLookup | None = None

Returns Layer[AddressResolver, Never, Dns]

def layer(*, scope_id: ScopeIdLookup | None = None) -> Layer[AddressResolver, Never, Dns]:
    return layer_effect(AddressResolver, Dns().map(lambda dns: make(dns, scope_id=scope_id)))

system_scope_id

system_scope_id(name) -> Effect[int | None, NetAddressError]

The scope ID of a network interface of this machine: its index.

ParameterTypeDescription
namestr

Returns Effect[int | None, NetAddressError]

def system_scope_id(name: str) -> Effect[int | None, NetAddressError]:
    """The scope ID of a network interface of this machine: its index."""

    def find() -> int | None:
        try:
            return socket.if_nametoindex(name)
        except OSError:
            return None

    return sync(find)

layer_system

layer_system() -> Layer[AddressResolver, Never, Dns]

A resolver over Dns resolving IPv6 zones by this machine's network interfaces.

Returns Layer[AddressResolver, Never, Dns]

def layer_system() -> Layer[AddressResolver, Never, Dns]:
    """A resolver over ``Dns`` resolving IPv6 zones by this machine's
    network interfaces."""
    return layer(scope_id=system_scope_id)