python项目的项目结构

Question

是否有任何工具可以为特定于python的项目生成项目布局，这与maven为java项目完成的mvn archetype:generate非常相似。

Answer 1

下面的几个bash命令对我非常有用：

mkdir myproject
cd myproject
mkdir docs
mkdir tests
touch tests/__init__.py

对于python，与java或c不同，您通常不需要太多。有关问题，请参见the answers。如果你认为你需要更多，你必须对你的要求更加具体。

Answer 2

好消息是：你不需要任何工具。你可以用任何你想要的方式组织你的源代码。

让我们回顾一下为什么java世界需要工具：

在java中，您希望预先生成目录，因为命名空间系统要求每个类必须位于反映包层次结构的目录结构中的一个文件中。因此，你有一个深层的文件夹结构。Maven对文件位置强制执行一组附加约定。你需要有工具来自动完成这项工作。

其次，不同的人工制品需要使用不同的目标，甚至需要额外的maven项目（例如ear项目需要几个jar和war人工制品）。要创建的文件太多了，您需要使用工具来自动执行此操作。

复杂性使得像mvn archetype:generate这样的工具不仅有用。这几乎是必不可少的。

在python语言中，我们只是没有这些复杂性。

如果我的项目很小，我可以将所有类和函数放在一个文件中（如果有意义的话）

如果我的项目更大（LOC或team size），那么将.py文件分组到模块中对您和您的同行都有意义。

最后，它要在易维护性和可读性之间取得平衡。

Answer 3

在Python中（就像在任何语言中一样），如果您想让所有部分都能很好地一起工作，那么需要配置很多部分。文档，测试，虚拟环境，打包。。。

您可以在实际需要或项目开始增长时添加这些配置。有一个工具可以为你配置所有这些，让你填补空白，确实有很大帮助。

有几个项目要看：

• Scaffold for Python
• Cookiecutter
• Pyckstart