github/gitignore · Python.gitignore
Python .gitignore テンプレート解説
Python.gitignore が __pycache__、仮想環境、パッケージング成果物、テスト・型チェックのキャッシュ、秘密の設定を無視する理由と、lib/・lockfile に関する注意点を説明します。
Python.gitignore は、純粋な Python プロジェクトから Django・Flask の Web アプリ、データサイエンス、パッケージ配布まで幅広く使えるように作られた大きなテンプレートである。バイトコードキャッシュ、仮想環境、setup.py/ビルドバックエンドが作るパッケージングフォルダー、pytest・mypy・ruff などのツールのキャッシュを 1 か所にまとめている。
ルールが多い分、意図せず一致するパスもある。特に lib/、build/、dist/、target/ のようなよくある名前のディレクトリを深さに関係なく無視するため、他の言語と混在するリポジトリでは結果を一度テストしておくとよい。
ルール別の解説
| パターン | 何を、なぜ無視するか |
|---|---|
__pycache__/*.py[codz]*$py.class*.so | バイトコード・拡張モジュールインタープリターが import 時に作る .pyc キャッシュと、C 拡張をビルドした共有ライブラリである。*.py[codz] は .pyc・.pyo・.pyd・.pyz を一度に捉えるブラケットパターンである。いずれもソースから再作成される。 |
build/dist/*.egg-info/*.eggwheels/sdist/MANIFEST | パッケージング成果物python -m build や setuptools が作る配布ファイルとメタデータである。配布物は PyPI などのリポジトリにアップロードするものであり、ソースリポジトリに入れる対象ではない。 |
.venvvenv/env/ENV/__pypackages__/ | 仮想環境インタープリターのパスが埋め込まれているため別のコンピューターに移すと動作せず、容量も大きい。依存関係は requirements.txt や pyproject.toml と lockfile で共有する。 |
.pytest_cache/.tox/.nox/.coveragehtmlcov/coverage.xml.hypothesis/ | テスト・カバレッジキャッシュテストランナーとカバレッジツールが残す結果とキャッシュである。実行するたびに変わるため、CI の成果物としてのみ扱う。 |
.mypy_cache/.pyre/.pytype/.ruff_cache/ | 型チェック・リンターキャッシュ静的解析を高速化するためのローカルキャッシュで、削除しても次回の実行で再作成される。 |
local_settings.pydb.sqlite3instance/.webassets-cachecelerybeat-schedule* | フレームワークのローカルデータDjango のローカル設定と開発用 SQLite DB、Flask の instance/ フォルダー、Celery beat のスケジュールファイルである。開発者ごとに内容が異なり、秘密の値が入りやすい。 |
.env.envrc.pypirc.streamlit/secrets.toml | 秘密情報環境変数ファイル、direnv の設定、PyPI アップロードトークンが入る .pypirc、Streamlit の秘密設定である。一度コミットすると履歴に残るため、最初から除外する。 |
.ipynb_checkpointsprofile_default/ipython_config.py/sitedocs/_build/ | ノートブック・その他のツールJupyter のチェックポイント、IPython プロファイル、mkdocs(/site)と Sphinx(docs/_build/)のビルド結果である。/site は先頭に / があるため、リポジトリルートの site だけを指す。 |
実務での注意点
lib/・lib64/ルールはあらゆる深さのlibディレクトリを無視する。フロントエンドのコードがsrc/lib/にあるなら、ルールを/lib/に変えるか!src/lib/を追加する。- テンプレートは
poetry.lock、uv.lock、pdm.lock、Pipfile.lockにコメントで触れているだけで無視はしない。アプリケーションなら再現可能なインストールのためにコミットするのが一般的である。 .venvは末尾に/がないため、同名のファイル(例: 仮想環境のパスを書いたツール設定ファイル)も無視される点を覚えておく。- Jupyter ノートブックの実行結果(出力セル)は gitignore では防げない。出力を消してからコミットするには nbstripout のようなツールを使う。
元のテンプレート
Python.gitignore
# Byte-compiled / optimized / DLL files__pycache__/*.py[codz]*$py.class# C extensions*.so# Distribution / packaging.Pythonbuild/develop-eggs/dist/downloads/eggs/.eggs/lib/lib64/parts/sdist/var/wheels/share/python-wheels/*.egg-info/.installed.cfg*.eggMANIFEST# PyInstaller# Usually these files are written by a python script from a template# before PyInstaller builds the exe, so as to inject date/other infos into it.*.manifest*.spec# Installer logspip-log.txtpip-delete-this-directory.txt# Unit test / coverage reportshtmlcov/.tox/.nox/.coverage.coverage.*.cachenosetests.xmlcoverage.xml*.cover*.py.cover*.lcov.hypothesis/.pytest_cache/cover/# Translations*.mo*.pot# Django stuff:*.loglocal_settings.pydb.sqlite3db.sqlite3-journal# Flask stuff:instance/.webassets-cache# Scrapy stuff:.scrapy# Sphinx documentationdocs/_build/# PyBuilder.pybuilder/target/# Jupyter Notebook.ipynb_checkpoints# IPythonprofile_default/ipython_config.py# pyenv# For a library or package, you might want to ignore these files since the code is# intended to run in multiple environments; otherwise, check them in:# .python-version# pipenv# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.# However, in case of collaboration, if having platform-specific dependencies or dependencies# having no cross-platform support, pipenv may install dependencies that don't work, or not# install all needed dependencies.# Pipfile.lock# UV# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.# This is especially recommended for binary packages to ensure reproducibility, and is more# commonly ignored for libraries.# uv.lock# poetry# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.# This is especially recommended for binary packages to ensure reproducibility, and is more# commonly ignored for libraries.# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control# poetry.lock# poetry.toml# pdm# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.# https://pdm-project.org/en/latest/usage/project/#working-with-version-control# pdm.lock# pdm.toml.pdm-python.pdm-build/# pixi# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.# pixi.lock# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one# in the .venv directory. It is recommended not to include this directory in version control..pixi/*!.pixi/config.toml# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm__pypackages__/# Celery stuffcelerybeat-schedule*celerybeat.pid# Redis*.rdb*.aof*.pid# RabbitMQmnesia/rabbitmq/rabbitmq-data/# ActiveMQactivemq-data/# SageMath parsed files*.sage.py# Environments.env.envrc.venvenv/venv/ENV/env.bak/venv.bak/# Spyder project settings.spyderproject.spyproject# Rope project settings.ropeproject# mkdocs documentation/site# mypy.mypy_cache/.dmypy.jsondmypy.json# Pyre type checker.pyre/# pytype static type analyzer.pytype/# Cython debug symbolscython_debug/# PyCharm# JetBrains specific template is maintained in a separate JetBrains.gitignore that can# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore# and can be added to the global gitignore or merged into this file. For a more nuclear# option (not recommended) you can uncomment the following to ignore the entire idea folder.# .idea/# Abstra# Abstra is an AI-powered process automation framework.# Ignore directories containing user credentials, local state, and settings.# Learn more at https://abstra.io/docs.abstra/# Visual Studio Code# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that# can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore# and can be added to the global gitignore or merged into this file. However, if you prefer, you# could uncomment the following to ignore the entire vscode folder# .vscode/# Temporary file for partial code executiontempCodeRunnerFile.py# Ruff stuff:.ruff_cache/# PyPI configuration file.pypirc# Marimomarimo/_static/marimo/_lsp/__marimo__/# Streamlit.streamlit/secrets.toml
テンプレートの出典: github/gitignore/Python.gitignore @356fd7b (2026-09-11) · CC0-1.0