pip._vendor.platformdirs.api.PlatformDirsABC Class Reference

Inheritance diagram for pip._vendor.platformdirs.api.PlatformDirsABC:

Collaboration diagram for pip._vendor.platformdirs.api.PlatformDirsABC:

Public Member Functions
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)
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	user_data_path (self)
Path	site_data_path (self)
Path	user_config_path (self)
Path	site_config_path (self)
Path	user_cache_path (self)
Path	site_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
	appname
	appauthor
	version
	roaming
	multipath
	opinion
	ensure_exists
	user_data_dir
	site_data_dir
	user_config_dir
	site_config_dir
	user_cache_dir
	site_cache_dir
	user_state_dir
	user_log_dir
	user_documents_dir
	user_downloads_dir
	user_pictures_dir
	user_videos_dir
	user_music_dir
	user_runtime_dir

Protected Member Functions
str	_append_app_name_and_version (self, *str base)
None	_optionally_create_directory (self, str path)

Detailed Description

Abstract base class for platform directories.

Constructor & Destructor Documentation

__init__()

None pip._vendor.platformdirs.api.PlatformDirsABC.__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
	)

Create a new platform directory.

:param appname: See `appname`.
:param appauthor: See `appauthor`.
:param version: See `version`.
:param roaming: See `roaming`.
:param multipath: See `multipath`.
:param opinion: See `opinion`.
:param ensure_exists: See `ensure_exists`.

Member Function Documentation

site_cache_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.site_cache_dir

(

self

)

:return: cache directory shared by users

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

site_cache_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.site_cache_path

(

self

)

:return: cache path shared by users

Reimplemented in pip._vendor.platformdirs.unix.Unix.

site_config_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.site_config_dir

(

self

)

:return: config directory shared by the users

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

site_config_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.site_config_path

(

self

)

:return: config path shared by the users

Reimplemented in pip._vendor.platformdirs.unix.Unix.

site_data_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.site_data_dir

(

self

)

:return: data directory shared by users

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

site_data_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.site_data_path

(

self

)

:return: data path shared by users

Reimplemented in pip._vendor.platformdirs.unix.Unix.

user_cache_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_cache_dir

(

self

)

:return: cache directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_cache_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_cache_path

(

self

)

:return: cache path tied to the user

user_config_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_config_dir

(

self

)

:return: config directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_config_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_config_path

(

self

)

:return: config path tied to the user

user_data_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_data_dir

(

self

)

:return: data directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_data_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_data_path

(

self

)

:return: data path tied to the user

user_documents_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_documents_dir

(

self

)

:return: documents directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_documents_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_documents_path

(

self

)

:return: documents path tied to the user

user_downloads_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_downloads_dir

(

self

)

:return: downloads directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_downloads_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_downloads_path

(

self

)

:return: downloads path tied to the user

user_log_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_log_dir

(

self

)

:return: log directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_log_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_log_path

(

self

)

:return: log path tied to the user

user_music_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_music_dir

(

self

)

:return: music directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_music_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_music_path

(

self

)

:return: music path tied to the user

user_pictures_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_pictures_dir

(

self

)

:return: pictures directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_pictures_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_pictures_path

(

self

)

:return: pictures path tied to the user

user_runtime_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_runtime_dir

(

self

)

:return: runtime directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_runtime_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_runtime_path

(

self

)

:return: runtime path tied to the user

user_state_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_state_dir

(

self

)

:return: state directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_state_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_state_path

(

self

)

:return: state path tied to the user

user_videos_dir()

str pip._vendor.platformdirs.api.PlatformDirsABC.user_videos_dir

(

self

)

:return: videos directory tied to the user

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_videos_path()

Path pip._vendor.platformdirs.api.PlatformDirsABC.user_videos_path

(

self

)

:return: videos path tied to the user

Member Data Documentation

site_cache_dir

pip._vendor.platformdirs.api.PlatformDirsABC.site_cache_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

site_config_dir

pip._vendor.platformdirs.api.PlatformDirsABC.site_config_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

site_data_dir

pip._vendor.platformdirs.api.PlatformDirsABC.site_data_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_cache_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_cache_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_config_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_config_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_data_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_data_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_documents_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_documents_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_downloads_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_downloads_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_log_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_log_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_music_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_music_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_pictures_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_pictures_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_runtime_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_runtime_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_state_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_state_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

user_videos_dir

pip._vendor.platformdirs.api.PlatformDirsABC.user_videos_dir

Reimplemented in pip._vendor.platformdirs.android.Android, pip._vendor.platformdirs.macos.MacOS, pip._vendor.platformdirs.unix.Unix, and pip._vendor.platformdirs.windows.Windows.

---

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

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