サイトアイコン 【TechGrowUp】

Python開発入門48 Sanicフレームワーク入門

Daichi Mizuno

はじめに

Sanicは、Pythonで高速な非同期Webアプリケーションを構築するための軽量Webフレームワークです。非同期I/O（asyncio）を活用して高いパフォーマンスを実現し、リクエスト処理の並列性を最大限に引き出すことが可能です。

この記事では、Sanicの基本的な使い方や構造、実際のコード例を通じて、その特長と応用方法を解説します。

Sanicとは

Sanicの概要

Sanicは、Pythonのasyncioをベースにした非同期Webフレームワークです。以下のような特徴を持っています：

Sanicの主な特徴

  1. 非同期I/Oを最大限に活用
    asyncioを基盤としており、高速で効率的なリクエスト処理を実現します。
  2. シンプルな設計
    Flaskに似た直感的な設計で、学習コストが低いのが特徴です。
  3. 高いスケーラビリティ
    大量の同時接続を処理するWebアプリケーションの構築に適しています。
  4. リアルタイム通信対応
    WebSocketやストリーミングのサポートで、リアルタイム機能を簡単に実装可能です。

Sanicのインストールとセットアップ

Sanicのインストール

以下のコマンドでSanicをインストールします：

pip install sanic

インストール確認

以下のコードを実行してSanicのバージョンを確認します：

from sanic import __version__
print(__version__)

Sanicアプリケーションの基本構造

Sanicアプリケーションの基本構造は、以下のコンポーネントで構成されます：

  1. アプリケーションの作成
  2. ルーティングの定義
  3. リクエストハンドラーの作成
  4. アプリケーションの起動

基本構造の例

以下は、Sanicアプリケーションのシンプルな例です。

from sanic import Sanic
from sanic.response import json

app = Sanic("MyApp")

@app.route("/")
async def handle_request(request):
    return json({"message": "Hello, Sanic!"})

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

説明：

  1. アプリケーションの作成
    Sanic("MyApp")でアプリケーションを作成します。
  2. ルート定義
    @app.route("/")でルート/へのGETリクエストを定義します。
  3. 非同期ハンドラー
    非同期関数handle_requestでリクエストを処理します。
  4. アプリの起動
    app.runでアプリケーションを起動します。

Sanicの主要機能

非同期リクエスト処理

Sanicは非同期I/Oを活用してリクエストを効率的に処理します。

例：非同期関数の使用
import asyncio

@app.route("/async")
async def async_handler(request):
    await asyncio.sleep(1)  # 非同期タスク
    return json({"message": "非同期処理が完了しました"})

URLパラメータとクエリ文字列

SanicではURLパラメータやクエリ文字列を簡単に扱えます。

例：URLパラメータの取得
@app.route("/user/<name>")
async def greet_user(request, name):
    return json({"message": f"こんにちは、{name}さん！"})
例：クエリ文字列の取得
@app.route("/search")
async def search(request):
    query = request.args.get("q", "デフォルト")
    return json({"query": query})

JSONリクエストとレスポンス

SanicではJSONデータの送受信が簡単に行えます。

例：JSONリクエストの処理
@app.route("/submit", methods=["POST"])
async def handle_submit(request):
    data = request.json
    return json({"received": data})

WebSocketサポート

リアルタイム通信を実現するWebSocketの実装も簡単です。

例：WebSocketサーバー
@app.websocket("/ws")
async def websocket_handler(request, ws):
    while True:
        message = await ws.recv()
        await ws.send(f"受信: {message}")

ミドルウェア

Sanicではミドルウェアを使ってリクエストやレスポンスを加工できます。

例：リクエストロギングミドルウェア
@app.middleware("request")
async def log_request(request):
    print(f"リクエスト受信: {request.method} {request.path}")

Sanicの応用例

RESTful APIの構築

SanicはRESTful APIを簡単に構築できます。
以下は、CRUD操作を実装した例です。

users = {}

@app.route("/users", methods=["POST"])
async def create_user(request):
    user_id = len(users) + 1
    users[user_id] = request.json
    return json({"id": user_id})

@app.route("/users/<user_id:int>", methods=["GET"])
async def get_user(request, user_id):
    user = users.get(user_id)
    if not user:
        return json({"error": "User not found"}, status=404)
    return json(user)

ストリーミング

ストリーミングデータをリアルタイムに送信できます。

例：ストリーミングレスポンス
from sanic.response import stream

@app.route("/stream")
async def stream_response(request):
    async def data_stream(response):
        for i in range(5):
            await response.write(f"データ{i}\n")
            await asyncio.sleep(1)
    return stream(data_stream)

Sanicを使う際の注意点

  1. 非同期設計の理解
    非同期I/Oの基本を理解し、async/awaitを適切に使いましょう。
  2. スケールアップ戦略
    高負荷アプリケーションでは、複数のワーカーを使用する設定を検討しましょう。
  3. エラーハンドリング
    適切なエラーハンドリングを実装して、アプリケーションの信頼性を高めましょう。

まとめ

Sanicは、高速でスケーラブルなPythonの非同期Webフレームワークであり、シンプルな設計で初心者にも扱いやすいです。この記事で紹介した基本構造や実践例を参考に、Sanicを活用して高性能なWebアプリケーションを構築してみてください！

モバイルバージョンを終了