xdg-base-dirs is a Python module that provides functions to return paths to
the directories defined by the XDG Base Directory Specification, to save
you from duplicating the same snippet of logic in every Python utility you write
that deals with user cache, configuration, or data files. It has no external
dependencies.
xdg-base-dirs currently implements version 0.8 of the specification, released
on 8th May 2021.
[!NOTE]
xdg-base-dirswas previously namedxdg, and was renamed due to an import collision withPyXDG. If you usedxdgprior to the rename, update by changing the dependency name fromxdgtoxdg-base-dirsand the import fromxdgtoxdg_base_dirs.
xdg-base-dirs requires Python 3.10 or later. To install the latest release
from PyPI with pip, use:
python3 -m pip install xdg-base-dirs
Alternatively, since xdg-base-dirs is only a single file you may prefer to
just copy src/xdg_base_dirs/__init__.py from the source distribution into your
project.
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(), and
xdg_state_home() return pathlib.Path objects containing the value of
the environment variable named XDG_CACHE_HOME, XDG_CONFIG_HOME,
XDG_DATA_HOME, and XDG_STATE_HOME respectively, or the default defined in
the specification if the environment variable is unset, empty, or contains a
relative path rather than absolute path.
xdg_config_dirs() and xdg_data_dirs() return a list of pathlib.Path
objects containing the value, split on colons, of the environment variable named
XDG_CONFIG_DIRS and XDG_DATA_DIRS respectively, or the default defined in
the specification if the environment variable is unset or empty. Relative paths
are ignored, as per the specification.
xdg_runtime_dir() returns a pathlib.Path object containing the value of the
XDG_RUNTIME_DIR environment variable, or None if the environment variable is
not set, or contains a relative path rather than an absolute path.
Copyright © Scott Stevenson.
xdg-base-dirs is distributed under the terms of the ISC license.
FAQs
Variables defined by the XDG Base Directory Specification
We found that xdg-base-dirs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.