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.2.0.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

asyncio_dgram-1.2.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asyncio-dgram-1.2.0.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.2

File hashes

Hashes for asyncio-dgram-1.2.0.tar.gz
Algorithm Hash digest
SHA256 c5464927f3ebc9a32aa6bbb3676fc1d645ae8bc9b4597feac8ab527b6fc33f38
MD5 69af84e5af394ebd5465c598b8bccba5
BLAKE2b-256 55abffac049638e7445f5c1b437be40311ed39360a4e992cfaa28d6bdcec2627

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asyncio_dgram-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.1

File hashes

Hashes for asyncio_dgram-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d969f2c033542dbddab2fd8c0add51b62c3e01b686a21f84b8d3011cdfd4ce89
MD5 e501581384e1721e628e538b50503b75
BLAKE2b-256 20d901b38e64c7d21dd459a91fd91933cc98610e4328ed97de03db336085a06e

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