Skip to main content

Higher level Datagram support for Asyncio

Project description

Build Status

Higher level Datagram support for Asyncio

Simple wrappers that allow you to await read() from datagrams as suggested by Guido van Rossum here. I frequently found myself having to inherit from asyncio.DatagramProtocol and implement this over and over.

Design

The goal of this package is to make implementing common patterns that use datagrams simple and straight-forward while still supporting more esoteric options. This is done by taking an opinionated stance on the API that differs from parts of asyncio. For instance, rather than exposing a function like create_datagram_endpoint which supports many use-cases and has conflicting parameters, asyncio_dgram only provides three functions for creating a stream:

  • connect((host, port)): Creates a datagram endpoint which can only communicate with the endpoint it connected to.
  • bind((host, port)): Creates a datagram endpoint that can communicate with anyone, but must specified the destination address every time it sends.
  • from_socket(sock): If the above two functions are not sufficient, then asyncio_dgram simply lets the caller setup the socket as they see fit.

Example UDP echo client and server

Following the example of asyncio documentation, here's what a UDP echo client and server would look like.

import asyncio

import asyncio_dgram


async def udp_echo_client():
    stream = await asyncio_dgram.connect(("127.0.0.1", 8888))

    await stream.send(b"Hello World!")
    data, remote_addr = await stream.recv()
    print(f"Client received: {data.decode()!r}")

    stream.close()


async def udp_echo_server():
    stream = await asyncio_dgram.bind(("127.0.0.1", 8888))

    print(f"Serving on {stream.sockname}")

    data, remote_addr = await stream.recv()
    print(f"Echoing {data.decode()!r}")
    await stream.send(data, remote_addr)

    await asyncio.sleep(0.5)
    print(f"Shutting down server")


def main():
    loop = asyncio.get_event_loop()
    loop.run_until_complete(asyncio.gather(udp_echo_server(), udp_echo_client()))


if __name__ == "__main__":
    main()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asyncio-dgram-1.0.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

asyncio_dgram-1.0.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file asyncio-dgram-1.0.0.tar.gz.

File metadata

  • Download URL: asyncio-dgram-1.0.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.0 CPython/3.7.2

File hashes

Hashes for asyncio-dgram-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a4dd555998170316093a72aaef9cf352d87a3ab7778712fdcc630f40d88f626d
MD5 dc50e8dbd2c722b8da1f358a6a4c616c
BLAKE2b-256 5a8a18caadf1da4314ce5542d0d289d07aa9bff290723ed842f780f03c614365

See more details on using hashes here.

File details

Details for the file asyncio_dgram-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: asyncio_dgram-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.0 CPython/3.7.2

File hashes

Hashes for asyncio_dgram-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1eed63f2a0895a6a1ab996007e023dd66933144fb47419784431f80ba0e41861
MD5 628833e60220c0a5efe025f3af9cae93
BLAKE2b-256 8908ca1d27cbae7fbc43f94a30fd8c1d0f4813a05ee753b9a2d6e66c6a44dced

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page