開発・デバッグ・デプロイ
開発方針
本フレームワークは、まず CGI で素早く動くものを作り、必要に応じて Flask へ移植する戦略を取る。
推奨ディレクトリ構成
app_root/
myapp.py
templates/
index.html
static/
data/
log/
config/
基本的な開発手順
tkCGIApplicationを用いて最小ページまたは JSON API を作る。CLI でも呼べるよう、最低限の引数処理またはテストコードを置く。
ログ出力を有効にする。
HTML と JSON の応答パターンを固定する。
複雑な業務ロジックは関数へ切り出す。
デバッグ方針
例外は HTML に表示されるため、初期段階では原因の追跡が容易
ログファイルを明示的に設定する
ルート関数の入出力を小さく保つ
CGI 依存部分と計算ロジック部分を分離する
デプロイ方針
CGI 配置できるサーバに単体スクリプトとして置く
templatesとstaticを近傍に配置するログやアカウント情報は公開ディレクトリ外に置く
将来の Flask 移行を想定し、ビジネスロジックを外部関数化する
ドキュメント更新方針
ルート追加時は API 仕様に追記する
セキュリティ機能追加時は
security.rstを更新するFlask 移植用の差分は
migration_to_flask.rstに蓄積する