Sanicハローワールドチュートリアル

Sanicを使い始める前に、システムにPython 3.7以降とpip（Pythonのパッケージインストーラー）がインストールされていることを確認してください。Sanicは、非同期機能のために最新のPython機能に大きく依存しています。

ターミナルでこのコマンドを実行して、Pythonのバージョンを確認できます。

python3 --version

Python 3.x.xのような出力が表示されるはずです。Pythonをインストールまたは更新する必要がある場合は、最新バージョンについてはpython.orgをご覧ください。

仮想環境を使用することは、プロジェクトの依存関係を効果的に管理するために不可欠です。これにより、Sanicプロジェクトのパッケージが他のPythonプロジェクトやシステム全体にインストールされたものと競合しないことが保証されます。

まず、Sanicプロジェクト用の新しいディレクトリを作成し、その中に移動します。

mkdir sanic-hello-world
cd sanic-hello-world

次に、プロジェクトディレクトリ内に仮想環境を作成します。

python3 -m venv .venv

最後に、仮想環境をアクティブ化します。

# macOS/Linux の場合
source .venv/bin/activate

# Windows の場合 (コマンドプロンプトを使用)
.venv\Scripts\activate

ターミナルプロンプトに (.venv) と表示され、仮想環境がアクティブになっていることを示します。

仮想環境がアクティブになったら、pipを使用してSanicとその依存関係をインストールできます。

pip install sanic

このコマンドは、Sanicとその必要なコンポーネント（システムで利用可能な場合、パフォーマンスを最大化するためのuvloopやhttptoolsなど）をインストールします。

それでは、最初のSanic "Hello World"アプリケーションを作成しましょう。プロジェクトディレクトリ（sanic-hello-world）で、main.pyという名前の新しいファイルを作成します。

main.pyをお好みのコードエディタで開き、次のPythonコードを追加してください。

from sanic import Sanic, response

# Sanicアプリケーションインスタンスを作成
app = Sanic("HelloWorldSanicApp")

# ルートURL("/")のルーティングを定義
# このルーティングはGETリクエストを処理します
@app.get("/")
async def hello_world(request):
    """
    ルートURLへのGETリクエストを処理し、「Hello, Sanic!」メッセージを返します。
    """
    return response.text("Hello, Sanic!")

# アプリケーション実行のエントリーポイント
if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000, dev=True)

main.pyファイルを一行ずつ分解して、Sanicアプリケーションがどのように機能するかを理解しましょう。

• from sanic import Sanic, response

  この行は、Sanicライブラリから必要なコンポーネントをインポートします。Sanicはアプリケーションインスタンスの作成に使用され、responseはHTTPレスポンスの生成に使用されます。

• app = Sanic("HelloWorldSanicApp")

  ここで、Sanicアプリケーションのインスタンスを作成します。文字列"HelloWorldSanicApp"はアプリケーションの名前で、デバッグやログ記録に役立ちます。

• @app.get("/")

  これは、Sanicにその下の関数をHTTP GETリクエストのルートURLパス（"/"）に関連付けるように指示するデコレータです。Sanicは、他のHTTPメソッドのために@app.post()、@app.put()、@app.delete()なども提供しています。

• async def hello_world(request):

  これは、hello_worldという名前の非同期関数を定義します。asyncキーワードはSanicにとって重要で、リクエストをブロックせずに同時に処理できます。関数はrequestオブジェクトを引数として受け取ります。これは、受信したHTTPリクエストに関する詳細を含んでいます。

• return response.text("Hello, Sanic!")

  ルーティングハンドラ内で、response.text()を使用して、コンテンツタイプtext/plainと本文の文字列 "Hello, Sanic!" を持つHTTPレスポンスを作成します。Sanicは、JSONレスポンス用のresponse.json()、HTML用のresponse.html()なども提供しています。

• if __name__ == "__main__":

  この標準的なPython構文により、スクリプトが直接実行された場合（モジュールとしてインポートされた場合ではない）にのみ、このブロック内のコードが実行されることが保証されます。

• app.run(host="0.0.0.0", port=8000, dev=True)

  この行は、Sanic Webサーバーを起動します。

  • host="0.0.0.0"は、サーバーが任意のネットワークインターフェイスからアクセスできるようにします。Dockerや外部アクセスに便利です。ローカル開発では、`127.0.0.1`または`localhost`も使用できます。
  • port=8000は、サーバーがポート8000でリッスンすることを指定します。
  • dev=Trueは開発モードを有効にし、コード変更時のサーバーの自動リロードや詳細なエラーメッセージなどの機能が含まれます。

main.pyファイルが準備できたので、Sanicサーバーを起動できます。sanic-hello-worldディレクトリにいること、および仮想環境がアクティブであることを確認してください。

Sanic CLIを使用してアプリケーションを実行します。

python main.py

より高度な構成には、より慣用的な `sanic` コマンドラインツールを使用することもできます。`if __name__ == "__main__": app.run(...)`を含めたため、この簡単な例では`python main.py`コマンドで十分です。`sanic main.app --dev`で実行する場合、自動検出のためにアプリケーションインスタンスは`app`という名前である必要があります。このガイドでは、`python main.py`がよりシンプルで直接機能します。

[INFO] Goin' Fast @ http://0.0.0.0:8000
[INFO] To stop: CTRL+C
                            

Sanicアプリケーションが実行されているので、正しく応答するかどうかをテストしましょう。Webブラウザを開き、次のURLに移動します。

http://127.0.0.1:8000/

ブラウザに "Hello, Sanic!" というテキストが表示されるはずです。または、curlのようなコマンドラインツールを使用することもできます。

curl http://127.0.0.1:8000/

ターミナルでの出力は次のようになります。

Hello, Sanic!

おめでとうございます！最初のSanicアプリケーションを正常に作成し、実行しました。

Sanicアプリケーションは、手動で停止するまでターミナルで実行され続けます。サーバーを停止するには、Sanicが実行されているターミナルに戻り、次のキーを押してください。

CTRL + C

これにより、サーバープロセスに割り込み信号が送信され、正常にシャットダウンします。

Sanicで最初の "Hello World" アプリケーションを正常に完了しました！この基本的な知識は、Pythonで高性能な非同期Webサービスを構築するための可能性の世界を開きます。

Sanicでの次のステップのアイデアをいくつか紹介します。

• 動的ルーティング： より柔軟なAPIを構築するために、パスパラメータ（例：/users/<user_id>）を持つルーティングを作成する方法を学びます。
• JSONレスポンス： response.json({"message": "Hello from Sanic!"})を使用して構造化されたデータを返します。
• リクエストデータ： クエリパラメータ（request.args）、フォームデータ（request.form）、およびJSONボディ（request.json）にアクセスします。
• ミドルウェア： 各リクエストの前後に実行される関数を実装して、認証、ログ記録、またはデータ変更を処理します。
• ブループリント： より大きなプロジェクトのために、アプリケーションをモジュールコンポーネントに整理します。
• データベース： Sanicを非同期データベースドライバ（PostgreSQLの場合はasyncpg、MySQLの場合はaiomysqlなど）と統合して、データベース操作を行います。
• WebSocket： Sanicの組み込みWebSocket通信サポートを探索します。
• デプロイ： Docker、Uvicornワーカーを使用したGunicorn、またはSanicネイティブサーバーを使用して、Sanicアプリケーションを本番環境にデプロイする方法を学びます。

Sanicの公式ドキュメントは、これらの機能やその他の機能の詳細を掘り下げるための優れたリソースです。