Skip to main content
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 asyncio loop to be a SelectorEventLoop, which is not the default on Windows since Python 3.8.

The default 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.

Python versions

Python >= 3.6 are supported.

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.1.1

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.1.1
File Size Uploaded
aiodns-3.1.1.tar.gz 7.4 kB Details

Built distribution (wheel)

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

Total release size: 12.8 kB

Release files / aiodns-3.1.1.tar.gz

Download URL aiodns-3.1.1.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1073eac48185f7a4150cad7f96a5192d6911f12b4fb894de80a088508c9b3a99
BLAKE2b-256 checksum
How to use checksums
fa104de99e6e67703d8f6b10ea92a4d2a6c5b96a9c0708b75389a00203387925
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

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

Download URL aiodns-3.1.1-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a387b63da4ced6aad35b1dda2d09620ad608a1c7c0fb71efa07ebb4cd511928d
BLAKE2b-256 checksum
How to use checksums
1a74976abff30200cb0cab0bd076db074b8cdda9236ba885ebe3f4d91c7e074b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18
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