Flaskへようこそ Welcome to Flask

Flaskのドキュメントへようこそ。インストールから始めて、それからクイックスタートで概要をつかみましょう。より詳細なチュートリアルでは、小さいけれども完成しているFlaskアプリケーションをどのように作成するか示しています。Flaskのパターンセクションでは一般的なパターンを記述しています。この文書のその他の部分ではFlaskの各コンポーネントについて詳細を記述しており、その完全なリファレンスはAPIセクションにあります。 Welcome to Flask's documentation. Get started with :doc:`installation` and then get an overview with the :doc:`quickstart`. There is also a more detailed :doc:`tutorial/index` that shows how to create a small but complete application with Flask. Common patterns are described in the :doc:`patterns/index` section. The rest of the docs describe each component of Flask in detail, with a full reference in the :doc:`api` section.

FlaskはテンプレートエンジンJinjaとWSGIツールキットWerkzeugを必要とします。それらのライブラリのドキュメントはこちらです： Flask depends on the `Jinja`_ template engine and the `Werkzeug`_ WSGI toolkit. The documentation for these libraries can be found at:

• Jinjaドキュメント `Jinja documentation <https://jinja.palletsprojects.com/>`_

• Werkzeugドキュメント `Werkzeug documentation <https://werkzeug.palletsprojects.com/>`_

ユーザーガイド User's Guide

ドキュメントのこのパートでは、大部分は散文的な形になっていますが、Flaskの背景となる情報から始めて、それからFlaskを使ったweb開発を一歩ずつ示すことに注力します。 This part of the documentation, which is mostly prose, begins with some background information about Flask, then focuses on step-by-step instructions for web development with Flask.

• 序文
  • 「micro」の意味するところ
  • 設定および規約（Configuration and Conventions）
  • Flaskを使った拡大（Growing with Flask）
• 経験のあるプログラマー向けの序文
  • Flaskでのスレッド局所的領域（Thread-Locals）
  • Web向けの注意深い開発
• インストール
  • Pythonのバージョン
  • 依存対象
  • 仮想環境（Virtual environments）
  • Flaskのインストール
• クイックスタート
  • 最少のアプリケーション
  • サーバがスタートしない場合にするべきこと
  • デバッグモード
  • HTMLのエスケープ処理
  • 経路設定（Routing）
  • 静的ファイル
  • テンプレートの変換（Rendering）
  • リクエストデータへのアクセス
  • 転送（Redirects）とエラー
  • レスポンスについて
  • セッション
  • メッセージのフラッシュ表示
  • ログ機能（Logging）
  • WSGIミドルウェア内でのフック
  • Flask拡張の使用
  • webサーバへのデプロイ
• チュートリアル
  • プロジェクトのレイアウト
  • アプリケーションの用意（Application Setup）
  • データベースの定義とアクセス
  • 青写真とビュー（Blueprints and Views）
  • テンプレート
  • 静的ファイル
  • ブログの青写真（Blog Blueprint）
  • インストール可能なプロジェクト（Make the Project Installable）
  • テストの網羅率（Test Coverage）
  • 本番環境への展開（Deploy to Production）
  • 開発を続けましょう！
• テンプレート
  • Jinjaの準備
  • 標準のコンテキスト（Standard Context）
  • 自動エスケープの制御（Controlling Autoescaping）
  • フィルタの登録
  • コンテキスト処理装置（Context Processors）
• Flaskアプリケーションのテスト
  • アプリケーション
  • テストの骨組（The Testing Skeleton）
  • 最初のテスト
  • ログインとログアウト
  • メッセージ追加のテスト
  • その他のテスト用のしかけ（Other Tesing Tricks）
  • リソースおよびコンテキストの模倣（Faking Resources and Context）
  • コンテキストの保持（Keeping the Context Around）
  • セッションに対するアクセスと変更
  • JSON APIのテスト（Testing JSON APIs）
  • CLIコマンドのテスト（Testing CLI Commands）
• アプリケーションのエラーの処理
  • エラーログ処理ツール
  • エラー処理器（Error Handlers）
  • カスタマイズしたエラーページ
  • ブループリントのエラー処理器（Blueprint Error Handlers）
  • JSONでのAPIエラーの応答（Returning API Errors as JSON）
  • ログ処理（Logging）
  • デバッグ処理（Debugging）
• アプリケーション・エラーのデバッグ
  • 本番環境上
  • 組み込みのデバッガ
  • 外部デバッガ
• ログ処理（Logging）
  • 基本設定（Basic Configuration）
  • 管理者へのエラーのメール送信
  • リクエストの情報の注入
  • 他のライブラリ
• 設定の処理の仕方（Configuration Handling）
  • 設定の基本
  • environmentとdebugの目玉機能（Environment and Debug Features）
  • 組込みの設定値
  • Pythonファイルからの設定の読み取り（Configuring from Python Files）
  • データファイルからの設定の読み取り（Configuring from Data Files）
  • 環境変数からの設定の読み取り（Configuring from Environment Variables）
  • 設定のベストプラクティス
  • 開発環境 / 本番環境
  • インスタンスフォルダ
• 合図（Signals）
  • signalへの登録（Subscribing to Signals）
  • signalの作成
  • signalの送信
  • signalとFlaskのrequest context
  • decoratorに基づくsignal登録
  • 基本signal（Core Signals）
• 差し込み可能なview（Pluggable Views）
  • 基本原理（Basic Principle）
  • メソッドの暗示（Method Hints）
  • メソッドに基づいた割り振り（Method Based Dispatching）
  • viewの修飾（Decorating Views）
  • API用のメソッドのview
• アプリケーションのコンテキスト（The Application Context）
  • コンテキストの目的（Purpose of the Context）
  • コンテキストの生存期間（Lifetime of the Context）
  • 手作業でのコンテキストの登録（Manually Push a Context）
  • データの格納
  • 出来事と合図（Events and Signals）
• リクエストのコンテキスト（The Request Context）
  • コンテキストの目的（Purpose of the Context）
  • コンテキストの生存期間（Lifetime of the Context）
  • 手作業でのコンテキストの登録（Manually Push a Context）
  • コンテキストの働きかた（How the Context Works）
  • コールバックとエラー
  • エラー時のcontextの保持（Context Preservation on Error）
  • プロキシに関する注意事項（Notes On Proxies）
• Blueprintを使ったアプリケーションのモジュール化
  • なぜBlueprintsか？
  • Blueprintのコンセプト
  • 最初のBlueprint
  • Blueprintの登録
  • 入れ子にしたBlueprint（Nesting Blueprints）
  • Blueprintのリソース
  • URLの構築
  • ブループリントのエラー処理（Blueprint Error Handlers）
• Flask拡張（Extensions）
  • Flask拡張の探し出し
  • Flask拡張の使用方法
  • Flask拡張の構築
• コマンドライン・インタフェース
  • アプリケーションの発見（Application Discovery）
  • 開発用サーバの実行
  • シェルの開始（Open a Shell）
  • 環境（Environments）
  • デバッグモード
  • dotenvからの環境変数読み込み
  • virtualenvからの環境変数読み込み
  • 独自のコマンド（Custom Commands）
  • プラグイン
  • 独自のスクリプト
  • PyCharmとの統合
• 開発サーバ
  • コマンドライン
  • コードの中
• Shellを使った作業
  • コマンドライン・インタフェース
  • リクエストのコンテキストの作成（Creating a Request Context）
  • リクエスト前後の処理の起動（Firing Before/After Request）
  • Shellでの経験のさらなる改善
• Flaskのパターン
  • パッケージにした大きなアプリケーション（Large Applications as Packages）
  • アプリケーション製造工場（Application Factories）
  • アプリケーションの振り分け（Application Dispatching）
  • Using URL Processors
  • Setuptoolsを使った展開（Deploying with Setuptools）
  • Deploying with Fabric
  • FlaskでのSQLite 3の使用
  • Flask内でのSQLAlchemy（SQLAlchemy in Flask）
  • ファイルのアップロード
  • キャッシング
  • View Decorators
  • WTFormsを使ったフォーム検証
  • テンプレートの継承
  • メッセージのフラッシュ表示（Message Flashing）
  • AJAX with jQuery
  • Lazily Loading Views
  • MongoDB with MongoEngine
  • Adding a favicon
  • Streaming Contents
  • Deferred Request Callbacks
  • Adding HTTP Method Overrides
  • Request Content Checksums
  • Celery Background Tasks
  • Flaskのサブクラス化
  • Single-Page Applications
• 展開の選択肢（Deployment Options）
  • ホストされる場合の選択肢（Hosted Options）
  • 自分のサーバでホストするときの選択肢（Self-hosted options）
• 巨大化（Becoming Big）
  • ソースの読み込み
  • フック。Flask拡張。
  • サブクラス
  • ミドルウェアを使った包み込み（Wrap with middleware）
  • フォーク
  • プロのような規模変更（Scale like a pro）
  • コミュニティを使った議論
• Using async and await
  • Performance
  • Background tasks
  • When to use Quart instead
  • Extensions
  • Other event loops

APIリファレンス API Reference

もしも特定の関数、クラス、またはメソッドの情報を探している場合は、このパートが対応します。 If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • Application Object
  • Blueprint Objects
  • Incoming Request Data
  • Response Objects
  • Sessions
  • Session Interface
  • Test Client
  • Test CLI Runner
  • Application Globals
  • Useful Functions and Classes
  • Message Flashing
  • JSON Support
  • Template Rendering
  • Configuration
  • Stream Helpers
  • Useful Internals
  • Signals
  • Class-Based Views
  • URL Route Registrations
  • View Function Options
  • Command Line Interface

追記事項 Additional Notes

関心のある人向けの、設計上の注記、法律関連の情報、そしてchangelogはここです。 Design notes, legal information and changelog are here for the interested.

• Design Decisions in Flask
  • The Explicit Application Object
  • The Routing System
  • One Template Engine
  • Micro with Dependencies
  • Thread Locals
  • Async/await and ASGI support
  • What Flask is, What Flask is Not
• HTML/XHTML FAQ
  • History of XHTML
  • History of HTML5
  • HTML versus XHTML
  • What does "strict" mean?
  • New technologies in HTML5
  • What should be used?
• セキュリティの考慮点
  • クロスサイトスクリプティング（Cross-Site Scripting）（XSS）
  • クロスサイトリクエストフォージェリ（Cross-Site Request Forgery）（CSRF）
  • JSONのセキュリティ
  • セキュリティに関するヘッダ
  • Copy/Paste to Terminal
• Flask拡張の開発
  • Flask拡張の解剖（Anatomy of an Extension）
  • "Hello Flaskext!"
  • Flask拡張の初期処理（Initializing Extensions）
  • Flask拡張のコード
  • _app_ctx_stackの使用
  • 他から学習しましょう
  • 承認されたFlask拡張（Approved Extensions）
• How to contribute to Flask
  • Support questions
  • Reporting issues
  • Submitting patches
• License
  • BSD-3-Clause Source License
  • Artwork License
• Changes
  • Version 2.0.1
  • Version 2.0.0
  • Version 1.1.4
  • Version 1.1.3
  • Version 1.1.2
  • Version 1.1.1
  • Version 1.1.0
  • Version 1.0.4
  • Version 1.0.3
  • Version 1.0.2
  • Version 1.0.1
  • Version 1.0
  • Version 0.12.5
  • Version 0.12.4
  • Version 0.12.3
  • Version 0.12.2
  • Version 0.12.1
  • Version 0.12
  • Version 0.11.1
  • Version 0.11
  • Version 0.10.1
  • Version 0.10
  • Version 0.9
  • Version 0.8.1
  • Version 0.8
  • Version 0.7.2
  • Version 0.7.1
  • Version 0.7
  • Version 0.6.1
  • Version 0.6
  • Version 0.5.2
  • Version 0.5.1
  • Version 0.5
  • Version 0.4
  • Version 0.3.1
  • Version 0.3
  • Version 0.2
  • Version 0.1