MyGit

litestar-org/litestar

Fork: 337 Star: 4701 (更新于 2024-06-12 01:59:25)

license: MIT

Language: Python .

Production-ready, Light, Flexible and Extensible ASGI API framework | Effortlessly Build Performant APIs

最后发布版本: v2.9.0 ( 2024-06-03 00:34:16)

官方网址 GitHub网址

Litestar Logo - Light Litestar Logo - Dark

Project Status
CI/CD Latest Release ci Documentation Building
Quality Coverage Quality Gate Status Maintainability Rating Reliability Rating Security Rating
Package PyPI - Version PyPI - Support Python Versions Starlite PyPI - Downloads Litestar PyPI - Downloads
Community Reddit Discord Matrix Medium Twitter Blog
Meta Litestar Project types - Mypy License - MIT Litestar Sponsors linting - Ruff code style - Ruff All Contributors

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

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

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:

Scalar.com Telemetry Sports Stok

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:

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
Na'aman Hirschfeld

🚧 💻 📖 ⚠️ 🤔 💡 🐛
Peter Schutt
Peter Schutt

🚧 💻 📖 ⚠️ 🤔 💡 🐛
Ashwin Vinod
Ashwin Vinod

💻 📖
Damian
Damian

📖
Vincent Sarago
Vincent Sarago

💻
Jonas Krüger Svensson
Jonas Krüger Svensson

📦
Sondre Lillebø Gundersen
Sondre Lillebø Gundersen

📦
Lev
Lev

💻 🤔
Tim Wedde
Tim Wedde

💻
Tory Clasen
Tory Clasen

💻
Arseny Boykov
Arseny Boykov

💻 🤔
Jacob Rodgers
Jacob Rodgers

💡
Dane Solberg
Dane Solberg

💻
madlad33
madlad33

💻
Matthew Aylward
Matthew Aylward

💻
Jan Klima
Jan Klima

💻
C2D
C2D

⚠️
to-ph
to-ph

💻
imbev
imbev

📖
cătălin
cătălin

💻
Seon82
Seon82

📖
Slava
Slava

💻
Harry
Harry

💻 📖
Cody Fincher
Cody Fincher

🚧 💻 📖 ⚠️ 🤔 💡 🐛
Christian Clauss
Christian Clauss

📖
josepdaniel
josepdaniel

💻
devtud
devtud

🐛
Nicholas Ramos
Nicholas Ramos

💻
seladb
seladb

📖 💻
Simon Wienhöfer
Simon Wienhöfer

💻
MobiusXS
MobiusXS

💻
Aidan Simard
Aidan Simard

📖
wweber
wweber

💻
Samuel Colvin
Samuel Colvin

💻
Mateusz Mikołajczyk
Mateusz Mikołajczyk

💻
Alex
Alex

💻
Odiseo
Odiseo

📖
Javier  Pinilla
Javier Pinilla

💻
Chaoying
Chaoying

📖
infohash
infohash

💻
John Ingles
John Ingles

💻
Eugene
Eugene

⚠️ 💻
Jon Daly
Jon Daly

📖 💻
Harshal Laheri
Harshal Laheri

💻 📖
Téva KRIEF
Téva KRIEF

💻
Konstantin Mikhailov
Konstantin Mikhailov

🚧 💻 📖 ⚠️ 🤔 💡 🐛
Mitchell Henry
Mitchell Henry

📖
chbndrhnns
chbndrhnns

📖
nielsvanhooy
nielsvanhooy

💻 🐛 ⚠️
provinzkraut
provinzkraut

🚧 💻 📖 ⚠️ 🤔 💡 🐛 🎨
Joshua Bronson
Joshua Bronson

📖
Roman Reznikov
Roman Reznikov

📖
mookrs
mookrs

📖
Mike DePalatis
Mike DePalatis

📖
Carlos Alberto Pérez-Molano
Carlos Alberto Pérez-Molano

📖
ThinksFast
ThinksFast

⚠️ 📖
Christopher Krause
Christopher Krause

💻
Kyle Smith
Kyle Smith

💻 📖 🐛
Scott Bradley
Scott Bradley

🐛
Srikanth Chekuri
Srikanth Chekuri

⚠️ 📖
Michael Bosch
Michael Bosch

📖
sssssss340
sssssss340

🐛
ste-pool
ste-pool

💻 🚇
Alc-Alc
Alc-Alc

📖 💻 ⚠️ 🚇
asomethings
asomethings

💻
Garry Bullock
Garry Bullock

📖
Niclas Haderer
Niclas Haderer

💻
Diego Alvarez
Diego Alvarez

📖 💻 ⚠️
Jason Nance
Jason Nance

📖
Igor Kapadze
Igor Kapadze

📖
Somraj Saha
Somraj Saha

📖
Magnús Ágúst Skúlason
Magnús Ágúst Skúlason

💻 📖
Alessio Parma
Alessio Parma

📖
Peter Brunner
Peter Brunner

💻
Jacob Coffee
Jacob Coffee

📖 💻 ⚠️ 🚇 🤔 🚧 💼 🎨
Gamazic
Gamazic

💻
Kareem Mahlees
Kareem Mahlees

💻
Abdulhaq Emhemmed
Abdulhaq Emhemmed

💻 📖
Jenish
Jenish

💻 📖
chris-telemetry
chris-telemetry

💻
Ward
Ward

🐛
Stephan Fitzpatrick
Stephan Fitzpatrick

🐛
Eric Kennedy
Eric Kennedy

📖
wassaf shahzad
wassaf shahzad

💻
Nils Olsson
Nils Olsson

💻 🐛
Riley Chase
Riley Chase

💻
arl
arl

🚧
Antoine van der Horst
Antoine van der Horst

📖
Nick Groenen
Nick Groenen

📖
Giorgio Vilardo
Giorgio Vilardo

📖
Nicholas Bollweg
Nicholas Bollweg

💻
Tomas Jonsson
Tomas Jonsson

⚠️ 💻
Khiem Doan
Khiem Doan

📖
kedod
kedod

📖 💻 ⚠️
sonpro1296
sonpro1296

💻 ⚠️ 🚇 📖
Patrick Armengol
Patrick Armengol

📖
Sander
Sander

📖
疯人院主任
疯人院主任

📖
aviral-nayya
aviral-nayya

💻
whiskeyriver
whiskeyriver

💻
Phyo Arkar Lwin
Phyo Arkar Lwin

💻
MatthewNewland
MatthewNewland

🐛 💻 ⚠️
Tom Kuo
Tom Kuo

🐛
LeckerenSirupwaffeln
LeckerenSirupwaffeln

🐛
Daniel González Fernández
Daniel González Fernández

📖
01EK98
01EK98

📖
Sarbo Roy
Sarbo Roy

💻
Ryan Seeley
Ryan Seeley

💻
Felix
Felix

📖 🐛
George Sakkis
George Sakkis

💻
Huba Tuba
Huba Tuba

📖
Stefane Fermigier
Stefane Fermigier

📖
r4ge
r4ge

💻 📖
Jay
Jay

💻
sinisaos
sinisaos

📖
Tharuka Devendra
Tharuka Devendra

💻
euri10
euri10

💻 📖 🐛
Shubham
Shubham

📖
Erik Hasse
Erik Hasse

🐛 💻
Nikita Sobolev
Nikita Sobolev

🚇 💻
Nguyễn Hoàng Đức
Nguyễn Hoàng Đức

🐛
RavanaBhrama
RavanaBhrama

📖
Marcel Johannesmann
Marcel Johannesmann

📖
Matthew
Matthew

📖
Mattwmaster58
Mattwmaster58

🐛 💻 ⚠️
Manuel Sanchez Pinar
Manuel Sanchez Pinar

📖
Juan Riveros
Juan Riveros

📖
David Brochart
David Brochart

📖
Sean Donoghue
Sean Donoghue

📖
P.C. Shyamshankar
P.C. Shyamshankar

🐛 💻 ⚠️
William Evonosky
William Evonosky

💻
geeshta
geeshta

📖 💻 🐛
Robert Rosca
Robert Rosca

📖
DICE_Lab
DICE_Lab

💻
Luis San Pablo
Luis San Pablo

💻 ⚠️ 📖
Pastukhov Nikita
Pastukhov Nikita

📖
James O'Claire
James O'Claire

📖
Pete
Pete

📖
Alexandre Richonnier
Alexandre Richonnier

💻 📖
betaboon
betaboon

💻
Dennis Brakhane
Dennis Brakhane

💻 🐛
Pragy Agarwal
Pragy Agarwal

📖
Piotr Dybowski
Piotr Dybowski

📖
Konrad Szczurek
Konrad Szczurek

📖 ⚠️
Orell Garten
Orell Garten

💻 📖 ⚠️
Julien
Julien

📖
Leejay Hsu
Leejay Hsu

🚧 🚇 📖
Michiel W. Beijen
Michiel W. Beijen

📖
L. Bao
L. Bao

📖
Jarred Glaser
Jarred Glaser

📖
Hunter Boyd
Hunter Boyd

📖
Cesar Giulietti
Cesar Giulietti

📖
Marcus Lim
Marcus Lim

📖
Henry Zhou
Henry Zhou

🐛 💻
William Stam
William Stam

📖
andrew do
andrew do

💻 ⚠️ 📖
Boseong Choi
Boseong Choi

💻 ⚠️
Kim Minki
Kim Minki

💻 📖
Jeongseop Lim
Jeongseop Lim

📖
FergusMok
FergusMok

📖 💻 ⚠️
Manu Singhal
Manu Singhal

📖
Jerry Wu
Jerry Wu

📖
horo
horo

🐛
Ross Titmarsh
Ross Titmarsh

💻
Mike Korneev
Mike Korneev

📖
Patrick Neise
Patrick Neise

💻
Jean Arhancet
Jean Arhancet

🐛
Leo Alekseyev
Leo Alekseyev

💻
aranvir
aranvir

📖
bunny-therapist
bunny-therapist

💻
Ben Luo
Ben Luo

📖
Hugo van Kemenade
Hugo van Kemenade

📖
Michael Gerbig
Michael Gerbig

📖
CrisOG
CrisOG

🐛 💻 ⚠️
harryle
harryle

💻 ⚠️
James Bennett
James Bennett

🐛
sherbang
sherbang

📖
Carl Smedstad
Carl Smedstad

⚠️
Taein Min
Taein Min

📖
Stanislav Lyu.
Stanislav Lyu.

🐛
Tibor Reiss
Tibor Reiss

⚠️ 📖 💻
Alex
Alex

🐛 💻
Joren Six
Joren Six

📖
jderrien
jderrien

📖
PossiblePanda
PossiblePanda

📖
evstrat
evstrat

🚇
Ikko Eltociear Ashimine
Ikko Eltociear Ashimine

📖

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

最近版本更新:(数据更新于 2024-06-13 10:10:29)

2024-06-03 00:34:16 v2.9.0

2024-05-06 15:20:23 v2.6.4

2024-05-06 15:18:04 v2.7.2

2024-05-06 15:17:07 v1.51.16

2024-05-06 15:09:15 v2.8.3

2024-05-05 19:51:42 v1.51.15

2024-04-09 16:14:38 v2.8.2

2024-04-08 19:23:38 v2.8.1

2024-04-06 04:31:20 v2.8.0

2024-03-27 14:45:56 v2.7.1

主题(topics):

api, asgi, asyncio, hacktoberfest, litestar, litestar-api, litestar-framework, msgspec, openapi, pydantic, python, rapidoc, redoc, rest, starlite, starlite-api, swagger

litestar-org/litestar同语言 Python最近更新仓库

2024-06-21 18:02:49 argilla-io/argilla

2024-06-18 16:26:58 hpcaitech/Open-Sora

2024-06-18 10:45:23 vanna-ai/vanna

2024-06-15 05:16:32 NVIDIA/warp

2024-06-14 10:42:40 1Panel-dev/MaxKB

2024-06-13 22:59:46 mikumifa/biliTickerBuy