プロジェクトレイアウト—フラスコのドキュメント

提供:Dev Guides
< FlaskFlask/docs/1.0.x/tutorial/layout
移動先:案内検索

プロジェクトのレイアウト

プロジェクトディレクトリを作成し、次のように入力します。

mkdir flask-tutorial
cd flask-tutorial

次に、インストール手順に従ってPython仮想環境をセットアップし、プロジェクトにFlaskをインストールします。

チュートリアルでは、これからflask-tutorialディレクトリから作業していることを前提としています。 各コードブロックの上部にあるファイル名は、このディレクトリに関連しています。



Flaskアプリケーションは、単一のファイルと同じくらい単純にすることができます。

hello.py

from flask import Flask

app = Flask(__name__)


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

ただし、プロジェクトが大きくなると、すべてのコードを1つのファイルに保持するのは大変な作業になります。 Pythonプロジェクトは、パッケージを使用して、必要に応じてインポートできる複数のモジュールにコードを編成します。チュートリアルでもこれを行います。

プロジェクトディレクトリには次のものが含まれます。

  • flaskr/、アプリケーションコードとファイルを含むPythonパッケージ。
  • tests/、テストモジュールを含むディレクトリ。
  • venv/、Flaskおよびその他の依存関係がインストールされているPython仮想環境。
  • プロジェクトのインストール方法をPythonに指示するインストールファイル。
  • git などのバージョン管理構成。 サイズに関係なく、すべてのプロジェクトに何らかのバージョン管理を使用する習慣をつける必要があります。
  • 将来追加する可能性のあるその他のプロジェクトファイル。

最終的に、プロジェクトのレイアウトは次のようになります。

/home/user/Projects/flask-tutorial
├── flaskr/
│   ├── __init__.py
│   ├── db.py
│   ├── schema.sql
│   ├── auth.py
│   ├── blog.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/
│       └── style.css
├── tests/
│   ├── conftest.py
│   ├── data.sql
│   ├── test_factory.py
│   ├── test_db.py
│   ├── test_auth.py
│   └── test_blog.py
├── venv/
├── setup.py
└── MANIFEST.in

バージョン管理を使用している場合、プロジェクトの実行中に生成される次のファイルは無視する必要があります。 使用するエディターに基づいて、他のファイルが存在する場合があります。 一般に、自分が作成しなかったファイルは無視してください。 たとえば、gitの場合:

.gitignore

venv/

*.pyc
__pycache__/

instance/

.pytest_cache/
.coverage
htmlcov/

dist/
build/
*.egg-info/

アプリケーションのセットアップに進みます。