Penjelasan template .gitignore Python
Menjelaskan mengapa Python.gitignore mengabaikan __pycache__, lingkungan virtual, hasil packaging, cache pengujian dan pemeriksaan tipe, serta pengaturan rahasia, dan hal yang perlu diperhatikan terkait lib/ dan lockfile.
Python.gitignore adalah template besar yang dibuat untuk berbagai keperluan, mulai dari proyek Python murni, aplikasi web Django dan Flask, data science, hingga distribusi paket. Template ini mengumpulkan cache bytecode, lingkungan virtual, folder packaging yang dibuat setup.py/backend build, dan cache alat seperti pytest, mypy, dan ruff di satu tempat.
Karena aturannya banyak, ada juga path yang tertangkap tanpa disengaja. Khususnya, direktori dengan nama umum seperti lib/, build/, dist/, dan target/ diabaikan di kedalaman berapa pun, jadi di repositori yang bercampur dengan bahasa lain sebaiknya hasilnya diuji sekali.
Penjelasan per aturan
| Pola | Apa yang diabaikan dan mengapa |
|---|---|
__pycache__/*.py[codz]*$py.class*.so | Bytecode dan modul ekstensiCache .pyc yang dibuat interpreter saat import dan pustaka bersama hasil build ekstensi C. *.py[codz] adalah pola kurung siku yang sekaligus menangkap .pyc, .pyo, .pyd, dan .pyz. Semuanya dibuat ulang dari kode sumber. |
build/dist/*.egg-info/*.eggwheels/sdist/MANIFEST | Hasil packagingFile distribusi dan metadata yang dibuat python -m build atau setuptools. Hasil distribusi diunggah ke registri seperti PyPI, bukan dimasukkan ke repositori sumber. |
.venvvenv/env/ENV/__pypackages__/ | Lingkungan virtualPath interpreter tertanam di dalamnya sehingga tidak berfungsi jika dipindahkan ke komputer lain, dan ukurannya besar. Dependensi dibagikan melalui requirements.txt atau pyproject.toml beserta lockfile. |
.pytest_cache/.tox/.nox/.coveragehtmlcov/coverage.xml.hypothesis/ | Cache pengujian dan coverageHasil dan cache yang ditinggalkan test runner dan alat coverage. Karena berubah setiap kali dijalankan, hanya diperlakukan sebagai artefak CI. |
.mypy_cache/.pyre/.pytype/.ruff_cache/ | Cache pemeriksaan tipe dan linterCache lokal untuk mempercepat analisis statis; jika dihapus akan dibuat lagi pada eksekusi berikutnya. |
local_settings.pydb.sqlite3instance/.webassets-cachecelerybeat-schedule* | Data lokal frameworkPengaturan lokal dan DB SQLite untuk pengembangan milik Django, folder instance/ Flask, dan file jadwal Celery beat. Isinya berbeda untuk setiap pengembang dan mudah tercampur nilai rahasia. |
.env.envrc.pypirc.streamlit/secrets.toml | Informasi rahasiaFile variabel lingkungan, pengaturan direnv, .pypirc yang berisi token unggah PyPI, dan pengaturan rahasia Streamlit. Sekali di-commit akan tertinggal di riwayat, jadi dikecualikan sejak awal. |
.ipynb_checkpointsprofile_default/ipython_config.py/sitedocs/_build/ | Notebook dan alat lainCheckpoint Jupyter, profil IPython, serta hasil build mkdocs (/site) dan Sphinx (docs/_build/). /site diawali / sehingga hanya menunjuk site di root repositori. |
Hal yang perlu diperhatikan dalam praktik
- Aturan
lib/danlib64/mengabaikan direktorilibdi kedalaman berapa pun. Jika kode frontend ada disrc/lib/, ubah aturannya menjadi/lib/atau tambahkan!src/lib/. - Template hanya menyebut
poetry.lock,uv.lock,pdm.lock, danPipfile.lockdalam komentar dan tidak mengabaikannya. Untuk aplikasi, file ini umumnya di-commit demi instalasi yang dapat direproduksi. - Ingat bahwa
.venvtidak memiliki/di akhir, sehingga file dengan nama yang sama (misalnya file konfigurasi alat yang mencatat path lingkungan virtual) juga ikut diabaikan. - Hasil eksekusi notebook Jupyter (sel output) tidak bisa dicegah dengan gitignore. Untuk meng-commit tanpa output, gunakan alat seperti nbstripout.
Template asli
# 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
Sumber template: github/gitignore/Python.gitignore @356fd7b (2026-09-11) · CC0-1.0