为 Python 项目添加 .gitignore 文件的最佳实践？ [关闭]

Posted 2023-02-19

技术标签:

【中文标题】为 Python 项目添加 .gitignore 文件的最佳实践？ [关闭]【英文标题】：Best practices for adding .gitignore file for Python projects? [closed] 【发布时间】：2011-04-12 18:22:27 【问题描述】：

我正在尝试收集一些默认设置，但我意识到我没有标准的一件事是 .gitignore 文件。有一个很棒的线程显示good .gitignore for Visual Studio projects，但我没有看到很多关于 Python 和相关工具（PyGTK、Django）的建议。

到目前为止，我已经...

*.pyc
*.pyo

...对于已编译的对象和...

build/
dist/

...用于 setuptools 输出。

.gitignore 文件有哪些最佳做法，我可以从哪里获得有关这些最佳做法的更多信息？

【问题讨论】：

这个项目github.com/github/gitignore 旨在准确回答这个问题。 .. 只是不要忘记添加github.com/github/gitignore/blob/master/Python.gitignore，因为它也是一个 python 项目。进入 gitignore.io 并输入 python 获取标准文件，由于问题已关闭，我在这里评论我认为应该是答案的内容。如果您在 PyCharm IDE 上，您可能需要忽略 .idea/ 目录。这取决于您是否要共享一些/所有项目设置。 Here's关于这个的问题我真的很讨厌这些“基于意见”的问题被关闭。为什么？？这不是一个敏感的话题，会引发激烈的战争。没有人会因为承认不同的意见而感到不安。 OP（和我）只是想要一些最佳实践指南，并且很高兴认识到它们不可能“正确”，但仍然非常有用。 【参考方案1】：

涵盖了大部分常规内容 -

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# 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 logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

参考：python .gitignore

【讨论】：

这个上面已经提到了！ @Emmanuel 另一个答案中提到的不是通用样板文件，它有很多不必要的东西。这里提到的一般适用于任何 Django/python。确实，很抱歉……不幸的是，在编辑答案之前我无法取消我的反对票……【参考方案2】：

Github has a great boilerplate .gitignore

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# C extensions
*.so

# Distribution / packaging
bin/
build/
develop-eggs/
dist/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
.tox/
.coverage
.cache
nosetests.xml
coverage.xml

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Rope
.ropeproject

# Django stuff:
*.log
*.pot

# Sphinx documentation
docs/_build/

【讨论】：

我们为什么要忽略 *.mo 文件？只是为了好奇。那些gettext的.po文件是在服务器上单独编译的吗？ .mo 文件是 .po 文件的机器可读（二进制）版本，并且 - 众所周知 - 如果可以（并且你应该，因为同时包含 .po 和 .mo 意味着在存储库中保留重复的数据，VCS 甚至不能“压缩”）为什么不使用 .DS_Store？我真的很困惑为什么他们在.gitignore 中有.python-version：github.com/github/gitignore/blob/master/Python.gitignore#L82【参考方案3】：

当使用buildout 时，我在.gitignore 中有关注（以及*.pyo 和*.pyc）：

.installed.cfg
bin
develop-eggs
dist
downloads
eggs
parts
src/*.egg-info
lib
lib64

感谢Jacob Kaplan-Moss

我也倾向于输入.svn，因为我们在我工作的地方使用了几个 SCM-s。

【讨论】：

将 svn 存储库与您的 git 存储库保存在同一棵树中！？什么样的怪物会做出这种事？ @Daenyth giggle，不是真的，但如果我从其他来源获取组件（特别是在旧组件中），我倾向于找到一些剩余的 .svn 目录而且我也很懒所以我有时会复制结帐而不是从 SVN 导出东西。我曾经什至看到一个人实际上在 GIT 中提交了剩余的 .svn 目录。与愚蠢的人一起工作时，您可能会遇到各种奇怪的事情。好吧，我正试图将它们挂在 *** 上...：p 我还没有使用 Buildout，但可能很快就会需要......所以我会把它们放在列表中。谢谢！您应该将*.svn 放入您的.global_gitignore，而不是单独的项目中。【参考方案4】：

以下是 setuptools 可能留下的其他一些文件：