Flask プロジェクト構造

Flask アプリケーションは、1つのファイルだけというシンプルな構成にすることができます。

例えば、次の hello.py ファイルは 1 つの Flask アプリケーションです。

例

from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'

しかし、プロジェクトが大きくなると、すべてのコードを 1 つのファイルにまとめるのは現実的ではありません。

Flask プロジェクト構造は、アプリケーションの規模や複雑さに応じて異なります。

以下は、単純なアプリケーションとより複雑なアプリケーションにそれぞれ適したいくつかの一般的な Flask プロジェクト構造です。

  1. シンプルなプロジェクト構造:小規模アプリケーションに適しており、すべてのコードが 1 つのファイルに集中しています。
  2. 中規模プロジェクト構造:アプリケーションを複数のモジュールに分割し、管理と拡張を容易にします。
  3. 複雑なプロジェクト構造:より高いモジュール化をサポートし、大規模アプリケーションに適しています。ルート、モデル、テンプレート、静的ファイルディレクトリが含まれます。

1. シンプルなプロジェクト構造

シンプルな Flask アプリケーションの場合、プロジェクト構造は非常に簡潔にできます:

my_flask_app/
│
├── app.py
└── requirements.txt
  • app.py:メインの Flask アプリケーションファイル。ルートとビュー関数の定義が含まれます。
  • requirements.txt:プロジェクトの依存ライブラリを一覧表示し、Flask や他のパッケージのバージョン情報を記録するために使用します。

my_flask_app ディレクトリ内の app.py ファイルのコード:

例

from flask import Flask

app = Flask(__name__)

@app.route('/')
def home():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)

requirements.txt の例:

Flask==2.2.3

2. 中規模プロジェクト構造

少し複雑なアプリケーションの場合、通常はプロジェクトを複数のモジュールとディレクトリに分割します:

my_flask_app/
│
├── app/
│   ├── __init__.py
│   ├── routes.py
│   └── models.py
│
├── config.py
├── requirements.txt
└── run.py
  • app/:Flask アプリケーションの主要なコードが含まれます。
    • __init__.py:Flask アプリケーションを初期化し、拡張機能を構成します。
    • routes.py:アプリケーションのルートとビュー関数を定義します。
    • models.py:アプリケーションのデータモデルを定義します。
  • config.py:設定ファイル。アプリケーションの構成情報が含まれます。
  • requirements.txt:プロジェクトの依存ライブラリを一覧表示します。
  • run.py:Flask アプリケーションを起動するために使用します。

app/__init__.py の例:

例

from flask import Flask

def create_app():
    app = Flask(__name__)
    app.config.from_object('config.Config')

    from . import routes
    app.register_blueprint(routes.bp)

    return app

app/routes.py の例:

例

from flask import Blueprint

bp = Blueprint('main', __name__)

@bp.route('/')
def home():
    return 'Hello, World!'

run.py の例:

例

from app import create_app

app = create_app()

if __name__ == '__main__':
    app.run(debug=True)

3. 複雑なプロジェクト構造

大規模なアプリケーションでは、より高いモジュール化と拡張性をサポートするために、より複雑なプロジェクト構造が必要になる場合があります:

my_flask_app/
│
├── app/
│   ├── __init__.py
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── main.py
│   │   └── auth.py
│   ├── models/
│   │   ├── __init__.py
│   │   └── user.py
│   ├── templates/
│   │   ├── layout.html
│   │   └── home.html
│   └── static/
│       ├── css/
│       └── js/
│
├── config.py
├── requirements.txt
├── migrations/
│   └── ...
└── run.py
  • app/routes/:異なる機能モジュールのルートを分けて管理します。
    • main.py:メインモジュールのルート。
    • auth.py:認証関連のルート。
  • app/models/:データモデルを管理し、通常はデータベース操作に関連します。
    • user.py:ユーザーモデル。
  • app/templates/:HTML テンプレートファイルを格納します。
  • app/static/:CSS や JavaScript などの静的ファイルを格納します。
  • migrations/:データベース移行ファイル。通常は SQLAlchemy に関連します。

app/routes/main.py の例:

例

from flask import Blueprint, render_template

bp = Blueprint('main', __name__)

@bp.route('/')
def home():
    return render_template('home.html')

app/models/user.py の例:

例

from app import db

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(150), unique=True, nullable=False)
その他の拡張機能