Python源文件组织

6 投票
2 回答
2278 浏览
提问于 2025-04-16 08:26

我正在开始一个新的Python项目,想尽量遵循标准的写法。我听说导入语句应该放在最前面,比如说。但是我没有找到关于函数定义应该放在类定义之前还是之后的具体规定。像这样的事情有没有什么约定?还是说大家通常只是按照自己觉得合理的顺序来组织函数和类的定义呢?

2 个回答

7

PEP8 是 Python 的编码风格指南,详细内容可以在这里查看:http://www.python.org/dev/peps/pep-0008/

在文件的最上面要放导入的库,不过在方法内部导入也是可以的。

类和函数的顺序没有特别的规定,按照你觉得合理的方式来安排就可以。

3

不,关于函数和类的组织没有固定的规则。不过,有一些基本的指导原则可以让你的代码更流畅,也更容易让读者理解:

  • 文档说明。无论你做什么,确保用简单的语言描述类和函数的用法(在某些情况下,也包括实现方式)。
  • 把相似的东西放在一起。如果有两个函数做的事情差不多,就把它们放在一起。
  • 用常识。比如,如果一个类是另一个类的扩展,基础类应该放在前面。如果一个函数需要你定义的类的实例,确保这个类的定义在前面。

想要了解这些原则如何应用,可以看看Python的标准库。某些模块的源文件可以给你一个关于Python代码组织的好例子。

撰写回答