starlette

輝く小さな ASGI フレームワーク。

---

---

ドキュメント: https://www.starlette.io

ソースコード: https://github.com/encode/starlette

---

スターレット

Starlette は、Python で非同期 Web サービスを構築するのに最適な軽量の ASGI フレームワーク/ツールキットです。

これは本番環境に対応しており、次の機能を提供します。

• 軽量で複雑度の低い HTTP Web フレームワーク。
• WebSocketのサポート。
• 進行中のバックグラウンド タスク。
• 起動イベントとシャットダウンイベント。
• httpx上に構築されたテスト クライアント。
• CORS、GZip、静的ファイル、ストリーミング応答。
• セッションと Cookie のサポート。
• 100% のテスト カバレッジ。
• 100% 型の注釈付きコードベース。
• ハードな依存関係はほとんどありません。
• asyncioおよびtrioバックエンドと互換性があります。
• 独立したベンチマークに対して優れた全体的なパフォーマンス。

インストール

$ pip install starlette

uvicorn、daphne、hypercorn などの ASGI サーバーをインストールすることもできます。

$ pip install uvicorn

例

 from starlette . applications import Starlette
from starlette . responses import JSONResponse
from starlette . routing import Route


async def homepage ( request ):
    return JSONResponse ({ 'hello' : 'world' })

routes = [
    Route ( "/" , endpoint = homepage )
]

app = Starlette ( debug = True , routes = routes )

次に、Uvicorn を使用してアプリケーションを実行します。

$ uvicorn example:app

より完全な例については、encode/starlette-example を参照してください。

依存関係

Starlette にはanyioのみが必要で、以下はオプションです。

• httpx - TestClientを使用する場合は必須。
• jinja2 - Jinja2Templatesを使用する場合は必須。
• python-multipart - request.form()を使用したフォーム解析をサポートする場合に必要です。
• itsdangerous - SessionMiddlewareサポートに必要です。
• pyyaml - SchemaGeneratorサポートに必要です。

これらはすべてpip install starlette[full]でインストールできます。

フレームワークまたはツールキット

Starlette は、完全なフレームワークとして、または ASGI ツールキットとして使用できるように設計されています。どのコンポーネントも独立して使用できます。

 from starlette . responses import PlainTextResponse


async def app ( scope , receive , send ):
    assert scope [ 'type' ] == 'http'
    response = PlainTextResponse ( 'Hello, world!' )
    await response ( scope , receive , send )

example.pyでappアプリケーションを実行します。

$ uvicorn example:app
INFO: Started server process [11509]
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

--reloadを指定して uvicorn を実行し、コード変更時の自動再ロードを有効にします。

モジュール性

Starlette が設計されているモジュール性により、ASGI フレームワーク間で共有できる再利用可能なコンポーネントの構築が促進されます。これにより、共有ミドルウェアとマウント可能なアプリケーションのエコシステムが可能になるはずです。

API が明確に分離されているということは、各コンポーネントを個別に理解することが容易であることも意味します。

---

Starlette は BSD ライセンスコードです。
慎重にデザインされ、作られています。
— ️ —