twisted.names.client : API documentation

Asynchronous client DNS

The functions exposed in this module can be used for asynchronous name resolution and dns queries.

If you need to create a resolver with specific requirements, such as needing to do queries against a particular host, the createResolver function will return an IResolver.

Future plans: Proper nameserver acquisition on Windows/MacOS, better caching, respect timeouts

Author Jp Calderone

Class	Resolver	No class docstring; 6/16 methods documented
Class	AXFRController	Undocumented
Class	ThreadedResolver	Undocumented
Class	DNSClientFactory	Undocumented
Function	createResolver	Create and return a Resolver.
Function	getResolver	Get a Resolver instance.
Function	getHostByName	Resolve a name to a valid ipv4 or ipv6 address.
Function	lookupAddress	Perform an A record lookup.
Function	lookupIPV6Address	Perform an AAAA record lookup.
Function	lookupAddress6	Perform an A6 record lookup.
Function	lookupMailExchange	Perform an MX record lookup.
Function	lookupNameservers	Perform an NS record lookup.
Function	lookupCanonicalName	Perform a CNAME record lookup.
Function	lookupMailBox	Perform an MB record lookup.
Function	lookupMailGroup	Perform an MG record lookup.
Function	lookupMailRename	Perform an MR record lookup.
Function	lookupPointer	Perform a PTR record lookup.
Function	lookupAuthority	Perform an SOA record lookup.
Function	lookupNull	Perform a NULL record lookup.
Function	lookupWellKnownServices	Perform a WKS record lookup.
Function	lookupService	Perform an SRV record lookup.
Function	lookupHostInfo	Perform a HINFO record lookup.
Function	lookupMailboxInfo	Perform an MINFO record lookup.
Function	lookupText	Perform a TXT record lookup.
Function	lookupResponsibility	Perform an RP record lookup.
Function	lookupAFSDatabase	Perform an AFSDB record lookup.
Function	lookupZone	Perform an AXFR record lookup.
Function	lookupAllRecords	ALL_RECORD lookup.

def createResolver(servers=None, resolvconf=None, hosts=None): (source)

Create and return a Resolver.

Parameters	servers	If not `None`, interpreted as a list of addresses of domain name servers to attempt to use. Addresses should be in dotted-quad form. (type: `list` of `(str, int)` or `None` )
	resolvconf	If not `None`, on posix systems will be interpreted as an alternate resolv.conf to use. Will do nothing on windows systems. If `None`, /etc/resolv.conf will be used. (type: `str` or `None` )
	hosts	If not `None`, an alternate hosts file to use. If `None` on posix systems, /etc/hosts will be used. On windows, C:\windows\hosts will be used. (type: `str` or `None` )
Returns	(type: `IResolver` )

def getResolver(): (source)

Get a Resolver instance.

Create twisted.names.client.theResolver if it is None, and then return that value.

Returns (type: IResolver )

def getHostByName(name, timeout=None, effort=10): (source)

Resolve a name to a valid ipv4 or ipv6 address.

Will errback with DNSQueryTimeoutError on a timeout, DomainError or AuthoritativeDomainError (or subclasses) on other errors.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
	effort	How many times CNAME and NS records to follow while resolving this name. (type: `int` )
Returns	(type: `Deferred` )

def lookupAddress(name, timeout=None): (source)

Perform an A record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupIPV6Address(name, timeout=None): (source)

Perform an AAAA record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupAddress6(name, timeout=None): (source)

Perform an A6 record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupMailExchange(name, timeout=None): (source)

Perform an MX record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupNameservers(name, timeout=None): (source)

Perform an NS record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupCanonicalName(name, timeout=None): (source)

Perform a CNAME record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupMailBox(name, timeout=None): (source)

Perform an MB record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupMailGroup(name, timeout=None): (source)

Perform an MG record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupMailRename(name, timeout=None): (source)

Perform an MR record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupPointer(name, timeout=None): (source)

Perform a PTR record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupAuthority(name, timeout=None): (source)

Perform an SOA record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupNull(name, timeout=None): (source)

Perform a NULL record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupWellKnownServices(name, timeout=None): (source)

Perform a WKS record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupService(name, timeout=None): (source)

Perform an SRV record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupHostInfo(name, timeout=None): (source)

Perform a HINFO record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupMailboxInfo(name, timeout=None): (source)

Perform an MINFO record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupText(name, timeout=None): (source)

Perform a TXT record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupResponsibility(name, timeout=None): (source)

Perform an RP record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupAFSDatabase(name, timeout=None): (source)

Perform an AFSDB record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

def lookupZone(name, timeout=None): (source)

Perform an AXFR record lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	When this timeout expires, the query is considered failed. (type: `int` )
Returns	(type: `Deferred` )

def lookupAllRecords(name, timeout=None): (source)

ALL_RECORD lookup.

Parameters	name	DNS name to resolve. (type: `str` )
	timeout	Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. (type: Sequence of `int` )
Returns	(type: `Deferred` )

t.n.client : module documentation