summaryrefslogtreecommitdiff
path: root/dns/asyncbackend.py
blob: 069eaf07e1f62876cb58cd96ffe335bcea7daf13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license


from dns._asyncbackend import Socket, DatagramSocket, \
    StreamSocket, Backend, low_level_address_tuple


_default_backend = None
_trio_backend = None
_curio_backend = None
_asyncio_backend = None


def get_backend(name):
    """Get the specified asychronous backend.

    *name*, a ``str``, the name of the backend.  Currently the "trio",
    "curio", and "asyncio" backends are available.

    Raises NotImplementError if an unknown backend name is specified.
    """
    if name == 'trio':
        global _trio_backend
        if _trio_backend:
            return _trio_backend
        import dns._trio_backend
        _trio_backend = dns._trio_backend.Backend()
        return _trio_backend
    elif name == 'curio':
        global _curio_backend
        if _curio_backend:
            return _curio_backend
        import dns._curio_backend
        _curio_backend = dns._curio_backend.Backend()
        return _curio_backend
    elif name == 'asyncio':
        global _asyncio_backend
        if _asyncio_backend:
            return _asyncio_backend
        import dns._asyncio_backend
        _asyncio_backend = dns._asyncio_backend.Backend()
        return _asyncio_backend
    else:
        raise NotImplementedError(f'unimplemented async backend {name}')


def sniff():
    """Attempt to determine the in-use asynchronous I/O library by using
    the ``sniffio`` module if it is available.

    Returns the name of the library, defaulting to "asyncio" if no other
    library appears to be in use.
    """
    name = 'asyncio'
    try:
        import sniffio
        name = sniffio.current_async_library()
    except Exception:
        pass
    return name


def get_default_backend():
    """Get the default backend, initializing it if necessary.
    """
    if _default_backend:
        return _default_backend

    return set_default_backend(sniff())


def set_default_backend(name):
    """Set the default backend.

    It's not normally necessary to call this method, as
    ``get_default_backend()`` will initialize the backend
    appropriately in many cases.  If ``sniffio`` is not installed, or
    in testing situations, this function allows the backend to be set
    explicitly.
    """
    global _default_backend
    _default_backend = get_backend(name)
    return _default_backend