在Python包中添加__author__的位置

时间:2016-09-28 18:59:14

标签: python metadata docstring

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

我应该在哪里放置docstring和__author__元属性?他们是在__init__.py还是在每个模块中?

是否有与之相关的PEP?我只能找到通用文档字符串,它没有回答这个问题。

2 个答案:

答案 0 :(得分:2)

老实说,如果你有一个,我会把作者放在setup.py文件中。这样,您就不会污染项目中包含重复信息的所有文件。

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

答案 1 :(得分:1)

根据PEP 8

  

模块级别“dunders”(即具有两个前导和两个尾部下划线的名称),例如所有作者版本等。应放在模块docstring之后但在除 future 导入之外的任何import语句之前。

所以我建议将它放在import语句之前和docstring之后。