向 python 包添加引用建议的首选方法是什么？答案

【问题标题】：What is the preferred way to a add a citation suggestion to python packages?向 python 包添加引用建议的首选方法是什么？
【发布时间】：2019-03-17 20:51:04
【问题描述】：

除了文档之外，开发者应该如何指出用户应该如何引用包？

R 包使用 citation("pkg") 返回首选引用。

我能想到pkg.CITATION、pkg.citation 和pkg.__citation__。还有其他人吗？如果没有首选方式（对我来说似乎是这种情况，因为我在 python.org 上没有找到任何东西），每种方式的优缺点是什么？

【问题讨论】：

我在 Python 中不知道这一点。我的意思是有 __name__ 和 __doc__ 但它们不适合那种 R 引用。
是的，最后可能是约定俗成的问题。

标签： python citations

【解决方案1】：

最后我选择了 dunder 选项。只有 dunder 选项 (__citation__) 清楚表明，这不是运行时所需的正常变量。

是的，dunder 字符串不应该用于膨胀，因为 python 可能会在以后使用它们。但是如果 python 打算使用__citation__，那么它将用于类似的目的。另外，我认为其他选项的相对成本更高。

【讨论】：