【Python入門】プロジェクト構成

Python

VS Code は Python 開発と相性が良く、フォルダー単位でプロジェクトを管理する ことで、とても作業しやすくなります。ここでは、「どこに何を置けばいいのか?」「どんなフォルダ構成が正解なのか?」を解説します。

1.プロジェクトは “フォルダ” から始まる

Python のプロジェクトは まずフォルダを作る ところから始まります。

mkdir my_project
cd my_project
code .

code . を実行すると VS Code が フォルダ全体をプロジェクトとして開く 形になります。

2.仮想環境(venv)を作

プロジェクトごとに Python の環境を分けるため、仮想環境を作成します。

python3 -m venv venv

次に有効化します:

source venv/bin/activate

3.VS Code に仮想環境を認識させる

VS Code の右下に「Python のインタープリタを選択」と表示されます。
「./venv/…/python」 を選択すればOK。
これで VS Code が「このプロジェクトでは venv の Python を使うんだな」と理解します。

4.最小構成のプロジェクト

my_project/
 ├── venv/              (仮想環境)
 ├── main.py            (メインスクリプト)
 ├── requirements.txt    (使ったライブラリ一覧)
 └── README.md           (説明書:任意)

5.main.py の中身を作る

def main():

    print("Hello from VS Code project!")

if __name__ == "__main__":
    main()

VS Code の右上の ボタンを押せば実行できます。

6.プロジェクトが大きくなったら “src 構成”

関数やクラスが増えてくると、ファイルを分けて整理する必要が出てきます。
よく使われるプロの構成:

my_project/
 ├── venv/
 ├── src/ #srcはソースコードの略
 │    └── my_project/
 │         ├── __init__.py
 │         ├── main.py
 │         ├── utils.py
 │         └── models.py
 ├── tests/               (テストコード)
 ├── requirements.txt
 ├── README.md
 └── .vscode/             (VS Code設定:任意)

この構成のメリット:

  • ファイルが整理されて見やすい
  • Python の import が明確になる
  • 将来パッケージ化したいときにそのまま使える
  • VS Code がコードを自動解析しやすい

7.VS Code の便利機能

(1)Ctrl + Shift + P:コマンドパレット

「Python: Select Interpreter」などを実行

(2)F5(または左の虫アイコン)でデバッグ実行

ブレークポイントを置いてコードの中身を見れる

(3)拡張機能(Extensions)

必要なのはこの2つ:

  • Python
  • Pylance

8.requirements.txt の使い方

プロジェクトで使ったライブラリを保存しておくファイル。

pip freeze > requirements.txt

別のPCで動かすときは:

pip install -r requirements.txt

9..gitignore(Gitを使う場合)

Git を使うなら、最低限これを作ります:

venv/
__pycache__/
*.pyc
タイトルとURLをコピーしました