如何将安装的 Python 包的位置获取到 shell 中

Question

我希望我的用户能够直接从 shell 引用我的 python 包中的文件（特别是 docker-compose.yml 文件）。

我找不到仅从pip show 获取位置的方法（并且从其输出中 grep-ing 出“位置”感觉很难看），所以我目前（有点冗长）的解决方案是：

docker compose -f $(python3 -c "import locust_plugins; print(locust_plugins.__path__[0])")/timescale/docker-compose.yml up

有没有更好的办法？

编辑：我通过安装一个包装器命令解决了这个问题，我称之为locust-compose 作为包的一部分。不完美，但它可以完成工作：

#!/bin/bash
module_location=$(python3 -c "import locust_plugins; print(locust_plugins.__path__[0])")
set -x
docker compose -f $module_location/timescale/docker-compose.yml "$@"

Answer 1

您需要的大部分支持都在核心 setuptools 套件中。

首先，您需要确保data file is included in your package。在setup.cfg 文件中你可以写：

[options.package_data]
timescale = docker-compose.yml

现在，如果您 pip install . 或 pip wheel，这将包含 Compose 文件作为 Python 包的一部分。

接下来，您可以使用ResourceManager API：在 Python 代码中检索它：

#!/usr/bin/env python3
# timescale/compose_path.py

import pkg_resources

if __name__ == '__main__':
  print(pkg_resources.resource_filename('timescale', 'docker-compose.yml'))

最后，您可以使用该脚本并将其设置为 setuptools entry point script（与名称相似的 Docker 概念不同），以便您可以将其作为单个命令运行。

[options.entry_points]
console_scripts=
  timescale_compose_path = timescale:compose_path

同样，如果你 pip install . 进入虚拟环境，你应该能够运行 timescale_compose_path 并获取路径名。

完成所有这些步骤后，您终于可以运行一个更简单的了

docker-compose -f $(timescale_compose_path) up