github/gitignore · Python.gitignore
Template .gitignore do Python explicado
Explica por que o Python.gitignore ignora __pycache__, ambientes virtuais, artefatos de empacotamento, caches de testes e de checagem de tipos e configurações secretas, e os cuidados com lib/ e lockfiles.
O Python.gitignore é um template grande feito para todo tipo de uso: de projetos em Python puro a aplicações web com Django ou Flask, ciência de dados e distribuição de pacotes. Reúne em um só lugar o cache de bytecode, os ambientes virtuais, as pastas de empacotamento criadas pelo setup.py e pelos backends de build, e os caches de ferramentas como pytest, mypy e ruff.
Com tantas regras, alguns caminhos acabam pegos sem querer. Em especial, ele ignora em qualquer profundidade diretórios com nomes comuns como lib/, build/, dist/ e target/, então, em repositórios misturados com outras linguagens, vale testar o resultado uma vez.
Explicação regra por regra
| Padrão | O que ignora e por quê |
|---|---|
__pycache__/*.py[codz]*$py.class*.so | Bytecode e módulos de extensãoSão o cache .pyc que o interpretador cria ao importar e as bibliotecas compartilhadas compiladas a partir de extensões em C. *.py[codz] é um padrão com colchetes que pega .pyc, .pyo, .pyd e .pyz de uma vez. Tudo é recriado a partir do código-fonte. |
build/dist/*.egg-info/*.eggwheels/sdist/MANIFEST | Artefatos de empacotamentoSão os arquivos de distribuição e metadados gerados por python -m build ou pelo setuptools. Os resultados de distribuição são enviados a registros como o PyPI; não são algo para colocar no repositório de código. |
.venvvenv/env/ENV/__pypackages__/ | Ambientes virtuaisTêm o caminho do interpretador gravado, então não funcionam se forem levados para outro computador, e ainda ocupam muito espaço. As dependências são compartilhadas com requirements.txt ou pyproject.toml e um lockfile. |
.pytest_cache/.tox/.nox/.coveragehtmlcov/coverage.xml.hypothesis/ | Caches de testes e coberturaSão resultados e caches deixados pelos executores de testes e pelas ferramentas de cobertura. Mudam a cada execução, então são tratados apenas como artefatos de CI. |
.mypy_cache/.pyre/.pytype/.ruff_cache/ | Caches de checagem de tipos e lintersSão caches locais para acelerar a análise estática; se apagados, são recriados na próxima execução. |
local_settings.pydb.sqlite3instance/.webassets-cachecelerybeat-schedule* | Dados locais de frameworksSão a configuração local e o banco SQLite de desenvolvimento do Django, a pasta instance/ do Flask e o arquivo de agendamento do Celery beat. O conteúdo varia de desenvolvedor para desenvolvedor e é fácil que acabem contendo valores secretos. |
.env.envrc.pypirc.streamlit/secrets.toml | Informações secretasSão os arquivos de variáveis de ambiente, a configuração do direnv, o .pypirc com o token de upload do PyPI e os segredos do Streamlit. Uma vez commitados, ficam no histórico, então são excluídos desde o início. |
.ipynb_checkpointsprofile_default/ipython_config.py/sitedocs/_build/ | Notebooks e outras ferramentasSão os checkpoints do Jupyter, o perfil do IPython e os resultados de build do mkdocs (/site) e do Sphinx (docs/_build/). /site tem / na frente, então aponta apenas para site na raiz do repositório. |
Cuidados na prática
- As regras
lib/elib64/ignoram diretórioslibem qualquer profundidade. Se você tem código de frontend emsrc/lib/, mude a regra para/lib/ou adicione!src/lib/. - O template só menciona em comentários
poetry.lock,uv.lock,pdm.lockePipfile.lock, sem ignorá-los. Em uma aplicação, o comum é commitá-los para que a instalação seja reproduzível. - Lembre que
.venvnão tem/no final, então um arquivo com esse nome (por exemplo, um arquivo de configuração de ferramenta que indica o caminho do ambiente virtual) também é ignorado. - Os resultados de execução dos notebooks do Jupyter (células de saída) não podem ser bloqueados com gitignore. Para commitar sem as saídas, use uma ferramenta como o nbstripout.
Template original
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
Origem dos templates: github/gitignore/Python.gitignore @356fd7b (2026-09-11) · CC0-1.0