| """Unix.""" |
| |
| from __future__ import annotations |
| |
| import os |
| import sys |
| from configparser import ConfigParser |
| from pathlib import Path |
| from typing import Iterator, NoReturn |
| |
| from .api import PlatformDirsABC |
| |
| if sys.platform == "win32": |
| |
| def getuid() -> NoReturn: |
| msg = "should only be used on Unix" |
| raise RuntimeError(msg) |
| |
| else: |
| from os import getuid |
| |
| |
| class Unix(PlatformDirsABC): # noqa: PLR0904 |
| """ |
| On Unix/Linux, we follow the `XDG Basedir Spec <https://specifications.freedesktop.org/basedir-spec/basedir-spec- |
| latest.html>`_. |
| |
| The spec allows overriding directories with environment variables. The examples shown are the default values, |
| alongside the name of the environment variable that overrides them. Makes use of the `appname |
| <platformdirs.api.PlatformDirsABC.appname>`, `version <platformdirs.api.PlatformDirsABC.version>`, `multipath |
| <platformdirs.api.PlatformDirsABC.multipath>`, `opinion <platformdirs.api.PlatformDirsABC.opinion>`, `ensure_exists |
| <platformdirs.api.PlatformDirsABC.ensure_exists>`. |
| |
| """ |
| |
| @property |
| def user_data_dir(self) -> str: |
| """ |
| :return: data directory tied to the user, e.g. ``~/.local/share/$appname/$version`` or |
| ``$XDG_DATA_HOME/$appname/$version`` |
| """ |
| path = os.environ.get("XDG_DATA_HOME", "") |
| if not path.strip(): |
| path = os.path.expanduser("~/.local/share") # noqa: PTH111 |
| return self._append_app_name_and_version(path) |
| |
| @property |
| def _site_data_dirs(self) -> list[str]: |
| path = os.environ.get("XDG_DATA_DIRS", "") |
| if not path.strip(): |
| path = f"/usr/local/share{os.pathsep}/usr/share" |
| return [self._append_app_name_and_version(p) for p in path.split(os.pathsep)] |
| |
| @property |
| def site_data_dir(self) -> str: |
| """ |
| :return: data directories shared by users (if `multipath <platformdirs.api.PlatformDirsABC.multipath>` is |
| enabled and ``XDG_DATA_DIRS`` is set and a multi path the response is also a multi path separated by the |
| OS path separator), e.g. ``/usr/local/share/$appname/$version`` or ``/usr/share/$appname/$version`` |
| """ |
| # XDG default for $XDG_DATA_DIRS; only first, if multipath is False |
| dirs = self._site_data_dirs |
| if not self.multipath: |
| return dirs[0] |
| return os.pathsep.join(dirs) |
| |
| @property |
| def user_config_dir(self) -> str: |
| """ |
| :return: config directory tied to the user, e.g. ``~/.config/$appname/$version`` or |
| ``$XDG_CONFIG_HOME/$appname/$version`` |
| """ |
| path = os.environ.get("XDG_CONFIG_HOME", "") |
| if not path.strip(): |
| path = os.path.expanduser("~/.config") # noqa: PTH111 |
| return self._append_app_name_and_version(path) |
| |
| @property |
| def _site_config_dirs(self) -> list[str]: |
| path = os.environ.get("XDG_CONFIG_DIRS", "") |
| if not path.strip(): |
| path = "/etc/xdg" |
| return [self._append_app_name_and_version(p) for p in path.split(os.pathsep)] |
| |
| @property |
| def site_config_dir(self) -> str: |
| """ |
| :return: config directories shared by users (if `multipath <platformdirs.api.PlatformDirsABC.multipath>` |
| is enabled and ``XDG_CONFIG_DIRS`` is set and a multi path the response is also a multi path separated by |
| the OS path separator), e.g. ``/etc/xdg/$appname/$version`` |
| """ |
| # XDG default for $XDG_CONFIG_DIRS only first, if multipath is False |
| dirs = self._site_config_dirs |
| if not self.multipath: |
| return dirs[0] |
| return os.pathsep.join(dirs) |
| |
| @property |
| def user_cache_dir(self) -> str: |
| """ |
| :return: cache directory tied to the user, e.g. ``~/.cache/$appname/$version`` or |
| ``~/$XDG_CACHE_HOME/$appname/$version`` |
| """ |
| path = os.environ.get("XDG_CACHE_HOME", "") |
| if not path.strip(): |
| path = os.path.expanduser("~/.cache") # noqa: PTH111 |
| return self._append_app_name_and_version(path) |
| |
| @property |
| def site_cache_dir(self) -> str: |
| """:return: cache directory shared by users, e.g. ``/var/cache/$appname/$version``""" |
| return self._append_app_name_and_version("/var/cache") |
| |
| @property |
| def user_state_dir(self) -> str: |
| """ |
| :return: state directory tied to the user, e.g. ``~/.local/state/$appname/$version`` or |
| ``$XDG_STATE_HOME/$appname/$version`` |
| """ |
| path = os.environ.get("XDG_STATE_HOME", "") |
| if not path.strip(): |
| path = os.path.expanduser("~/.local/state") # noqa: PTH111 |
| return self._append_app_name_and_version(path) |
| |
| @property |
| def user_log_dir(self) -> str: |
| """:return: log directory tied to the user, same as `user_state_dir` if not opinionated else ``log`` in it""" |
| path = self.user_state_dir |
| if self.opinion: |
| path = os.path.join(path, "log") # noqa: PTH118 |
| self._optionally_create_directory(path) |
| return path |
| |
| @property |
| def user_documents_dir(self) -> str: |
| """:return: documents directory tied to the user, e.g. ``~/Documents``""" |
| return _get_user_media_dir("XDG_DOCUMENTS_DIR", "~/Documents") |
| |
| @property |
| def user_downloads_dir(self) -> str: |
| """:return: downloads directory tied to the user, e.g. ``~/Downloads``""" |
| return _get_user_media_dir("XDG_DOWNLOAD_DIR", "~/Downloads") |
| |
| @property |
| def user_pictures_dir(self) -> str: |
| """:return: pictures directory tied to the user, e.g. ``~/Pictures``""" |
| return _get_user_media_dir("XDG_PICTURES_DIR", "~/Pictures") |
| |
| @property |
| def user_videos_dir(self) -> str: |
| """:return: videos directory tied to the user, e.g. ``~/Videos``""" |
| return _get_user_media_dir("XDG_VIDEOS_DIR", "~/Videos") |
| |
| @property |
| def user_music_dir(self) -> str: |
| """:return: music directory tied to the user, e.g. ``~/Music``""" |
| return _get_user_media_dir("XDG_MUSIC_DIR", "~/Music") |
| |
| @property |
| def user_desktop_dir(self) -> str: |
| """:return: desktop directory tied to the user, e.g. ``~/Desktop``""" |
| return _get_user_media_dir("XDG_DESKTOP_DIR", "~/Desktop") |
| |
| @property |
| def user_runtime_dir(self) -> str: |
| """ |
| :return: runtime directory tied to the user, e.g. ``/run/user/$(id -u)/$appname/$version`` or |
| ``$XDG_RUNTIME_DIR/$appname/$version``. |
| |
| For FreeBSD/OpenBSD/NetBSD, it would return ``/var/run/user/$(id -u)/$appname/$version`` if |
| exists, otherwise ``/tmp/runtime-$(id -u)/$appname/$version``, if``$XDG_RUNTIME_DIR`` |
| is not set. |
| """ |
| path = os.environ.get("XDG_RUNTIME_DIR", "") |
| if not path.strip(): |
| if sys.platform.startswith(("freebsd", "openbsd", "netbsd")): |
| path = f"/var/run/user/{getuid()}" |
| if not Path(path).exists(): |
| path = f"/tmp/runtime-{getuid()}" # noqa: S108 |
| else: |
| path = f"/run/user/{getuid()}" |
| return self._append_app_name_and_version(path) |
| |
| @property |
| def site_runtime_dir(self) -> str: |
| """ |
| :return: runtime directory shared by users, e.g. ``/run/$appname/$version`` or \ |
| ``$XDG_RUNTIME_DIR/$appname/$version``. |
| |
| Note that this behaves almost exactly like `user_runtime_dir` if ``$XDG_RUNTIME_DIR`` is set, but will |
| fall back to paths associated to the root user instead of a regular logged-in user if it's not set. |
| |
| If you wish to ensure that a logged-in root user path is returned e.g. ``/run/user/0``, use `user_runtime_dir` |
| instead. |
| |
| For FreeBSD/OpenBSD/NetBSD, it would return ``/var/run/$appname/$version`` if ``$XDG_RUNTIME_DIR`` is not set. |
| """ |
| path = os.environ.get("XDG_RUNTIME_DIR", "") |
| if not path.strip(): |
| if sys.platform.startswith(("freebsd", "openbsd", "netbsd")): |
| path = "/var/run" |
| else: |
| path = "/run" |
| return self._append_app_name_and_version(path) |
| |
| @property |
| def site_data_path(self) -> Path: |
| """:return: data path shared by users. Only return the first item, even if ``multipath`` is set to ``True``""" |
| return self._first_item_as_path_if_multipath(self.site_data_dir) |
| |
| @property |
| def site_config_path(self) -> Path: |
| """:return: config path shared by the users, returns the first item, even if ``multipath`` is set to ``True``""" |
| return self._first_item_as_path_if_multipath(self.site_config_dir) |
| |
| @property |
| def site_cache_path(self) -> Path: |
| """:return: cache path shared by users. Only return the first item, even if ``multipath`` is set to ``True``""" |
| return self._first_item_as_path_if_multipath(self.site_cache_dir) |
| |
| def _first_item_as_path_if_multipath(self, directory: str) -> Path: |
| if self.multipath: |
| # If multipath is True, the first path is returned. |
| directory = directory.split(os.pathsep)[0] |
| return Path(directory) |
| |
| def iter_config_dirs(self) -> Iterator[str]: |
| """:yield: all user and site configuration directories.""" |
| yield self.user_config_dir |
| yield from self._site_config_dirs |
| |
| def iter_data_dirs(self) -> Iterator[str]: |
| """:yield: all user and site data directories.""" |
| yield self.user_data_dir |
| yield from self._site_data_dirs |
| |
| |
| def _get_user_media_dir(env_var: str, fallback_tilde_path: str) -> str: |
| media_dir = _get_user_dirs_folder(env_var) |
| if media_dir is None: |
| media_dir = os.environ.get(env_var, "").strip() |
| if not media_dir: |
| media_dir = os.path.expanduser(fallback_tilde_path) # noqa: PTH111 |
| |
| return media_dir |
| |
| |
| def _get_user_dirs_folder(key: str) -> str | None: |
| """ |
| Return directory from user-dirs.dirs config file. |
| |
| See https://freedesktop.org/wiki/Software/xdg-user-dirs/. |
| |
| """ |
| user_dirs_config_path = Path(Unix().user_config_dir) / "user-dirs.dirs" |
| if user_dirs_config_path.exists(): |
| parser = ConfigParser() |
| |
| with user_dirs_config_path.open() as stream: |
| # Add fake section header, so ConfigParser doesn't complain |
| parser.read_string(f"[top]\n{stream.read()}") |
| |
| if key not in parser["top"]: |
| return None |
| |
| path = parser["top"][key].strip('"') |
| # Handle relative home paths |
| return path.replace("$HOME", os.path.expanduser("~")) # noqa: PTH111 |
| |
| return None |
| |
| |
| __all__ = [ |
| "Unix", |
| ] |