Skip to main content

Simple DNS resolver for asyncio

https://secure.travis-ci.org/saghul/aiodns.png?branch=master

aiodns provides a simple way for doing asynchronous DNS resolutions with a synchronous looking interface by using pycares.

Example

import asyncio
import aiodns

loop = asyncio.get_event_loop()
resolver = aiodns.DNSResolver(loop=loop)
f = resolver.query('google.com','A')
result = loop.run_until_complete(f)
print(result)

The following query types are supported: A, AAAA, CNAME, MX, NAPTR, NS, PTR, SOA, SRV, TXT.

The library supports both asyncio and Trollius.

If you use use Python 3.5+, you can use the async and await statements:

import asyncio
import aiodns

loop = asyncio.get_event_loop()
resolver = aiodns.DNSResolver(loop=loop)

async def query(name, query_type):
    return await resolver.query(name, query_type)

coro = query('google.com', 'A')
result = loop.run_until_complete(coro)

If you use Python 3.3/3.4 you may use yield from statement:

@asyncio.coroutine
def func():
    result = yield from resolver.query('google.com','A')

For Trollius you should use another syntax like:

@trollius.coroutine
def func():
     result = yield trollius.From(resolver.query('google.com','A'))

API

The API is pretty simple, three functions are provided in the DNSResolver class:

  • query(host, type): Do a DNS resolution of the given type for the given hostname. It returns an instance of asyncio.Future. The actual result of the DNS query is taken directly from pycares. As of version 1.0.0 of aiodns (and pycares, for that matter) results are always namedtuple-like objects with different attributes. Please check the documentation for the result fields.

  • gethostbyname(host, socket_family): Do a DNS resolution for the given hostname and the desired type of address family (i.e. socket.AF_INET). While query() always performs a request to a DNS server, gethostbyname() first looks into /etc/hosts and thus can resolve local hostnames (such as localhost). Please check the documentation for the result fields. The actual result of the call is a asyncio.Future.

  • gethostbyaddr(name): Make a reverse lookup for an address.

  • cancel(): Cancel all pending DNS queries. All futures will get DNSError exception set, with ARES_ECANCELLED errno.

Running the test suite

To run the test suite: python test_aiodns.py

Author

Saúl Ibarra Corretgé <s@saghul.net>

License

aiodns uses the MIT license, check LICENSE file.

Python versions

Python >= 3.4 is natively supported. Python 3.3 supported using the asyncio package. Older Python versions(2.6 - 3.2) are supported using trollius.

Contributing

If you’d like to contribute, fork the project, make a patch and send a pull request. Have a look at the surrounding code and please, make yours look alike :-)

Metadata

Release files for aiodns 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiodns 1.2.0
File Size Uploaded
aiodns-1.2.0.tar.gz 6.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aiodns 1.2.0
File Interpreter ABI Platform
aiodns-1.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 11.7 kB

Release files / aiodns-1.2.0.tar.gz

Download URL aiodns-1.2.0.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d67e14b32176bcf3ff79b5d47c466011ce4adeadfa264f7949da1377332a0449
BLAKE2b-256 checksum
How to use checksums
7e1bf01e4d3502d1364e4df66e477c333bccac2361740e5688b9bc1826cc08bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

Release files / aiodns-1.2.0-py2.py3-none-any.whl

Download URL aiodns-1.2.0-py2.py3-none-any.whl
Size 5.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
970688599fcb7d65334ec490a94a51afd634ae2de8a2138d21e2ffbbddc12718
BLAKE2b-256 checksum
How to use checksums
c09d82d910965520ac17956a4b412e36298466de1b87a8fd0ab6dea601cdb8aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page