Sanic フレームワーク

# 構成

# ベーシック

Sanicは、アプリケーションオブジェクトのconfig属性に設定を保持します。構成オブジェクトは、ドット表記法を使用して、または辞書のように変更できる単なるオブジェクトです。

app = Sanic("myapp")
app.config.DB_NAME = "appdb"
app.config["DB_USER"] = "appuser"

また、通常の辞書と同様にupdate()メソッドを使用することもできます。

db_settings = {
    'DB_HOST': 'localhost',
    'DB_NAME': 'appdb',
    'DB_USER': 'appuser'
}
app.config.update(db_settings)

TIP

Sanicでは、設定値には大文字で名前を付けるのが一般的です.実際、大文字と小文字を混在させると奇妙な動作をすることがあります。

# 読み込み中

# 環境変数

SANIC_プレフィックスで定義された環境変数は、Sanicの設定に適用されます。たとえば、設定SANIC_REQUEST_TIMEOUTはアプリケーションによって自動的にロードされ、REQUEST_TIMEOUT構成変数に渡されます。

$ export SANIC_REQUEST_TIMEOUT=10

>>> print(app.config.REQUEST_TIMEOUT)
10

起動時にSanicが要求するプレフィクスを変更できます。

$ export MYAPP_REQUEST_TIMEOUT=10

>>> app = Sanic(__name__, load_env='MYAPP_')
>>> print(app.config.REQUEST_TIMEOUT)
10

環境変数のロードを完全に無効にすることもできます。

app = Sanic(__name__, load_env=False)

# Sanic.update_configを使用する

Sanicインスタンスには、config:app.update_configをロードするための_very_versatileメソッドがあります。ファイル、辞書、クラスなど、あらゆる種類のオブジェクトへのパスを指定できます。

# From a file

たとえば、次のようなmy_config.pyファイルがあるとします。

# my_config.py
A = 1
B = 2

パスをapp.update_configに渡すことで、これを構成値としてロードできます。

>>> app.update_config("/path/to/my_config.py")
>>> print(app.config.A)
1

このパスはbashスタイルの環境変数も受け付けます。

$ export my_path="/path/to"

app.update_config("${my_path}/my_config.py")

TIP

環境変数は${environment_variable}の形式で指定する必要があり、$environment_variableは展開されません ("プレーン"テキストとして扱われます) 。

# 辞書から

app.update_configメソッドは、通常の辞書でも動作します。

app.update_config({"A": 1, "B": 2})

# クラスまたはオブジェクトから

独自の構成クラスを定義して、app.update_config

class MyConfig:
    A = 1
    B = 2
app.update_config(MyConfig)

インスタンス化も可能です。

app.update_config(MyConfig())

# 型キャスティング

環境変数から読み込む場合、Sanicは値を期待されるPythonの型にキャストしようとします。これは特に以下に当てはまります。

  • int
  • float
  • bool

bool に関しては、以下のような大文字小文字を区別しない値を使用することができます。

  • True: y, yes, yep, yup, t, true, on, enable, enabled, 1
  • False: n, no, f, false, off, disable, disabled, 0

NEW in v21.12

さらに、Sanicは追加のタイプコンバータを使用して、追加の型をキャストするように設定することができます。これは、値を返すか、ValueErrorを発生させる任意のcallableでなければならない。

app = Sanic(..., config=Config(converters=[UUID]))

# 組み込み値

変数 デフォルト 説明
ACCESS_LOG True アクセスログを無効または有効にする。
AUTO_EXTEND ^ True Sanic Extensions が既存の仮想環境内にある場合にロードするかどうかを制御する
AUTO_RELOAD True ファイルが変更されたときにアプリケーションが自動的にリロードするかどうかを制御します。
EVENT_AUTOREGISTER True True のとき、存在しないシグナルに対して app.event() メソッドを使用すると、自動的にシグナルを生成して例外を発生させないEVENT_AUTOREGISTER.index.index.
FALLBACK_ERROR_FORMAT html 例外が発生し処理されなかった場合のエラー応答のフォーマット
FORWARDED_FOR_HEADER X-Forwarded-For クライアントとプロキシのIPを含む「X-Forwarded-For」HTTPヘッダの名前です。
FORWARDED_SECRET なし 特定のプロキシサーバーを安全に識別するために使用される（下記参照）
GRACEFUL_SHUTDOWN_TIMEOUT 15.0 アイドルでない接続を強制終了するまでの時間(秒)
KEEP_ALIVE True Falseの場合、キープアライブを無効にする。
KEEP_ALIVE_TIMEOUT 5 TCP接続を開いたままにする時間(秒)
MOTD ^ True 起動時にMOTD（今日のメッセージ）を表示するかどうか
MOTD_DISPLAY ^ {} MOTDに任意のデータを追加表示するためのキー/バリュー・ペア
NOISY_EXCEPTIONS ^ False すべての quiet 例外を強制的にログに記録する
PROXIES_COUNT なし アプリの前にあるプロキシサーバーの数(例：nginx)
REAL_IP_HEADER なし 本当のクライアントIPを含む「X-Real-IP」HTTPヘッダーの名前
REGISTER True アプリのレジストリを有効にするかどうか。
REQUEST_BUFFER_SIZE 65536 リクエストが一時停止するまでのリクエストバッファサイズ、デフォルトは64Kib
REQUEST_ID_HEADER X-Request-ID リクエスト/相関 ID を含む HTTP ヘッダー "X-Request-ID" の名前
REQUEST_MAX_SIZE 100000000 リクエストの大きさ (バイト)、デフォルトは100メガバイトです。
REQUEST_MAX_HEADER_SIZE 8192 Request要求ヘッダ最大バイト数(最大16384バイト)です。
REQUEST_TIMEOUT 60 リクエストが到着するまでの時間(秒)です。
RESPONSE_TIMEOUT 60 レスポンス処理にかかる時間(秒)です。
USE_UVLOOP True ループポリシーをオーバーライドして uvloop を使用するかどうかを指定します。app.runでのみサポートされる。
WEBSOCKET_MAX_SIZE 2^20 受信メッセージの最大サイズ (バイト)
WEBSOCKET_PING_INTERVAL 20 Pingフレームはping_interval秒ごとに送信されます。
WEBSOCKET_PING_TIMEOUT 20 ping_timeout秒後にPongを受信しない場合、接続を終了します。

NEW in v21.12

新要素: AUTO_EXTEND, MOTD, MOTD_DISPLAY, NOISY_EXCEPTIONS

FYI

  • USE_UVLOOP の値は、Gunicorn で実行されている場合、無視されます。サポートされていないプラットフォーム (Windows) では、デフォルトは False である。
  • ASGI モードでは WEBSOCKET_ 値は無視されます。

# タイムアウト

# リクエストタイムアウト

要求タイムアウトは、新しいオープンTCP接続がSanicバックエンドサーバーに渡された瞬間と、HTTP要求全体を受信した瞬間の間の時間を測定します。もし時間が REQUEST_TIMEOUT 値（秒）を超えたら、これはクライアントエラーとみなされ、Sanicは HTTP 408 応答を生成してクライアントに送信する。クライアントが日常的に非常に大きなリクエストペイロードを渡したり、リクエストを非常にゆっくりとアップロードする場合は、このパラメータの値を高く設定してください。

# 応答タイムアウト

レスポンスタイムアウトは、SanicサーバーがSanicアプリにHTTPリクエストを渡した瞬間から、HTTPレスポンスがクライアントに送信されるまでの時間を測定します。時間が RESPONSE_TIMEOUT 値 (秒) を超えると、サーバーエラーと見なされるため、Sanic は HTTP 503 応答を生成してクライアントに送信します。レスポンスの生成を遅らせるような長時間稼働のプロセスがあるようなアプリケーションでは、このパラメータの値を高く設定してください。

# キープアライブタイムアウト

# Keep Alive とは何ですか？また、キープアライブタイムアウトの値は何をするのでしょうか？

キープアライブとは、HTTP 1.1 で導入された HTTP の機能です。HTTPリクエストを送信するとき、クライアント(通常はウェブブラウザアプリケーション)は Keep-Alive ヘッダを設定して、HTTPサーバ(Sanic)が応答を送信した後もTCP接続を閉じないように指示することができます。これにより、クライアントは後続のHTTPリクエストを送信するために既存のTCP接続を再利用することができ、クライアントとサーバーの両方にとってより効率的なネットワークトラフィックを確保することができます。

Sanicでは、KEEP_ALIVE設定変数がデフォルトで True に設定されています。アプリケーションでこの機能を必要としない場合は、Falseに設定すると、リクエストの Keep-Alive ヘッダに関係なく、レスポンスが送信された後にすべてのクライアント接続を直ちに終了するようになります。

サーバーが TCP 接続を開いたままにする時間は、サーバー自身が決定します。Sanic では、その値は KEEP_ALIVE_TIMEOUT 値を使用して設定されます。デフォルトでは、5秒に設定されています。これは Apache HTTP サーバーと同じデフォルト設定で、クライアントが新しいリクエストを送信するのに十分な時間を与えることと、一度に多くのコネクションをオープンしないことのバランスが取れています。クライアントが、その時間だけ開いたままの TCP 接続をサポートするブラウザを使用していることが分かっている場合を除き、75 秒を超えないようにしてください。

参考までに

  • Apache httpd サーバーのデフォルトのキープアライブタイムアウト = 5 秒
  • Nginxサーバのデフォルトのキープアライブタイムアウトは75秒です。
  • Nginx パフォーマンスチューニングガイドラインでは、keepalive = 15 秒を使用しています。
  • IE（5-9）クライアントのハードキープアライブ制限 = 60秒
  • Firefoxクライアントハードキープアライブ制限=115秒
  • Opera 11クライアントハードキープアライブ制限 = 120秒
  • Chrome 13+のクライアントキープアライブ制限 > 300秒以上

# プロキシ設定

プロキシ設定の項](/guide/advanced/proxy-headers.md)を参照してください。

← Development →

MIT Licensed
Copyright © 2018-present Sanic Community Organization

~ Made with ❤️ and ☕️ ~