python - python项目的文件夹命名约定

Question

python 社区中为项目文件夹和子文件夹设置名称的命名约定是什么？

my-great-python-project
my_great_python_project 
myGreatPythonProject 
MyGreatPythonProject

我发现在 github 中混淆了。感谢您的专家意见。

Answer 1

共有三种约定，您可能会感到困惑。

1. 标准

PEP8定义了如何命名包和模块的标准:

Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

1. 实际上，没有人关心不使用下划线的建议

即使在 PEP8 中，许多包都使用下划线并且社区并不认为这是不好的做法。所以你会看到很多名字，比如 sqlalchemy_searchable 等。

虽然您可以创建一个名称与您的包名称不匹配的文件夹，但这样做通常不是一个好主意，因为它会使事情变得更加困惑。

因此，您通常会为文件夹使用带下划线的全小写名称。

1. pypi 上的包命名

安装包时的名称不需要与它在 pypi 上发布的名称相匹配(pip 安装的来源)。 pypi 上的包往往用连字符命名，而不是下划线。例如flask-cors ，它会安装软件包 flask_cors。

但是，您会注意到，如果您跟进此示例，flask-cors's GitHub repo在 flask_cors/ 目录中定义包代码。这是常态。

虽然它变得有点困惑，因为 pip 包安装不区分大小写并且同等对待下划线和连字符。所以 Flask-Cors、fLASK_cOrs 等都是“等效的”。就我个人而言，我不喜欢用这个来玩游戏——我建议在 pypi 上使用连字符全小写命名包，这是大多数人所做的。

---

免责声明:我不拥有或维护 sqlalchemy-searchable 或 flask-cors，但在撰写本文时，它们是包中带有下划线的很好示例名字。