pip._vendor.platformdirs.unix.Unix Class Reference

Inheritance diagram for pip._vendor.platformdirs.unix.Unix:

Collaboration diagram for pip._vendor.platformdirs.unix.Unix:

Public Member Functions
str	user_data_dir (self)
str	site_data_dir (self)
str	user_config_dir (self)
str	site_config_dir (self)
str	user_cache_dir (self)
str	site_cache_dir (self)
str	user_state_dir (self)
str	user_log_dir (self)
str	user_documents_dir (self)
str	user_downloads_dir (self)
str	user_pictures_dir (self)
str	user_videos_dir (self)
str	user_music_dir (self)
str	user_runtime_dir (self)
Path	site_data_path (self)
Path	site_config_path (self)
Path	site_cache_path (self)
Public Member Functions inherited from pip._vendor.platformdirs.api.PlatformDirsABC
None	__init__ (self, str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool multipath=False, bool opinion=True, bool ensure_exists=False)
Path	user_data_path (self)
Path	user_config_path (self)
Path	user_cache_path (self)
Path	user_state_path (self)
Path	user_log_path (self)
Path	user_documents_path (self)
Path	user_downloads_path (self)
Path	user_pictures_path (self)
Path	user_videos_path (self)
Path	user_music_path (self)
Path	user_runtime_path (self)

Public Attributes
	site_data_dir
	site_config_dir
	site_cache_dir
Public Attributes inherited from pip._vendor.platformdirs.api.PlatformDirsABC
	appname
	appauthor
	version
	roaming
	multipath
	opinion
	ensure_exists

Protected Member Functions
str	_with_multi_path (self, str path)
Path	_first_item_as_path_if_multipath (self, str directory)
Protected Member Functions inherited from pip._vendor.platformdirs.api.PlatformDirsABC
str	_append_app_name_and_version (self, *str base)
None	_optionally_create_directory (self, str path)

Detailed Description

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 show 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>`.

Member Function Documentation

site_cache_dir()

str pip._vendor.platformdirs.unix.Unix.site_cache_dir

(

self

)

:return: cache directory shared by users, e.g. ``/var/tmp/$appname/$version``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

site_cache_path()

Path pip._vendor.platformdirs.unix.Unix.site_cache_path

(

self

)

:return: cache path shared by users. Only return first item, even if ``multipath`` is set to ``True``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

site_config_dir()

str pip._vendor.platformdirs.unix.Unix.site_config_dir

(

self

)

:return: config directories shared by users (if `multipath <platformdirs.api.PlatformDirsABC.multipath>`
 is enabled and ``XDG_DATA_DIR`` 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``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

site_config_path()

Path pip._vendor.platformdirs.unix.Unix.site_config_path

(

self

)

:return: config path shared by the users. Only return first item, even if ``multipath`` is set to ``True``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

site_data_dir()

str pip._vendor.platformdirs.unix.Unix.site_data_dir

(

self

)

:return: data directories shared by users (if `multipath <platformdirs.api.PlatformDirsABC.multipath>` is
 enabled and ``XDG_DATA_DIR`` 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``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

site_data_path()

Path pip._vendor.platformdirs.unix.Unix.site_data_path

(

self

)

:return: data path shared by users. Only return first item, even if ``multipath`` is set to ``True``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_cache_dir()

str pip._vendor.platformdirs.unix.Unix.user_cache_dir

(

self

)

:return: cache directory tied to the user, e.g. ``~/.cache/$appname/$version`` or
 ``~/$XDG_CACHE_HOME/$appname/$version``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_config_dir()

str pip._vendor.platformdirs.unix.Unix.user_config_dir

(

self

)

:return: config directory tied to the user, e.g. ``~/.config/$appname/$version`` or
 ``$XDG_CONFIG_HOME/$appname/$version``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_data_dir()

str pip._vendor.platformdirs.unix.Unix.user_data_dir

(

self

)

:return: data directory tied to the user, e.g. ``~/.local/share/$appname/$version`` or
 ``$XDG_DATA_HOME/$appname/$version``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_documents_dir()

str pip._vendor.platformdirs.unix.Unix.user_documents_dir

(

self

)

:return: documents directory tied to the user, e.g. ``~/Documents``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_downloads_dir()

str pip._vendor.platformdirs.unix.Unix.user_downloads_dir

(

self

)

:return: downloads directory tied to the user, e.g. ``~/Downloads``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_log_dir()

str pip._vendor.platformdirs.unix.Unix.user_log_dir

(

self

)

:return: log directory tied to the user, same as `user_state_dir` if not opinionated else ``log`` in it

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_music_dir()

str pip._vendor.platformdirs.unix.Unix.user_music_dir

(

self

)

:return: music directory tied to the user, e.g. ``~/Music``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_pictures_dir()

str pip._vendor.platformdirs.unix.Unix.user_pictures_dir

(

self

)

:return: pictures directory tied to the user, e.g. ``~/Pictures``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_runtime_dir()

str pip._vendor.platformdirs.unix.Unix.user_runtime_dir

(

self

)

: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.

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_state_dir()

str pip._vendor.platformdirs.unix.Unix.user_state_dir

(

self

)

:return: state directory tied to the user, e.g. ``~/.local/state/$appname/$version`` or
 ``$XDG_STATE_HOME/$appname/$version``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

user_videos_dir()

str pip._vendor.platformdirs.unix.Unix.user_videos_dir

(

self

)

:return: videos directory tied to the user, e.g. ``~/Videos``

Reimplemented from pip._vendor.platformdirs.api.PlatformDirsABC.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/platformdirs/unix.py