Python源文件组织

时间:2010-12-13 05:17:39

标签: python conventions

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

2 个答案:

答案 0 :(得分:5)

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

虽然允许进行方法级导入,但导入位于文件的顶部。

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

答案 1 :(得分:0)

不,没有组织功能和类的约定。但是,有一些基本的指导方针可以使您的源流更好,让读者更有意义:

  • 文档。无论你做什么,确保用简明的英语描述类和函数的用法(在某些情况下,实现)。
  • 将相似的东西组合在一起。两个执行类似功能的功能?把它们放在一起。
  • 使用常识。如果一个类扩展另一个类,则应该首先使用基类。如果函数采用您定义的类的实例,请确保首先使用类定义。

有关如何完成此操作的示例,请查看Python标准库。来自某些模块的源文件应该让您了解如何在Python中组织源。