Skip to main content

Toolkit for building ASGI applications and libraries

Project description

Asgikit - ASGI Toolkit

Asgikit is a toolkit for building asgi applications and frameworks.

It is intended to be a minimal library and provide the building blocks for other libraries.

The examples directory contain usage examples of several use cases

Features:

  • Request
    • Headers
    • Cookies
    • Body (bytes, str, json, form, stream)
    • Form
  • Response
    • Plain text
    • Json
    • Streaming
    • File
  • Websockets

Requests and Responses

Asgikit Request, like other libraries, have methods to read items from the incoming request. However, unlike other libraries, there is no response object. Instead, you use the methods in Request to respond to the request like respond_json and respond_stream. There is a response property in the Request object where you can set response attributes like status, headers and cookies.

The main methods to interact with the Request are the following:

class Request:
    # Read the request body as a byte stream
    async def read_stream(self) -> AsyncIterable[bytes]: ...
    # Read the request body as bytes
    async def read_bytes(self) -> bytes: ...
    # Read the request body as str
    async def read_text(self, encoding: str = None) -> str: ...
    # Read the request body and parse it as json
    async def read_json(self) -> Any: ...
    # Read the request body and parse it as form
    async def read_form(self) -> dict[str, str | list[str]]: ...

    # Respond with bytes
    async def respond_bytes(self, content: bytes): ...
    # Respond with str
    async def respond_text(self, content: str): ...
    # Respond with the given content encoded as json
    async def respond_json(self, content: Any): ...
    # Respond with empty response and given status
    async def respond_status(self, status: HTTPStatus): ...
    # Respond with redirect
    async def respond_redirect(self, location: str, permanent: bool = False): ...
    # Respond with a post/redirect/get
    # https://en.wikipedia.org/wiki/Post/Redirect/Get
    async def respond_redirect_post_get(self, location: str): ...
    # Context manager that provides a function to write to the response
    async def response_writer(self): ...
    # Respond with file
    async def respond_file(self, path: str | os.PathLike): ...

Example request and response

from asgikit.requests import Request


async def main(scope, receive, send):
    assert scope["type"] == "http"

    request = Request(scope, receive, send)

    # request method
    method = request.method

    # request path
    path = request.path

    # request headers
    headers = request.headers

    # read body as json
    body = await request.read_json()

    data = {
        "lang": "Python",
        "async": True,
        "platform": "asgi",
        "method": method,
        "path": path,
        "headers": dict(headers.items()),
        "body": body,
    }

    # send json response
    await request.respond_json(data)

Example websocket

from asgikit.requests import Request
from asgikit.websockets import WebSocketDisconnect


async def app(scope, receive, send):
    assert scope["type"] == "websocket"

    request = Request(scope, receive, send)
    ws = await request.websocket_accept()

    while True:
        try:
            message = await ws.read()
            await ws.write(message)
        except WebSocketDisconnect:
            print("Client disconnect")
            break

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

asgikit-0.13.1.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

asgikit-0.13.1-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file asgikit-0.13.1.tar.gz.

File metadata

  • Download URL: asgikit-0.13.1.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.4 CPython/3.13.5 Linux/6.14.0-23-generic

File hashes

Hashes for asgikit-0.13.1.tar.gz
Algorithm Hash digest
SHA256 e75a67d2600ed1f3c5f3909dd17729e7f84e12b0bfab4f721868076d9ee225db
MD5 3e251de518ee9842060bd28090712b99
BLAKE2b-256 4f8295388556fd2f3d024654149e8db548699cace6e90e9535bb0f80919c76ec

See more details on using hashes here.

File details

Details for the file asgikit-0.13.1-py3-none-any.whl.

File metadata

  • Download URL: asgikit-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.4 CPython/3.13.5 Linux/6.14.0-23-generic

File hashes

Hashes for asgikit-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3263bb2382583be55be6cb903800c691b479fb33c71d2c39c08681f2adfab9a8
MD5 1aeb5ee64ae51b854625b7f9d228122d
BLAKE2b-256 bfbca239dbaf82234309a1281af7f75cc1ca840426c9d978ec372564f41f4986

See more details on using hashes here.

Supported by

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