xdg-base-dirs

xdg-base-dirs 是一个 Python 模块，提供返回 XDG 基础目录规范 中定义的目录路径的函数，以避免你在每个处理用户缓存、配置或数据文件的 Python 实用程序中重复相同的逻辑片段。它没有外部依赖。

[!注意]

xdg-base-dirs 之前名为 xdg，由于与 PyXDG 的导入冲突而更名。如果你在重命名前使用过 xdg，请通过将依赖名称从 xdg 更改为 xdg-base-dirs，并将导入从 xdg 更改为 xdg_base_dirs 来更新。

安装

要从 PyPI 安装最新版本，使用 pip：

python3 -m pip install xdg-base-dirs

xdg-base-dirs 的最新版本目前实现了 2021 年 5 月 8 日发布的规范 0.8 版本。

在使用 Poetry 或 PDM 进行依赖管理的 Python 项目中，使用 poetry add xdg-base-dirs 或 pdm add xdg-base-dirs 添加 xdg-base-dirs 作为依赖项。或者，由于 xdg-base-dirs 只有一个文件，你可能更喜欢直接将源代码分发中的 src/xdg_base_dirs/__init__.py 复制到你的项目中。

使用方法

from xdg_base_dirs import (
    xdg_cache_home,
    xdg_config_dirs,
    xdg_config_home,
    xdg_data_dirs,
    xdg_data_home,
    xdg_runtime_dir,
    xdg_state_home,
)

xdg_cache_home()、xdg_config_home()、xdg_data_home() 和 xdg_state_home() 返回包含名为 XDG_CACHE_HOME、XDG_CONFIG_HOME、XDG_DATA_HOME 和 XDG_STATE_HOME 环境变量值的 pathlib.Path 对象，如果环境变量未设置、为空或包含相对路径而不是绝对路径，则返回规范中定义的默认值。

xdg_config_dirs() 和 xdg_data_dirs() 返回一个包含按冒号分隔的名为 XDG_CONFIG_DIRS 和 XDG_DATA_DIRS 环境变量值的 pathlib.Path 对象列表，如果环境变量未设置或为空，则返回规范中定义的默认值。根据规范，相对路径将被忽略。

xdg_runtime_dir() 返回一个包含 XDG_RUNTIME_DIR 环境变量值的 pathlib.Path 对象，如果环境变量未设置或包含相对路径而不是绝对路径，则返回 None。

版权

版权所有 © Scott Stevenson。

xdg-base-dirs 根据 ISC 许可证 条款分发。