Python打包：用户指定的文件路径

Question

我正在编写一个依赖于许多大型数据文件的 python 包。这些文件不包含在软件包中。相反，用户需要将这些文件保存在磁盘上（使用任意路径）。让我的包知道这些文件的位置的最佳方法是什么？

我一直在阅读有关 setup.py 和 setup.cfg 的信息，但我仍然不知道该怎么做。在我看来，setup.cfg 中的用户可编辑选项将是一个不错的选择，但我不知道是否可以，是否可以完成，或者如果可以，我会怎么做......

我确实看到了这个几乎相同的问题，Python Packaging: Ask user for variable values when (pip) installing，它侧重于 pip 期间的用户输入（这在 cmets 中是不鼓励的）。 如果这确实是一个很好的解决方案，我也对如何做到这一点感兴趣。

在我私下开发的包中，我使用了模块常量，如

DEFAULT_PATH_FILE1 = "my/path/to/file1.csv"
DEFAULT_PATH_FILE2 = "my/path/to/file2.csv"

等等。以及使用这些常量初始化的属性。这似乎根本不适合分发。

Answer 1

您想要的不是安装期间的一次性设置（现代.whl 安装也是不可能的），而是客户端在运行时随时配置库的一种方式。鉴于您不提供 cli，您可以使用环境变量作为提供该选项的选项，或者查找用户定义的配置文件。

这是一个使用appdirs 找出配置文件所在位置的简单方法。它在导入包时加载，并告诉客户如果配置文件不存在有多糟糕。通常是：

• 写日志消息
• 使用默认设置
• 抛出某种异常
• 以上的组合

from logging import getLogger
from pathlib import Path
from configparser import ConfigParser
# loads .ini format files easily, just to have an example to go with

import appdirs  # needs to be pip-installed

log = getLogger(__name__)
config = ConfigParser(interpolation=None)


# load config, substitute "my_package" with the actual name of your package
config_path = Path(appdirs.user_config_dir("my_package")) / "user.ini"
try:
    with open(config_path) as f:
        config.read_file(f, source="user")
except FileNotFoundError:
    # only do whatever makes sense
    log.info(f"User config expected at '{config_path}', but not found.")
    config.read_string("[pathes]\nfile_foo=foo\nfile_bar=bar")  # dubious
    raise ImportError(f"Can't use this module; create a config at '{config_path}'.")


class Foo:
    def __init__(self):
        with open(cfg["pathes"]["file_foo"]) as f:
            self.data = f.read()

Answer 2

这听起来像运行时配置。这与setup.py 无关，它与安装你的包有关。

对于应用程序配置，通常通过命令行参数、环境变量或配置文件指定此资源位置。您通常需要硬编码一些合理的默认路径以防用户未指定任何配置，或者在资源不存在/未找到的情况下引发异常。

环境变量示例：

import os

DEFAULT_PATH_FILE1 = "/default/path/to/file1.csv"
PATH_FILE1 = os.environ.get("PATH_FILE1", DEFAULT_PATH_FILE1)