read-version 0.3.2

函数式方法

1. 在您的开发环境中安装 read_version。

2. 在您的项目中添加一个 pyproject.toml 文件，声明 read_version 为构建依赖项。（这是为了让其他人能够从源代码构建您的包；有关更多信息，请参阅 PEP 518。）文件的內容应类似于以下内容：

   [build-system]
   requires = [
       "read_version ~= 0.3.0",
       "setuptools",
       "wheel"
   ]
   build-backend = "setuptools.build_meta"

3. 在您的 setup.py 中，删除您那些模板化的 __version__ 查找代码，并用以下内容替换它：

   from read_version import read_version
   
   setup(
       version = read_version('packagename', '__init__.py'),
       ...
   )

4. 构建您的项目，并确保版本已设置为正确的值。

5. 完成！

声明式方法

从版本 0.2.0 开始新增！

1. 使用 toml 扩展在您的开发环境中安装 read_version。

   pip install 'read_version[toml]'

   您还需要 setuptools 的 42.0.0 或更高版本。

   pip install -U 'setuptools>=42'

2. 将 pyproject.toml 文件添加到您的项目中，声明 read_version[toml] 为构建依赖项，并要求 setuptools 的版本为 42.0.0 或更高。文件的相应部分应类似于以下内容：

   [build-system]
   requires = [
       "read_version[toml] ~= 0.3.0",
       "setuptools >= 42.0.0",
       "wheel"
   ]
   build-backend = "setuptools.build_meta"

3. 在您的 setup.py 中删除您那些模板化的 __version__ 查找代码。相反，在您的 pyproject.toml 文件中添加一个 tool.read_version 表，并为每个您希望从 Python 源文件中的变量读取的元数据字段添加一个条目到这个表中，格式为 FIELD = "dotted.file.path:varname"，其中：

   • FIELD 被替换为字段的英文小写名称。支持的字段有：

     • author

     • author_email

     • description（注意，这是简短描述或摘要，而不是长描述！）

     • keywords（建议使用字符串列表作为值，否则 setuptools 可能会对其进行损坏）

     • license

     • maintainer

     • maintainer_email

     • url

     • version

     不支持或未知字段名的条目将被忽略。

   • dotted.file.path 被替换为包含变量的文件的路径（相对于项目根目录），路径组件用点分隔，最后路径组件的 .py 被省略。

   • varname 被替换为要读取的变量名称。

   示例

   [tool.read_version]
   
   # Set the project's version to the value of __version__ in foobar.py:
   version = "foobar:__version__"
   
   # Set the project's author to the value of author_name in
   # foobar/__init__.py
   author = "foobar.__init__:author_name"
   
   # Set the project's license to the value of LICENSE in
   # src/foobar/about.py:
   license = "src.foobar.about:LICENSE"

   如果这个语法对您不起作用——比如说，因为您的路径组件中包含一个点或冒号，或者文件没有 .py 扩展名——或者您想为找不到变量设置默认值，那么将 tool.read_version.FIELD 设置为一个表格，如下所示：

   # Set the project's version to the value of __version__ in
   # foo.bar/__init__.pyq:
   [tool.read_version.version]
   path = ["foo.bar", "__init__.pyq"]
   variable = "__version__"
   
   # Set the project's author_email to the value of EMAIL in foobar.py.
   # If the variable isn't found, use the value "me@example.com" instead
   # of erroring
   [tool.read_version.author_email]
   path = ["foobar.py"]
   variable = "EMAIL"
   default = "me@example.com"

   tool.read_version.FIELD 表可能包含以下键

   路径:

   (必需) 读取变量的源文件的路径，相对于项目根目录，作为路径组件的列表

   变量名:

   (必需) 要从中获取值的 Python 变量的名称

   默认值:

   (可选) 如果在源文件中找不到变量，则使用给定值代替；如果找不到变量且未设置 default，则将引发错误

4. 构建您的项目，并确保元数据中所有相关字段都已设置为正确的值。

5. 完成！