【问题标题】:Where to add __author__ in Python Packages [closed]在 Python 包中添加 __author__ 的位置 [关闭]
【发布时间】:2017-02-06 21:54:09
【问题描述】:

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

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

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

【问题讨论】:

  • 也许,这可以帮助你stackoverflow.com/questions/1523427/…
  • 这就是为什么只有一个模块的包是个坏主意。它只会产生这样的虚假问题。
  • @Goyo 目前。由于文档样式而忽视未来对包装的需求是短视和幼稚的。
  • @Milk 根据我的看法,实际上忽略未来的愿望并专注于当前的需求被广泛认为是软件开发中的良好实践。

标签: python metadata docstring


【解决方案1】:

根据PEP 8

模块级别的“dunders”(即名称有两个前导和两个下划线),例如 allauthorversion 等。应该放在模块文档字符串之后,但在任何导入语句之前,除了来自 future 导入。

所以我建议把它放在你的导入语句之前和文档字符串之后。

【讨论】:

    【解决方案2】:

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

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

    【讨论】:

    • 我没有 setup.py。这似乎是最好的答案。谢谢
    猜你喜欢
    • 1970-01-01
    • 2012-08-12
    • 1970-01-01
    • 2016-07-19
    • 1970-01-01
    • 1970-01-01
    • 2020-09-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多