Python源文件组织

Question

我正在开始一个新的Python项目,并希望尽可能地遵循标准约定.我已经读过,导入语句应该首先出现,例如.但我没有找到任何约定,例如在所有类定义之前或之后放置所有函数定义.这样的事情有没有约定？或者每个人通常只是以任何有意义的顺序组织函数和类定义之类的东西？

Answer 1

PEP8是Python风格指南:http://www.python.org/dev/peps/pep-0008/

虽然允许方法级别的导入,但导入位于文件的顶部.

对类和函数没有特定的排序.使用有意义的东西.

Answer 2

不，没有函数和类的组织约定。但是，有一些基本准则可以使您的源代码流程更好并且对读者更有意义：

• 文档。无论您做什么，请确保以简单的英语描述类和函数的使用（以及在某些情况下的实现）
• 将相似的事物组合在一起。执行相似功能的两个函数？把它们放在一起。
• 使用常识。如果一个类扩展另一个类，则基类应该放在第一位。如果函数采用您定义的类的实例，请确保类定义位于第一位。

有关如何完成此操作的示例，只需查看 Python 标准库即可。某些模块的源文件应该能让您了解 Python 中源代码的组织方式。