Flaskへようこそ

Warning

このドキュメントは flask を翻訳したものです。 翻訳の間違いなどの指摘は、Issues に登録して頂けるとうれしいです。

Flaskのドキュメントにようこそ。このドキュメントはいくつかのパートにわかれています。 Installation から始めて、 Quickstart へ進むことをお勧めします。 クイックスタートの他にも、Flaskで作られた小さなアプリケーションの作り方を載せている、より詳細な Tutorial もあります。 Flaskの内部まで踏み込みたい場合は API ドキュメントをチェックしてください。 一般的なパターンについては、 Patterns for Flask の章で後述しています。

Flaskは Jinja2 テンプレートエンジンと Werkzeug WSGIツールキットの2つの外部ライブラリに依存しています。 これらのライブラリはここではドキュメントにしていません。これらのライブラリのドキュメントを見たい場合は以下のリンクをチェックして下さい。

• Jinja2 ドキュメント
• Werkzeug ドキュメント

User’s Guide

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.

• Foreword
  • What does “micro” mean?
  • Configuration and Conventions
  • Growing with Flask
• Foreword for Experienced Programmers
  • Thread-Locals in Flask
  • Develop for the Web with Caution
  • Python 3 Support in Flask
• Installation
  • Python Version
  • Dependencies
  • Virtual environments
  • Install Flask
  • Install virtualenv
• Quickstart
  • A Minimal Application
  • What to do if the Server does not Start
  • Debug Mode
  • Routing
  • Static Files
  • Rendering Templates
  • Accessing Request Data
  • Redirects and Errors
  • About Responses
  • Sessions
  • Message Flashing
  • Logging
  • Hooking in WSGI Middlewares
  • Using Flask Extensions
  • Deploying to a Web Server
• Tutorial
  • Introducing Flaskr
  • Step 0: Creating The Folders
  • Step 1: Database Schema
  • Step 2: Application Setup Code
  • Step 3: Installing flaskr as a Package
  • Step 4: Database Connections
  • Step 5: Creating The Database
  • Step 6: The View Functions
  • Step 7: The Templates
  • Step 8: Adding Style
  • Bonus: Testing the Application
• Templates
  • Jinja Setup
  • Standard Context
  • Standard Filters
  • Controlling Autoescaping
  • Registering Filters
  • Context Processors
• Testing Flask Applications
  • The Application
  • The Testing Skeleton
  • The First Test
  • Logging In and Out
  • Test Adding Messages
  • Other Testing Tricks
  • Faking Resources and Context
  • Keeping the Context Around
  • Accessing and Modifying Sessions
• Application Errors
  • Error Logging Tools
  • Error handlers
  • Error Mails
  • Logging to a File
  • Controlling the Log Format
  • Other Libraries
• Debugging Application Errors
  • When in Doubt, Run Manually
  • Working with Debuggers
• Configuration Handling
  • Configuration Basics
  • Builtin Configuration Values
  • Configuring from Files
  • Configuration Best Practices
  • Development / Production
  • Instance Folders
• Signals
  • Subscribing to Signals
  • Creating Signals
  • Sending Signals
  • Signals and Flask’s Request Context
  • Decorator Based Signal Subscriptions
  • Core Signals
• Pluggable Views
  • Basic Principle
  • Method Hints
  • Method Based Dispatching
  • Decorating Views
  • Method Views for APIs
• The Application Context
  • Purpose of the Application Context
  • Creating an Application Context
  • Locality of the Context
  • Context Usage
• The Request Context
  • Diving into Context Locals
  • How the Context Works
  • Callbacks and Errors
  • Teardown Callbacks
  • Notes On Proxies
  • Context Preservation on Error
• Modular Applications with Blueprints
  • Why Blueprints?
  • The Concept of Blueprints
  • My First Blueprint
  • Registering Blueprints
  • Blueprint Resources
  • Building URLs
  • Error Handlers
• Flask Extensions
  • Finding Extensions
  • Using Extensions
  • Building Extensions
  • Flask Before 0.8
• Command Line Interface
  • Basic Usage
  • Virtualenv Integration
  • Debug Flag
  • Running a Shell
  • Custom Commands
  • Application Context
  • Factory Functions
  • Custom Scripts
  • CLI Plugins
• Development Server
  • Command Line
  • In Code
• Working with the Shell
  • Command Line Interface
  • Creating a Request Context
  • Firing Before/After Request
  • Further Improving the Shell Experience
• Patterns for Flask
  • Larger Applications
  • Application Factories
  • Application Dispatching
  • Implementing API Exceptions
  • Using URL Processors
  • Deploying with Setuptools
  • Deploying with Fabric
  • Using SQLite 3 with Flask
  • SQLAlchemy in Flask
  • Uploading Files
  • Caching
  • View Decorators
  • Form Validation with WTForms
  • Template Inheritance
  • Message Flashing
  • AJAX with jQuery
  • Custom Error Pages
  • Lazily Loading Views
  • MongoKit in Flask
  • Adding a favicon
  • Streaming Contents
  • Deferred Request Callbacks
  • Adding HTTP Method Overrides
  • Request Content Checksums
  • Celery Background Tasks
  • Subclassing Flask
• Deployment Options
  • Hosted options
  • Self-hosted options
• Becoming Big
  • Read the Source.
  • Hook. Extend.
  • Subclass.
  • Wrap with middleware.
  • Fork.
  • Scale like a pro.
  • Discuss with the community.

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
  • Application Globals
  • Useful Functions and Classes
  • Message Flashing
  • JSON Support
  • Template Rendering
  • Configuration
  • Extensions
  • Stream Helpers
  • Useful Internals
  • Signals
  • Class-Based Views
  • URL Route Registrations
  • View Function Options
  • Command Line Interface

Additional Notes

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
  • 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?
• Security Considerations
  • Cross-Site Scripting (XSS)
  • Cross-Site Request Forgery (CSRF)
  • JSON Security
• Unicode in Flask
  • Automatic Conversion
  • The Golden Rule
  • Encoding and Decoding Yourself
  • Configuring Editors
• Flask Extension Development
  • Anatomy of an Extension
  • “Hello Flaskext!”
  • Initializing Extensions
  • The Extension Code
  • Using _app_ctx_stack
  • Teardown Behavior
  • Learn from Others
  • Approved Extensions
  • Extension Import Transition
• Pocoo Styleguide
  • General Layout
  • Expressions and Statements
  • Naming Conventions
  • Docstrings
  • Comments
• Python 3 Support
• Upgrading to Newer Releases
  • Version 0.12
  • Version 0.11
  • Version 0.10
  • Version 0.9
  • Version 0.8
  • Version 0.7
  • Version 0.6
  • Version 0.5
  • Version 0.4
  • Version 0.3
• Flask Changelog
  • Version 0.13
  • Version 0.12.2
  • Version 0.12.1
  • Version 0.12
  • Version 0.11.2
  • Version 0.11.1
  • Version 0.11
  • Version 0.10.2
  • Version 0.10.1
  • Version 0.10
  • Version 0.9
  • Version 0.8.1
  • Version 0.8
  • Version 0.7.3
  • 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
• License
  • Authors
  • General License Definitions
  • Flask License
  • Flask Artwork License