Skip to main content

Simple DNS resolver for asyncio

https://badge.fury.io/py/aiodns.png https://github.com/saghul/aiodns/workflows/CI/badge.svg

aiodns provides a simple way for doing asynchronous DNS resolutions using pycares.

Example

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)

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

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.

Note for Windows users

This library requires the use of an asyncio.SelectorEventLoop on Windows only when using a custom build of pycares that links against a system- provided c-ares library without thread-safety support. This is because non-thread-safe builds of c-ares are incompatible with the default ProactorEventLoop on Windows.

If you’re using the official prebuilt pycares wheels on PyPI (version 4.7.0 or later), which include a thread-safe version of c-ares, this limitation does not apply and can be safely ignored.

The default event loop can be changed as follows (do this very early in your application):

asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

This may have other implications for the rest of your codebase, so make sure to test thoroughly.

Running the test suite

To run the test suite: python tests.py

Author

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

License

aiodns uses the MIT license, check LICENSE file.

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 3.4.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 3.4.0
File Size Uploaded
aiodns-3.4.0.tar.gz 11.4 kB Details

Built distribution (wheel)

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

Total release size: 18.6 kB

Release files / aiodns-3.4.0.tar.gz

Download URL aiodns-3.4.0.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
24b0ae58410530367f21234d0c848e4de52c1f16fbddc111726a4ab536ec1b2f
BLAKE2b-256 checksum
How to use checksums
929be96226eed7568ddfd075b03695e3e1298d9de48724128a3a2957f5ee6ec8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 8, 2025.

Transparency log

Release files / aiodns-3.4.0-py3-none-any.whl

Download URL aiodns-3.4.0-py3-none-any.whl
Size 7.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4da2b25f7475343f3afbb363a2bfe46afa544f2b318acb9a945065e622f4ed24
BLAKE2b-256 checksum
How to use checksums
60d854c601c37e97b0b1f8ceb148b360fbb9dc6782ab8e25542c8db649192e6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 8, 2025.

Transparency log
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