使用 Poetry 對“找不到分發”pkg_resources 進行故障排除

Question

我正在構建一個 cli 應用程序，在其中我使用詩歌和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

我已經安裝了我的 package 與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顯式委托調用poetry run fili/cli.py代替。

---

如果這不能解決問題，則可能還有其他兩個問題。 首先是您將pkg_resources與 python3.8 一起使用。 你不應該這樣做，標准庫是用importlib.metadata.version擴展的，這只是一個直接的升級。

最后，將已安裝的 package 的一部分作為腳本運行（讀取，直接執行 a.py 文件而不是模塊： python -m fili ）有點不安全。 它可能會以令人困惑的方式混淆導入，這通常通過為 scripts 定義入口點來解決。