A developer centric, performant Python web framework
Project description
Xpresso is an ASGI web framework built on top of Starlette, Pydantic and di, with heavy inspiration from FastAPI.
Some of the standout features are:
- ASGI support for high performance (within the context of Python web frameworks)
- OpenAPI documentation generation
- Automatic parsing and validation of request bodies and parameters, with hooks for custom extractors
- Full support for OpenAPI parameter serialization
- Highly typed and tested codebase with great IDE support
- A powerful dependency injection system, backed by di
Requirements
Python 3.7+
Installation
pip install xpresso
You'll also want to install an ASGI server, such as Uvicorn.
pip install uvicorn
Example
Create a file named example.py:
from pydantic import BaseModel
from xpresso import App, Path, FromPath, FromQuery
class Item(BaseModel):
item_id: int
name: str
async def read_item(item_id: FromPath[int], name: FromQuery[str]) -> Item:
return Item(item_id=item_id, name=name)
app = App(
routes=[
Path(
"/items/{item_id}",
get=read_item,
)
]
)
Run the application:
uvicorn example:app
Navigate to http://127.0.0.1:8000/items/123?name=foobarbaz in your browser. You will get the following JSON response:
{"item_id":123,"name":"foobarbaz"}
Now navigate to http://127.0.0.1:8000/docs to poke around the interactive Swagger UI documentation:
For more examples, tutorials and reference materials, see our documentation.
Inspiration and relationship to other frameworks
Xpresso is mainly inspired by FastAPI. FastAPI pioneered several ideas that are core to Xpresso's approach:
- Leverage Pydantic for JSON parsing, validation and schema generation.
- Leverage Starlette for routing and other low level web framework functionality.
- Provide a simple but powerful dependency injection system.
- Use that dependency injection system to provide extraction of request bodies, forms, query parameters, etc.
Xpresso takes these ideas and refines them by:
- Decoupling the dependency injection system from the request/response cycle, leading to an overall much more flexible and powerful dependency injection system, packaged up as the standalone di library.
- Decoupling the framework from Pydantic by using
Annotated(PEP 593) instead of default values (param: FromQuery[str]instead ofparam: str = Query(...)). - Middleware on Routers so that you can use generic ASGI middleware in a routing-aware manner (for example, installing profiling middleware on only some paths without using regex matching).
- Support for lifespans on any Router or mounted App (this silently fails in FastAPI and Starlette)
- dependency injection into the application lifespan and support for multiple dependency scopes.
- Formalizing the framework for extracting parameters and bodies from requests into the Binder API so that 3rd party extensions can do anything the framework does.
- Support for customizing parameter and form serialization.
- Better performance by implementing dependency resolution in Rust, executing dependencies concurrently and controlling threading of sync dependencies on a per-dependency basis.
Current state
This project is under active development. It should not be considered "stable" or ready to be used in production. It is however ready for experimentation and learning!
What is implemented and mostly stable?
- Extraction and OpenAPI documentation of parameters (query, headers, etc.) and request bodies (including multipart requests).
- Parameter serialization.
- Routing, including applications, routers and routes.
- Dependency injection and testing utilities (dependency overrides).
Most of this APIs will be generally stable going forward, although some minor aspects like argument names will probably change at some point.
What is not implemented or unstable?
- Low-level API for binders (stuff in
xpresso.binders): this is public, but should be considered experimental and is likely to change. The high level APIs (FromPath[str]andAnnotated[str, PathParam(...)]) are likely to be stable. - Security dependencies and OpenAPI integration. This part used to exist, but needed some work. It is planned for the future, but we need to think about the scope of these features and the API.
See this release on GitHub: v0.34.0
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.
Source Distribution
Built Distribution
File details
Details for the file xpresso-0.34.0.tar.gz.
File metadata
- Download URL: xpresso-0.34.0.tar.gz
- Upload date:
- Size: 42.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.11.0-1028-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fba45f9a0749466728f65cb6d6acfee8aeef62ccc230ca074b99bc8f3ab72688 |
|
| MD5 | dfd8b2da6228458268a89587b2f82cf4 |
|
| BLAKE2b-256 | 22451879d1f1714b8fb7dc53db853b2ddd134454bd989ecbeede18a0b871634f |
Provenance
File details
Details for the file xpresso-0.34.0-py3-none-any.whl.
File metadata
- Download URL: xpresso-0.34.0-py3-none-any.whl
- Upload date:
- Size: 59.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.11.0-1028-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 07ff0f46ffa378ed333ff26a9fd7aa3da78761d34f2a69bcb500dd8d7a96f015 |
|
| MD5 | cfa874dde8f58ea7766dd3e11992f8d7 |
|
| BLAKE2b-256 | 470972374a3b3369ad9766167876622b1d3d9b7992f84af7415d71431df4289a |
