python包元数据最佳实践

问题描述

我正在整理我的第一个包,以便我可以轻松地与他人共享它,但我遇到了一个对我来说有些模糊的方面 - 我不太知道处理包元数据的最佳方法是什么是。

例如,似乎设置包版本号的最佳方法是使用单独的文件,而不是在主包的 __init__.py 中定义它,如此答案中所述:https://stackoverflow.com/a/17626524/1506763。这是有道理的,因为如果在 __init__.py 中导入,您在 setup.py 中的导入可能会导致问题。

但是这个版本问题引发了另一个关于我在 __init__.py 中声明的其他元数据的问题,即:

__author__ = ''
__copyright__ = 'copyright 2021,{project_name}'
__credits__ = ['{credit_list}']
__license__ = '{license}'
__version__ = '{mayor}.{minor}.{rel}' # will move to own file like in the linked answer
__maintainer__ = ''
__email__ = ''
__status__ = '{dev_status}'

实际上是否应该在 __init__.py 文件中声明这些?在链接的答案中,它们是否也应该像版本一样对待?

我已经看到这篇文章提出了每个模块 What is the common header format of Python files? 应该定义的所有各种属性,但这似乎与单个文件模块相关,而不是与具有多个子包和模块的包相关。

或者所有这些元数据都应该包含在子包的 __init__.py 中,以防子包自行导入。

是否有一个定义明确的示例来解释如何设置包(及其子包)的这一方面?

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)