NetworkAddress

class NetworkAddress(**properties: Any)

Superclasses: Object

Implemented Interfaces: SocketConnectable

GNetworkAddress provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families.

The enumeration results of resolved addresses may be cached as long as this object is kept alive which may have unexpected results if alive for too long.

See SocketConnectable for an example of using the connectable interface.

Constructors

class NetworkAddress

classmethod new(hostname: str, port: int) → NetworkAddress

Creates a new SocketConnectable for connecting to the given hostname and port.

Note that depending on the configuration of the machine, a hostname of localhost may refer to the IPv4 loopback address only, or to both IPv4 and IPv6; use new_loopback() to create a NetworkAddress that is guaranteed to resolve to both addresses.

Added in version 2.22.

Parameters:

• hostname – the hostname

• port – the port

classmethod new_loopback(port: int) → NetworkAddress

Creates a new SocketConnectable for connecting to the local host over a loopback connection to the given port. This is intended for use in connecting to local services which may be running on IPv4 or IPv6.

The connectable will return IPv4 and IPv6 loopback addresses, regardless of how the host resolves localhost. By contrast, new() will often only return an IPv4 address when resolving localhost, and an IPv6 address for localhost6.

get_hostname() will always return localhost for a NetworkAddress created with this constructor.

Added in version 2.44.

Parameters:

port – the port

Methods

class NetworkAddress

get_hostname() → str

Gets addr’s hostname. This might be either UTF-8 or ASCII-encoded, depending on what addr was created with.

Added in version 2.22.

get_port() → int

Gets addr’s port number

Added in version 2.22.

get_scheme() → str | None

Gets addr’s scheme

Added in version 2.26.

parse(host_and_port: str, default_port: int) → NetworkAddress

Creates a new SocketConnectable for connecting to the given hostname and port. May fail and return None in case parsing host_and_port fails.

host_and_port may be in any of a number of recognised formats; an IPv6 address, an IPv4 address, or a domain name (in which case a DNS lookup is performed). Quoting with [] is supported for all address types. A port override may be specified in the usual way with a colon.

If no port is specified in host_and_port then default_port will be used as the port number to connect to.

In general, host_and_port is expected to be provided by the user (allowing them to give the hostname, and a port override if necessary) and default_port is expected to be provided by the application.

(The port component of host_and_port can also be specified as a service name rather than as a numeric port, but this functionality is deprecated, because it depends on the contents of /etc/services, which is generally quite sparse on platforms other than Linux.)

Added in version 2.22.

Parameters:

• host_and_port – the hostname and optionally a port

• default_port – the default port if not in host_and_port

parse_uri(uri: str, default_port: int) → NetworkAddress

Creates a new SocketConnectable for connecting to the given uri. May fail and return None in case parsing uri fails.

Using this rather than new() or parse() allows SocketClient to determine when to use application-specific proxy protocols.

Added in version 2.26.

Parameters:

• uri – the hostname and optionally a port

• default_port – The default port if none is found in the URI

Properties

class NetworkAddress

props.hostname: str

Hostname to resolve.

Added in version 2.22.

props.port: int

Network port.

Added in version 2.22.

props.scheme: str

URI scheme.

Added in version 2.22.

Fields

class NetworkAddress

parent_instance

priv