Skip to content

Component injection and caching, faster routing system and non-global middlewares. Give your Sanic application a Boom!

License

Notifications You must be signed in to change notification settings

vltr/sanic-boom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6836979 · Sep 30, 2019

History

34 Commits
Sep 13, 2018
Sep 30, 2019
Oct 18, 2018
Sep 30, 2019
Sep 30, 2019
Sep 30, 2019
Oct 19, 2018
Oct 10, 2018
Sep 13, 2018
Sep 13, 2018
Oct 17, 2018
Sep 13, 2018
Sep 13, 2018
Oct 23, 2018
Oct 17, 2018
Sep 13, 2018
Oct 18, 2018
Oct 17, 2018
Oct 17, 2018
Oct 17, 2018
Sep 13, 2018
Oct 17, 2018
Sep 30, 2019
Sep 30, 2019
Sep 30, 2019
Oct 17, 2018

Repository files navigation

sanic-boom

PyPI - Status PyPI Package latest release Supported versions Travis-CI Build Status Documentation Status Coverage Status Codacy Grade Packages status

Components injection, fast routing and non-global (layered) middlewares. Give your Sanic application a Boom!

In a nutshell

"""Example code taken from
https://marshmallow.readthedocs.io/en/3.0/quickstart.html#quickstart
"""

import datetime as dt
import inspect
import typing as t

from marshmallow import Schema, fields, post_load
from sanic.exceptions import ServerError
from sanic.response import text

from sanic_boom import Component, SanicBoom

# --------------------------------------------------------------------------- #
# marshmallow related code
# --------------------------------------------------------------------------- #


class User(object):
    def __init__(self, name, email):
        self.name = name
        self.email = email
        self.created_at = dt.datetime.now()

    def __repr__(self):
        return "<User(name={self.name!r})>".format(self=self)

    def say_hi(self):
        return "hi, my name is {}".format(self.name)


class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    created_at = fields.DateTime()

    @post_load
    def make_user(self, data):
        return User(**data)


# --------------------------------------------------------------------------- #
# sanic-boom related code
# --------------------------------------------------------------------------- #


class JSONBody(t.Generic[t.T_co]):
    pass


class JSONBodyComponent(Component):
    def resolve(self, param: inspect.Parameter) -> bool:
        if hasattr(param.annotation, "__origin__"):
            return param.annotation.__origin__ == JSONBody
        return False

    async def get(self, request, param: inspect.Parameter) -> object:
        inferred_type = param.annotation.__args__[0]
        try:
            return inferred_type().load(request.json).data
        except Exception:
            raise ServerError(
                "Couldn't convert JSON body to {!s}".format(inferred_type)
            )


app = SanicBoom(__name__)
app.add_component(JSONBodyComponent)


@app.post("/")
async def handler(user: JSONBody[UserSchema]):  # notice the handler parameters
    return text(user.say_hi())


if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000, workers=1)
$ curl -v http://localhost:8000/ -d '{"name":"John Doe","email":"[email protected]"}'
*   Trying ::1...
* TCP_NODELAY set
* connect to ::1 port 8000 failed: Connection refused
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to localhost (127.0.0.1) port 8000 (#0)
> POST / HTTP/1.1
> Host: localhost:8000
> User-Agent: curl/7.61.1
> Accept: */*
> Content-Length: 50
> Content-Type: application/x-www-form-urlencoded
>
* upload completely sent off: 50 out of 50 bytes
< HTTP/1.1 200 OK
< Connection: keep-alive
< Keep-Alive: 5
< Content-Length: 23
< Content-Type: text/plain; charset=utf-8
<
* Connection #0 to host localhost left intact
hi, my name is John Doe

Warning

IMPORTANT: sanic-boom is in very early stages of development! Use with caution and be aware that some functionalities and APIs may change between versions until they're out of alpha.

Dependencies

sanic-boom depends on two "not-so-known" libraries (both created by the author of sanic-boom):

Important

Since xrtr replaces the Sanic default router under the hood in sanic-boom, it is very important for the developer to read its documentation (in the link provided above).

Documentation

https://sanic-boom.readthedocs.io/en/latest/

License

sanic-boom is a free software distributed under the MIT license.

About

Component injection and caching, faster routing system and non-global middlewares. Give your Sanic application a Boom!

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published