×

注意!页面内容来自https://pypi.org/project/uvicorn/,本站不储存任何内容,为了更好的阅读体验进行在线解析,若有广告出现,请及时反馈。若您觉得侵犯了您的利益,请通知我们进行删除,然后访问 原网页

The lightning-fast ASGI server.

Project description

uvicorn

An ASGI web serverfor Python.


Build Status Package version Supported Python Version Discord


Documentation: https://uvicorn.dev

Source Code: https://www.github.com/Kludex/uvicorn


Uvicorn is an ASGI web server implementation for Python.

Until recently Python has lacked a minimal low-level server/application interface for async frameworks. The ASGI specification fills this gapand means we're now able to start building a common set of tooling usable across all async frameworks.

Uvicorn supports HTTP/1.1 and WebSockets.

Quickstart

Install using pip:

$ pip install uvicorn

This will install uvicorn with minimal (pure Python) dependencies.

$ pip install 'uvicorn[standard]'

This will install uvicorn with "Cython-based" dependencies (where possible) and other "optional extras".

In this context"Cython-based" means the following:

  • the event loop uvloop will be installed and used if possible.
  • the http protocol will be handled by httptools if possible.

Moreover"optional extras" means that:

  • the websocket protocol will be handled by websockets (should you want to use wsproto you'd need to install it manually) if possible.
  • the --reload flag in development mode will use watchfiles.
  • windows users will have colorama installed for the colored logs.
  • python-dotenv will be installed should you want to use the --env-file option.
  • PyYAML will be installed to allow you to provide a .yaml file to --log-configif desired.

Create an applicationin example.py:

async def app(scope, receive, send):
    assert scope['type'] == 'http'

    await send({
        'type': 'http.response.start',
        'status': 200,
        'headers': [
            (b'content-type', b'text/plain'),
        ],
    })
    await send({
        'type': 'http.response.body',
        'body': b'Helloworld!',
    })

Run the server:

$ uvicorn example:app

Why ASGI?

Most well established Python Web frameworks started out as WSGI-based frameworks.

WSGI applications are a singlesynchronous callable that takes a request and returns a response. This doesn’t allow for long-lived connectionslike you get with long-poll HTTP or WebSocket connections, which WSGI doesn't support well.

Having an async concurrency model also allows for options such as lightweight background tasks, and can be less of a limiting factor for endpoints that have long periods being blocked on network I/O such as dealing with slow HTTP requests.


Alternative ASGI servers

A strength of the ASGI protocol is that it decouples the server implementation from the application framework. This allows for an ecosystem of interoperating webservers and application frameworks.

Daphne

The first ASGI server implementationoriginally developed to power Django Channelsis the Daphne webserver.

It is run widely in productionand supports HTTP/1.1HTTP/2and WebSockets.

Any of the example applications given here can equally well be run using daphne instead.

$ pip install daphne
$ daphne app:App

Hypercorn

Hypercorn was initially part of the Quart web frameworkbefore being separated out into a standalone ASGI server.

Hypercorn supports HTTP/1.1HTTP/2and WebSockets.

It also supports the excellent trio async frameworkas an alternative to asyncio.

$ pip install hypercorn
$ hypercorn app:App

Mangum

Mangum is an adapter for using ASGI applications with AWS Lambda & API Gateway.

Granian

Granian is an ASGI compatible Rust HTTP server which supports HTTP/2TLS and WebSockets.


Uvicorn is BSD licensed code.
Designed & crafted with care.

— 🦄 —

Project details


Release history Release notifications | RSS feed

This version

0.45.0

Download files

Download the file for your platform. If you're not sure which to chooselearn more about installing packages.

Source Distribution

uvicorn-0.45.0.tar.gz (87.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name formatlearn more about wheel file names.

uvicorn-0.45.0-py3-none-any.whl (69.8 kB view details)

Uploaded Python 3

File details

Details for the file uvicorn-0.45.0.tar.gz.

File metadata

  • Download URL: uvicorn-0.45.0.tar.gz
  • Upload date:
  • Size: 87.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uvicorn-0.45.0.tar.gz
Algorithm Hash digest
SHA256 3fe650df136c5bd2b9b06efc5980636344a2fbb840e9ddd86437d53144fa335d
MD5 02700ca86cc45ae04986ad56234822a2
BLAKE2b-256 eb2e62b0d9a2cfc8b4de6771322dae30f2db76c66dae9ec32e94e176a44ad563

See more details on using hashes here.

Provenance

The following attestation bundles were made for uvicorn-0.45.0.tar.gz:

Publisher: publish.yml on Kludex/uvicorn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file uvicorn-0.45.0-py3-none-any.whl.

File metadata

  • Download URL: uvicorn-0.45.0-py3-none-any.whl
  • Upload date:
  • Size: 69.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uvicorn-0.45.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2db26f588131aeec7439de00f2dd52d5f210710c1f01e407a52c90b880d1fd4f
MD5 c37379097c7c683b69f1cc6f5284646b
BLAKE2b-256 c188d0f7512465b166a4e931ccf7e77792be60fb88466a43964c7566cbaff752

See more details on using hashes here.

Provenance

The following attestation bundles were made for uvicorn-0.45.0-py3-none-any.whl:

Publisher: publish.yml on Kludex/uvicorn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.