Check out our sponsors in the docs
If you would like to support the work that we do please consider becoming a sponsor via Polar.sh (preferred), GitHub or Open Collective.
Also, exclusively with Polar, you can engage in pledge-based sponsorships.
While supporting function-based route handlers, Litestar also supports and promotes python OOP using class based controllers:
from typing import List, Optional
from datetime import datetime
from litestar import Controller, get, post, put, patch, delete
from litestar.dto import DTOData
from pydantic import UUID4
from my_app.models import User, PartialUserDTO
class UserController(Controller):
path = "/users"
@post()
async def create_user(self, data: User) -> User: ...
@get()
async def list_users(self) -> List[User]: ...
@get(path="/{date:int}")
async def list_new_users(self, date: datetime) -> List[User]: ...
@patch(path="/{user_id:uuid}", dto=PartialUserDTO)
async def partial_update_user(
self, user_id: UUID4, data: DTOData[PartialUserDTO]
) -> User: ...
@put(path="/{user_id:uuid}")
async def update_user(self, user_id: UUID4, data: User) -> User: ...
@get(path="/{user_name:str}")
async def get_user_by_name(self, user_name: str) -> Optional[User]: ...
@get(path="/{user_id:uuid}")
async def get_user(self, user_id: UUID4) -> User: ...
@delete(path="/{user_id:uuid}")
async def delete_user(self, user_id: UUID4) -> None: ...
Litestar is rigorously typed, and it enforces typing. For example, if you forget to type a return value for a route handler, an exception will be raised. The reason for this is that Litestar uses typing data to generate OpenAPI specs, as well as to validate and parse data. Thus, typing is essential to the framework.
Furthermore, Litestar allows extending its support using plugins.
Litestar has a plugin system that allows the user to extend serialization/deserialization, OpenAPI generation, and other features.
It ships with a builtin plugin for SQL Alchemy, which allows the user to use SQLAlchemy declarative classes "natively" i.e., as type parameters that will be serialized/deserialized and to return them as values from route handlers.
Litestar also supports the programmatic creation of DTOs with a DTOFactory
class, which also supports the use of
plugins.
Litestar has custom logic to generate OpenAPI 3.1.0 schema, include optional generation of examples using the
polyfactory
library.
Litestar serves the documentation from the generated OpenAPI schema with:
All these are available and enabled by default.
Litestar has a simple but powerful DI system inspired by pytest. You can define named dependencies - sync or async - at different levels of the application, and then selective use or overwrite them.
from litestar import Litestar, get
from litestar.di import Provide
async def my_dependency() -> str: ...
@get("/")
async def index(injected: str) -> str:
return injected
app = Litestar([index], dependencies={"injected": Provide(my_dependency)})
Litestar supports typical ASGI middleware and ships with middlewares to handle things such as
Litestar has an authorization mechanism called guards
, which allows the user to define guard functions at different
level of the application (app, router, controller etc.) and validate the request before hitting the route handler
function.
from litestar import Litestar, get
from litestar.connection import ASGIConnection
from litestar.handlers.base import BaseRouteHandler
from litestar.exceptions import NotAuthorizedException
async def is_authorized(connection: ASGIConnection, handler: BaseRouteHandler) -> None:
# validate authorization
# if not authorized, raise NotAuthorizedException
raise NotAuthorizedException()
@get("/", guards=[is_authorized])
async def index() -> None: ...
app = Litestar([index])
Litestar supports request life cycle hooks, similarly to Flask - i.e. before_request
and after_request
Litestar is fast. It is on par with, or significantly faster than comparable ASGI frameworks.
You can see and run the benchmarks here, or read more about it here in our documentation.
Litestar is open to contributions big and small. You can always join our discord server or join our Matrix space to discuss contributions and project maintenance. For guidelines on how to contribute, please see the contribution guide.
Na'aman Hirschfeld ? |
Peter Schutt ? |
Ashwin Vinod |
Damian |
Vincent Sarago |
Jonas Krüger Svensson ? |
Sondre Lillebø Gundersen ? |
Lev ? |
Tim Wedde |
Tory Clasen |
Arseny Boykov ? |
Jacob Rodgers |
Dane Solberg |
madlad33 |
Matthew Aylward |
Jan Klima |
C2D |
to-ph |
imbev |
cătălin |
Seon82 |
Slava |
Harry |
Cody Fincher ? |
Christian Clauss |
josepdaniel |
devtud ? |
Nicholas Ramos |
seladb |
Simon Wienhöfer |
MobiusXS |
Aidan Simard |
wweber |
Samuel Colvin |
Mateusz Mikołajczyk |
Alex |
Odiseo |
Javier Pinilla |
Chaoying |
infohash |
John Ingles |
Eugene |
Jon Daly |
Harshal Laheri |
Téva KRIEF |
Konstantin Mikhailov ? |
Mitchell Henry |
chbndrhnns |
nielsvanhooy ? |
provinzkraut ? |
Joshua Bronson |
Roman Reznikov |
mookrs |
Mike DePalatis |
Carlos Alberto Pérez-Molano |
ThinksFast |
Christopher Krause |
Kyle Smith ? |
Scott Bradley ? |
Srikanth Chekuri |
Michael Bosch |
sssssss340 ? |
ste-pool ? |
Alc-Alc |
asomethings |
Garry Bullock |
Niclas Haderer |
Diego Alvarez |
Jason Nance |
Igor Kapadze |
Somraj Saha |
Magnús Ágúst Skúlason |
Alessio Parma |
Peter Brunner |
Jacob Coffee |
Gamazic |
Kareem Mahlees |
Abdulhaq Emhemmed |
Jenish |
chris-telemetry |
Ward ? |
Stephan Fitzpatrick ? |
Eric Kennedy |
wassaf shahzad |
Nils Olsson ? |
Riley Chase |
arl ? |
Antoine van der Horst |
Nick Groenen |
Giorgio Vilardo |
Nicholas Bollweg |
Tomas Jonsson |
Khiem Doan |
kedod |
sonpro1296 |
Patrick Armengol |
Sander |
疯人院主任 |
aviral-nayya |
whiskeyriver |
Phyo Arkar Lwin |
MatthewNewland ? |
Tom Kuo ? |
LeckerenSirupwaffeln ? |
Daniel González Fernández |
01EK98 |
Sarbo Roy |
Ryan Seeley |
Felix ? |
George Sakkis |
Huba Tuba |
Stefane Fermigier |
r4ge |
Jay |
sinisaos |
Tharuka Devendra |
euri10 ? |
Shubham |
Erik Hasse ? |
Nikita Sobolev ? |
Nguyễn Hoàng Đức ? |
RavanaBhrama |
Marcel Johannesmann |
Matthew |
Mattwmaster58 ? |
Manuel Sanchez Pinar |
Juan Riveros |
David Brochart |
Sean Donoghue |
P.C. Shyamshankar ? |
William Evonosky |
geeshta ? |
Robert Rosca |
DICE_Lab |
Luis San Pablo |
Pastukhov Nikita |
James O'Claire |
Pete |
Alexandre Richonnier |
betaboon |
Dennis Brakhane ? |
Pragy Agarwal |
Piotr Dybowski |
Konrad Szczurek |
Orell Garten |
Julien |
Leejay Hsu ? ? |
Michiel W. Beijen |
L. Bao |
Jarred Glaser |
Hunter Boyd |
Cesar Giulietti |
Marcus Lim |
Henry Zhou ? |
William Stam |
andrew do |
Boseong Choi |
Kim Minki |
Jeongseop Lim |
FergusMok |
Manu Singhal |
Jerry Wu |
horo ? |
Ross Titmarsh |
Mike Korneev |
Patrick Neise |
Jean Arhancet ? |
Leo Alekseyev |
aranvir |
bunny-therapist |
Ben Luo |
Hugo van Kemenade |
Michael Gerbig |
CrisOG ? |
harryle |
James Bennett ? |
sherbang |
Carl Smedstad |
Taein Min |
Stanislav Lyu. ? |
Tibor Reiss |
Alex ? |
Joren Six |
jderrien |
PossiblePanda |
evstrat ? |
Ikko Eltociear Ashimine |
Taimur Ibrahim |
l-armstrong |
Anuranjan Srivastava |
Simon Joseph |
Abel Kidanemariam |
Trim21 |
Agustin Arce |
Farhan Ali Raza |
Fabian |
Mohammed Babelly |
Charles Duffy |
Evgeny Demchenko |
Olzhas Arystanov ? |
Vikash |
This project follows the all-contributors specification. Contributions of any kind welcome!