pip._vendor.platformdirs Namespace Reference

Namespaces
namespace	__main__
namespace	android
namespace	api
namespace	macos
namespace	unix
namespace	windows

Functions
type[PlatformDirsABC]	_set_platform_dir_class ()
str	user_data_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool ensure_exists=False)
str	site_data_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool multipath=False, bool ensure_exists=False)
str	user_config_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool ensure_exists=False)
str	site_config_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool multipath=False, bool ensure_exists=False)
str	user_cache_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
str	site_cache_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
str	user_state_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool ensure_exists=False)
str	user_log_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
str	user_documents_dir ()
str	user_downloads_dir ()
str	user_pictures_dir ()
str	user_videos_dir ()
str	user_music_dir ()
str	user_runtime_dir (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
Path	user_data_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool ensure_exists=False)
Path	site_data_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool multipath=False, bool ensure_exists=False)
Path	user_config_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool ensure_exists=False)
Path	site_config_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool multipath=False, bool ensure_exists=False)
Path	site_cache_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
Path	user_cache_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
Path	user_state_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool roaming=False, bool ensure_exists=False)
Path	user_log_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)
Path	user_documents_path ()
Path	user_downloads_path ()
Path	user_pictures_path ()
Path	user_videos_path ()
Path	user_music_path ()
Path	user_runtime_path (str|None appname=None, str|None|Literal[False] appauthor=None, str|None version=None, bool opinion=True, bool ensure_exists=False)

Variables
type[PlatformDirsABC]	PlatformDirs = _set_platform_dir_class()
type[PlatformDirsABC]	AppDirs = PlatformDirs

Detailed Description

Utilities for determining application-specific dirs. See <https://github.com/platformdirs/platformdirs> for details and
usage.

Function Documentation

site_cache_dir()

str pip._vendor.platformdirs.site_cache_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: cache directory tied to the user

site_cache_path()

Path pip._vendor.platformdirs.site_cache_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: cache directory tied to the user

site_config_dir()

str pip._vendor.platformdirs.site_config_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	multipath = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: config directory shared by the users

site_config_path()

Path pip._vendor.platformdirs.site_config_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	multipath = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: config path shared by the users

site_data_dir()

str pip._vendor.platformdirs.site_data_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	multipath = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: data directory shared by users

site_data_path()

Path pip._vendor.platformdirs.site_data_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	multipath = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param multipath: See `multipath <platformdirs.api.PlatformDirsABC.multipath>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: data path shared by users

user_cache_dir()

str pip._vendor.platformdirs.user_cache_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: cache directory tied to the user

user_cache_path()

Path pip._vendor.platformdirs.user_cache_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: cache path tied to the user

user_config_dir()

str pip._vendor.platformdirs.user_config_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	roaming = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: config directory tied to the user

user_config_path()

Path pip._vendor.platformdirs.user_config_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	roaming = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: config path tied to the user

user_data_dir()

str pip._vendor.platformdirs.user_data_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	roaming = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: data directory tied to the user

user_data_path()

Path pip._vendor.platformdirs.user_data_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	roaming = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: data path tied to the user

user_documents_dir()

str pip._vendor.platformdirs.user_documents_dir

(

)

:returns: documents directory tied to the user

user_documents_path()

Path pip._vendor.platformdirs.user_documents_path

(

)

:returns: documents path tied to the user

user_downloads_dir()

str pip._vendor.platformdirs.user_downloads_dir

(

)

:returns: downloads directory tied to the user

user_downloads_path()

Path pip._vendor.platformdirs.user_downloads_path

(

)

:returns: downloads path tied to the user

user_log_dir()

str pip._vendor.platformdirs.user_log_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: log directory tied to the user

user_log_path()

Path pip._vendor.platformdirs.user_log_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: log path tied to the user

user_music_dir()

str pip._vendor.platformdirs.user_music_dir

(

)

:returns: music directory tied to the user

user_music_path()

Path pip._vendor.platformdirs.user_music_path

(

)

:returns: music path tied to the user

user_pictures_dir()

str pip._vendor.platformdirs.user_pictures_dir

(

)

:returns: pictures directory tied to the user

user_pictures_path()

Path pip._vendor.platformdirs.user_pictures_path

(

)

:returns: pictures path tied to the user

user_runtime_dir()

str pip._vendor.platformdirs.user_runtime_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: runtime directory tied to the user

user_runtime_path()

Path pip._vendor.platformdirs.user_runtime_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	opinion = True,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: runtime path tied to the user

user_state_dir()

str pip._vendor.platformdirs.user_state_dir	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	roaming = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: state directory tied to the user

user_state_path()

Path pip._vendor.platformdirs.user_state_path	(	str | None	appname = None,
		str | None | Literal[False]	appauthor = None,
		str | None	version = None,
		bool	roaming = False,
		bool	ensure_exists = False
	)

:param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
:param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: state path tied to the user

user_videos_dir()

str pip._vendor.platformdirs.user_videos_dir

(

)

:returns: videos directory tied to the user

user_videos_path()

Path pip._vendor.platformdirs.user_videos_path

(

)

:returns: videos path tied to the user