GitLocker: The Coding Marketplace

Description:

litestar 2.11.0

Project

Status

CI/CD

Quality

Package

Community

Meta

Litestar is a powerful, flexible yet opinionated ASGI framework, focused on
building APIs, and offers high-performance data validation and parsing,
dependency injection, first-class ORM integration, authorization primitives, and much
more that's needed to get applications up and running.
Check out the documentation 📚 for a detailed overview of
its features!
Additionally, the Litestar fullstack repository
can give you a good impression how a fully fledged Litestar application may look.

Table of Contents

Installation

Quick Start

Core Features

Example Applications

Features

Class-based Controllers
Data Parsing, Type Hints, and Msgspec
Plugin System, ORM support, and DTOs
OpenAPI
Dependency Injection
Middleware
Route Guards
Request Life Cycle Hooks

Performance
Contributing

Installation
pip install litestar

Quick Start
from litestar import Litestar, get

@get("/")
def hello_world() -> dict[str, str]:
"""Keeping the tradition alive with hello world."""
return {"hello": "world"}

app = Litestar(route_handlers=[hello_world])

Core Features

Class based controllers
Dependency Injection
Layered Middleware
Plugin System
OpenAPI 3.1 schema generation
Life Cycle Hooks
Route Guards based Authorization
Support for dataclasses, TypedDict, pydantic version 1 and version 2,
msgspec and attrs
Layered parameter declaration
Support for RFC 9457 standardized "Problem Detail" error responses
Automatic API documentation with:

Scalar
RapiDoc
Redoc
Stoplight Elements
Swagger-UI

Trio support (built-in, via AnyIO)
Ultra-fast validation, serialization and deserialization using msgspec
SQLAlchemy integration
Piccolo ORM Support

Example Applications

Pre-built Example Apps

litestar-pg-redis-docker: In addition to Litestar, this
demonstrates a pattern of application modularity, SQLAlchemy 2.0 ORM, Redis cache connectivity, and more. Like all
Litestar projects, this application is open to contributions, big and small.
litestar-fullstack: A reference application that contains most of the boilerplate required for a web application.
It features a Litestar app configured with best practices, SQLAlchemy 2.0 and SAQ, a frontend integrated with Vitejs and Jinja2 templates, Docker, and more.
litestar-hello-world: A bare-minimum application setup. Great
for testing and POC work.

Sponsors
Litestar is an open-source project, and we enjoy the support of our sponsors to help fund the exciting
work we do.
A huge thanks to our sponsors:

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.
Features
Class-based Controllers
While supporting function-based route handlers, Litestar also supports and promotes python OOP using class based
controllers:

Example for 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: ...

Data Parsing, Type Hints, and Msgspec
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.
Plugin System, ORM support, and DTOs
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.
OpenAPI
Litestar has custom logic to generate OpenAPI 3.1.0 schema, include optional generation of examples using the
polyfactory library.
ReDoc, Swagger-UI and Stoplight Elements API Documentation
Litestar serves the documentation from the generated OpenAPI schema with:

ReDoc
Swagger-UI
Stoplight Elements
RapiDoc

All these are available and enabled by default.
Dependency Injection
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.

Example for DI
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)})

Middleware
Litestar supports typical ASGI middleware and ships with middlewares to handle things such as

CORS
CSRF
Rate limiting
GZip and Brotli compression
Client- and server-side sessions

Route Guards
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.

Example for route guards
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])

Request Life Cycle Hooks
Litestar supports request life cycle hooks, similarly to Flask - i.e. before_request and after_request
Performance
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.
Contributing
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.

Contributors ✨

Thanks goes to these wonderful people:
Emoji Key

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📖

This project follows the all-contributors specification.
Contributions of any kind welcome!