在Python包中添加__author__的位置[关闭]

Question

我正在编写一个简单的 Python 包，（目前）只有一个模块。

我应该将文档字符串和

__author__

元属性放在哪里？它们是放在

__init__.py

中还是每个模块中？

有与此相关的 PEP 吗？我只能找到通用文档字符串，它不能回答这个问题。

Answer 1

根据PEP 8：

模块级别“dunders”（即带有两个前导和两个尾随下划线的名称），例如

__all__

、

__author__

、

__version__

等，应放置在模块文档字符串之后，但在除 from

__future__

之外的任何导入语句之前进口。

所以我建议将其放在导入语句之前和文档字符串之后。

Answer 2

老实说，如果您有的话，我会将作者放入

setup.py

文件中。这样您就不会用重复的信息污染项目中的所有文件。

但是如果你想这样做，你可以遵循这个结构http://web.archive.org/web/20111010053227/http://jaynes.colorado.edu/PythonGuidelines.html#module_formatting