Skip to main content

A developer centric, performant Python web framework

Project description

Xpresso

Test Coverage Package version Supported Python versions

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:

Swagger UI

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. This is how Xpresso is able to provide dependency injection into the application lifespan and support for multiple dependency scopes.
  • Making the extraction of data from requests an API available to other developers, enabling features like compatibility with libraries other than Pydantic or MessagePack support to be made available as 3rd party extensions instead of feature requests. All of this with full support for hooking into the OpenAPI documentation generation.
  • Providing better support for application/x-www-form-urlencoded and multipart/form-data requests by describing them with dataclasses or Pydantic models. This includes support for advanced use cases like extracting JSON from a form field.
  • Able to inject App or a custom subclass you use into your lifespan and endpoints instead of having to resort to request.scope["app"].
  • Better performance by implementing dependency resolution in Rust, executing dependencies concurrently and controlling threading of sync dependencies on a per-dependency basis.
  • Allowing you to describe a single OpenAPI operation that accepts multiple content/types and extracting the right one based on headers
  • Giving you the ability to access and modify responses from within dependencies, allowing you to replace timing, tracing and logging middleware (which is routing ¨naive) with routing aware dependencies. No more middleware that accepts a regex pattern of paths!
  • Allowing dynamic building of security models triggered by lifespan events (you can load your Security model config from the environment at runtime).
  • Use of Annotated (PEP 593) instead of default values (param: str = Query(...)) which decouples the framework from Pydantic and enables a lot of the other features listed above and even allows you to make up your own markers to use if you make custom Binders.
  • Middleware on Router so that you can apply auth, logging or profiling to only some routes without resorting to regex path matching.
  • Support for lifespans on any Router or mounted App (this silently fails in FastAPI and Starlette)

See this release on GitHub: v0.11.2

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

xpresso-0.11.2.tar.gz (46.8 kB view details)

Uploaded Source

Built Distribution

xpresso-0.11.2-py3-none-any.whl (75.0 kB view details)

Uploaded Python 3

File details

Details for the file xpresso-0.11.2.tar.gz.

File metadata

  • Download URL: xpresso-0.11.2.tar.gz
  • Upload date:
  • Size: 46.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.11.0-1028-azure

File hashes

Hashes for xpresso-0.11.2.tar.gz
Algorithm Hash digest
SHA256 07a73cc641d647f060d7a9f8935677a0da3bb4a933d4815a9e24ea30159ea8fc
MD5 d270da585f5afc8d53d9108973262b89
BLAKE2b-256 17b8f7130907db8f7765b3bf27dc3a5a2cd32f11c7c79a8db4bb3f25e2b34eb1

See more details on using hashes here.

Provenance

File details

Details for the file xpresso-0.11.2-py3-none-any.whl.

File metadata

  • Download URL: xpresso-0.11.2-py3-none-any.whl
  • Upload date:
  • Size: 75.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.11.0-1028-azure

File hashes

Hashes for xpresso-0.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 383802ba8075dfdad68463d065edf3109b7c0a0c8b07bf79f166521a9c86a7f3
MD5 1dcfa11745ea3976454915c427b989f6
BLAKE2b-256 078e5a26acac16f2df5ec8cd8529ef83c78690b3e99d1a0671d3d012ed877fd7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page