asgi-tools 0.11.0

Tools to make ASGI Applications

asgi-tools – Tools to make ASGI Applications

Features:

• Supports Asyncio and Trio libraries

• Request – Parse ASGI scope, get url, headers, cookies, read a request’s data/json/form-data

• Response – Send HTTP (text, html, json, stream, file, http errors) responses

• WebSocket – Work with websockets

• RequestMiddleware – Parse a scope and insert the parsed request into the scope

• ResponseMiddleware – Parse responses and convert them into ASGI messages

• WebSocketMiddleware – Process websockets

• RouterMiddleware – Route HTTP requests

• LifespanMiddleware – Process a lifespan cycle

• StaticFilesMiddleware – Serve static files from URL prefixes

• AppMiddleware – A combined (request, response, router, lifespan) middleware to quikly create ASGI apps

Contents

• Requirements

• Installation

• Usage

  • asgi_tools.Request, asgi_tools.Response

  • Response/Request Middlewares

  • Router Middleware

• Bug tracker

• Contributing

• License

Requirements

• python >= 3.7

Installation

asgi-tools should be installed using pip:

pip install asgi-tools

Usage

asgi_tools.Request, asgi_tools.Response

Parse HTTP Request data from a scope and return it as JSON response:

import json
from asgi_tools import Request, Response

async def app(scope, receive, send):
    if scope['type'] != 'http':
        return

    # Parse scope
    request = Request(scope, receive, send)
    request_data = {

        # Get full URL
        "url": str(request.url),

        "charset": request.charset,

        # Get headers
        "headers": {**request.headers},

        # Get query params
        "query": dict(request.query),

        # Get cookies
        "cookies": dict(request.cookies),

    }

    # Create a response (ResponseHTML, ResponseText, ResponseJSON, ResponseStream, ResponseFile, ResponseRedirect also available)
    response = Response(json.dumps(request_data), content_type="application/json")

    # Send ASGI messages
    return await response(scope, receive, send)

Response/Request Middlewares

Automatically convert a scope into a asgi_tools.Request

from asgi_tools import RequestMiddleware, ResponseHTML

async def app(request, receive, send):
    # We will get a parsed request here
    data = await request.json()
    response = ResponseHTML(data['name'])
    return await response(request, receive, send)

app = RequestMiddleware(app)

Automatically parse an result from asgi apps and convert it into a asgi_tools.Response

from asgi_tools import ResponseMiddleware

async def app(request, receive, send):
    return "Hello World!"

app = ResponseMiddleware(app)

Router Middleware

Route HTTP requests

from http_router import Router
from asgi_tools import RouterMiddleware, RequestMiddleware, ResponseMiddleware

router = Router()

@router.route('/page1')
async def page1(request, receive, send):
    return 'page1'

@router.route('/page2')
async def page2(request, receive, send):
    return 'page2'

# TODO

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/asgi-tools/issues

Contributing

Development of the project happens at: https://github.com/klen/asgi-tools

License

Licensed under a MIT license.