使用 Poetry 对“找不到分发”pkg_resources 进行故障排除

Question

我正在构建一个 cli 应用程序，其中我使用 poetry 和 pyproject.toml 来定义我的应用程序的版本：

[tool.poetry]
name = "fili"
version = "0.1.0"
description = "My super awesome program."
authors = ["Jacob Pavlock <jtpavlock@gmail.com>"]
license = "MIT"

现在，我想在 CLI 中为我的应用程序以编程方式访问此版本号，因此我将以下代码添加到 cli.py

import argparse
import pkg_resources


def main():
    """Run our cli."""
    VERSION = pkg_resources.get_distribution("fili").version

    fili_parser = argparse.ArgumentParser(description="Run fili.")
    fili_parser.add_argument(
        "--version", action="version", version="%(prog)s {0}".format(VERSION)
    )


if __name__ == "__main__":
    main()

但是，在运行时，我收到以下错误：

$ ./fili/cli.py 
Traceback (most recent call last):
  File "./fili/cli.py", line 22, in <module>
    main()
  File "./fili/cli.py", line 11, in main
    VERSION = pkg_resources.get_distribution("fili").version
  File "/home/jacob/.cache/pypoetry/virtualenvs/fili-yAte7WxV-py3.8/lib/python3.8/site-packages/pkg_resources/__init__.py", line 481, in get_distribution
    dist = get_provider(dist)
  File "/home/jacob/.cache/pypoetry/virtualenvs/fili-yAte7WxV-py3.8/lib/python3.8/site-packages/pkg_resources/__init__.py", line 357, in get_provider
    return working_set.find(moduleOrReq) or require(str(moduleOrReq))[0]
  File "/home/jacob/.cache/pypoetry/virtualenvs/fili-yAte7WxV-py3.8/lib/python3.8/site-packages/pkg_resources/__init__.py", line 900, in require
    needed = self.resolve(parse_requirements(requirements))
  File "/home/jacob/.cache/pypoetry/virtualenvs/fili-yAte7WxV-py3.8/lib/python3.8/site-packages/pkg_resources/__init__.py", line 786, in resolve
    raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'fili' distribution was not found and is required by the application

供参考，我的项目目录结构

$ tree
.
├── fili
│   ├── cli.py
│   ├── __init__.py
│   └── __pycache__
│       ├── cli.cpython-38.pyc
│       └── __init__.cpython-38.pyc
├── fili.egg-info
│   ├── dependency_links.txt
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   └── top_level.txt
├── LICENSE
├── poetry.lock
├── pyproject.toml
└── README.md

我已经用poetry install 安装了我的包，但我还缺少什么？

Answer 1

您必须确保运行poetry install 时poetry 安装它的环境也是运行./fili/cli.py 时执行的环境。后一个命令将只获取注册为系统的python 二进制文件的任何内容来运行您的脚本，而poetry install 将尝试将其安装到任何激活的虚拟环境中 - 如果没有，则创建一个新环境。

要解决这个问题，您可以 1) 运行 poetry shell 以激活 poetry 使用的虚拟环境，之后像 fili/cli.py 这样的调用将使用激活的 python，或者您 2) 委托而是使用poetry run fili/cli.py 显式调用。

---

如果这不能解决问题，则可能还有其他两个问题。首先是您将pkg_resources 与python3.8 一起使用。你不应该这样做，标准库是用importlib.metadata.version 扩展的，这只是一个直接的升级。

最后，将已安装包的一部分作为脚本运行（读取，直接执行 .py 文件而不是模块：python -m fili）有点不安全。它可能会以令人困惑的方式混淆导入，这通常通过定义 entrypoints for scripts 来解决。