A little Python http framework
Project description
A little Python http framework
⚠️ Ready to use in v0.1.0
, production ready in v1.0.0
Install
pipenv install bobtail
pipenv install gunicorn
Getting Started
An example of the smallest Bobtail app
from typing import Tuple, Optional, Dict
from bobtail import BobTail, AbstractRoute, Request, Response
class Images:
def get(self, req, res):
res.set_body({id: 1})
routes = [
(Images(), "/images")
]
app = BobTail(routes=routes)
Run
pipenv run gunicorn api:app
Middleware
Bobtail middleware
Using third party middleware
from bobttail_logger import BobtailLogger
app = Bobtail(routes=routes)
# Here we are using `bobtail-logger` logging middleware
app.use(BobtailLogger())
Middleware currently available
Creating custom middleware example. A Middleware object must implement AbstractMiddleware
.
from bobtail import Request, Response
from bobtail.middleware import AbstractMiddleware, Tail
class BobtailCors(AbstractMiddleware):
def run(self, req: Request, res: Response, tail: Tail) -> None:
res.set_headers({
"Access-Control-Allow-Origin": "*",
})
tail(req, res)
Set the Headers
You can set the headers with the Response
object's set_headers
method. The default headers
are Content-Type: application/json
.
class Images:
def get(self, req, res):
res.set_headers({"Content-type": "text/plain"})
Set the response status
You can set the status with the Response
object's set_status
method. The default status
is always set to 200
if there are no errors.
class Images:
def get(self, req, res):
res.set_status(202)
Request
Request Args
You can specify the type of Request
arguments using curly braces & within the name & type seperated
by a colon, for example:
/images/{id:int}/{name:str}/{is_raining:bool}
To access request arguments inside a route handler, use the Request
object's get_arg
method, for example:
def get(self, req, res):
id = req.get_args("id") # int
name = req.get_args("name") # str
is_raining = req.get_args("is_raining") # bool
Request Body
- JSON
# marshals json to a python dict
req.get_json()
- Plain Text
# returns a string
req.get_body()
- Urlencoded form data
# returns a pyton dict
req.get_form_data()
- Multipart form data
# returns a pyton dict
req.get_multipart_data()
The Request
object provides methods to easily get form values. By default, if a form value
doesn't exist, then either FormDataError
or MultipartFormDataError
exceptions will be raised.
- Get Form Value
from bobtail.exceptions import FormDataError
try:
email = req.get_form_value("email")
except FormDataError:
pass # handle no form value
- Get Multipart Form Value
from bobtail.exceptions import MultipartFormDataError
try:
email = req.get_multipart_value("email")
except MultipartFormDataError:
pass # handle no multipart form value
- Get Multipart Form File Value
from bobtail.exceptions import MultipartFormDataError
try:
email = req.get_filename_value("image")
except MultipartFormDataError:
pass # handle no file value
OOP Approach
If you prefer to organise your routes in a more OOP approach, you can implement the
AbstractRoute
abstract class. It's especially useful when using an IDE like Pycharm
where the IDE will generate automatically all the require methods.
from bobtail import AbstractRoute, Request, Response
# (Pycharm) - right click over the `Image` class name & select `Show context actions`
# then click `implement abstract methods`, then select all and click ok.
class Images(AbstractRoute):
pass
Which will generate the following:
from bobtail import AbstractRoute, Request, Response
class Images(AbstractRoute):
def get(self, req: Request, res: Response):
pass
def post(self, req: Request, res: Response):
pass
def put(self, req: Request, res: Response):
pass
def delete(self, req: Request, res: Response):
pass
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.