时间戳

首页 > 解决方案 > 运行使用 setuptools_scm 从 bdist_wheel 包安装的应用程序失败并出现版本查找错误

python-3.x - 运行使用 setuptools_scm 从 bdist_wheel 包安装的应用程序失败并出现版本查找错误

问题描述

TL;博士

我正在尝试为使用setuptools-scm. 我生成了轮包运行python setup.py sdist bdist_wheel。我可以.whl使用pip install .... 但是当我尝试运行程序时，它会抛出以下错误：

Traceback (most recent call last):
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/bin/mymodule", line 5, in <module>
    from mymodule.cli import main
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/mymodule/cli.py", line 4, in <module>
    from mymodule.contexts import ContextConfig
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/mymodule/contexts/__init__.py", line 2, in <module>
    from mymodule.contexts.context_config import ContextConfig
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/mymodule/contexts/context_config.py", line 8, in <module>
    from mymodule.commons import local_config_file_path, user_config_file_path
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/mymodule/commons/__init__.py", line 19, in <module>
    version = get_version(root="../..", relative_to=__file__)
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/setuptools_scm/__init__.py", line 144, in get_version
    return _get_version(config)
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/setuptools_scm/__init__.py", line 148, in _get_version
    parsed_version = _do_parse(config)
  File "/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages/setuptools_scm/__init__.py", line 110, in _do_parse
    raise LookupError(
LookupError: setuptools-scm was unable to detect version for '/home/zobayer/Projects/opensource/staging/myproject/venv/lib64/python3.8/site-packages'.

这是目录树的简单视图（不展开.git\）

myproject
├── .git
├── mymodule
│   ├── cli.py
│   ├── commons
│   │   ├── command.py
│   │   ├── helpers.py
│   │   └── __init__.py
│   ├── contexts
│   │   ├── context_config.py
│   │   └── __init__.py
│   ├── __init__.py
│   └── version.py
├── LICENSE
├── MANIFEST.in
├── pyproject.toml
├── README.md
├── requirements.txt
├── setup.cfg
├── setup.py
└── tox.ini

这里mymodule/version.py不跟踪。回购是干净的和标记的。使用setuptools 49.1.0and setuptools_scm 4.1.2，我配置了以下内容：

setup.py（省略元数据字段）

setup(
    name="myproject",
    use_scm_version=True,
    setup_requires=["wheel", "setuptools-scm"],
    packages=find_packages(exclude=["docs*", "tests*"]),
    include_package_data=True,
    install_requires=install_dependencies,
)

setup.cfg

[metadata]
license_files = LICENSE

[options]
setup_requires =
    wheel==0.34.2
    setuptools_scm==4.1.2

pyproject.toml

[build-system]
requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "mymodule/version.py"
write_to_template = "# -*- coding: utf-8 -*-\n\n__version__ = '{version}'\n"
version_scheme = "release-branch-semver"

我想在这里指出，安装工作正常，pip install -e .应用程序按预期运行。

我尝试在调用时更新rootand参数，并更新以使用配置字典无济于事。我在 github 中查看了官方问题，但我无法解决这个问题。在这一点上，我确信我误解了它并且可能错误地配置了它。relative_toget_versionuse_scm_versionsetuptools_scm

标签： python-3.xsetuptoolspython-wheelsetuptools-scm

解决方案

您不应该setuptools-scm在实际代码中使用它，它仅用于打包。它会寻找一个 VCS 存储库来从其元数据（git 标签等）中读取版本，因此很明显它会在安装包时失败。如果您尝试获取已安装软件包的版本，请使用importlib.metadata（自 3.8 以来的标准库的一部分，对于旧版本，有一个 backport: importlib-metadata）。例子：

>>> from importlib.metadata import version
>>> version('myproject')
'0.0.1'

您还可以使用pkg_resources(part of setuptools) 查询元数据的版本，但请注意它importlib.metadata现在已被取代：

>>> import pkg_resources
>>> pkg_resources.get_distribution('myproject').version
'0.0.1'

推荐阅读