pip._vendor.platformdirs.windows.Windows Class Reference

Inheritance diagram for pip._vendor.platformdirs.windows.Windows:

Collaboration diagram for pip._vendor.platformdirs.windows.Windows:

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)
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	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
	version
Public Attributes inherited from pip._vendor.platformdirs.api.PlatformDirsABC
	appname
	appauthor
	version
	roaming
	multipath
	opinion
	ensure_exists

Protected Member Functions
str	_append_parts (self, str path, *str|None opinion_value=None)
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

`MSDN on where to store app data files
<http://support.microsoft.com/default.aspx?scid=kb;en-us;310294#XSLTH3194121123120121120120>`_.
Makes use of the
`appname <platformdirs.api.PlatformDirsABC.appname>`,
`appauthor <platformdirs.api.PlatformDirsABC.appauthor>`,
`version <platformdirs.api.PlatformDirsABC.version>`,
`roaming <platformdirs.api.PlatformDirsABC.roaming>`,
`opinion <platformdirs.api.PlatformDirsABC.opinion>`,
`ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.

Member Function Documentation

site_cache_dir()

str pip._vendor.platformdirs.windows.Windows.site_cache_dir

(

self

)

:return: cache directory shared by users, e.g. ``C:\\ProgramData\\$appauthor\\$appname\\Cache\\$version``

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

site_config_dir()

str pip._vendor.platformdirs.windows.Windows.site_config_dir

(

self

)

:return: config directory shared by the users, same as `site_data_dir`

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

site_data_dir()

str pip._vendor.platformdirs.windows.Windows.site_data_dir

(

self

)

:return: data directory shared by users, e.g. ``C:\\ProgramData\\$appauthor\\$appname``

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

user_cache_dir()

str pip._vendor.platformdirs.windows.Windows.user_cache_dir

(

self

)

:return: cache directory tied to the user (if opinionated with ``Cache`` folder within ``$appname``) e.g.
 ``%USERPROFILE%\\AppData\\Local\\$appauthor\\$appname\\Cache\\$version``

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

user_config_dir()

str pip._vendor.platformdirs.windows.Windows.user_config_dir

(

self

)

:return: config directory tied to the user, same as `user_data_dir`

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

user_data_dir()

str pip._vendor.platformdirs.windows.Windows.user_data_dir

(

self

)

:return: data directory tied to the user, e.g.
 ``%USERPROFILE%\\AppData\\Local\\$appauthor\\$appname`` (not roaming) or
 ``%USERPROFILE%\\AppData\\Roaming\\$appauthor\\$appname`` (roaming)

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

user_documents_dir()

str pip._vendor.platformdirs.windows.Windows.user_documents_dir

(

self

)

:return: documents directory tied to the user e.g. ``%USERPROFILE%\\Documents``

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

user_downloads_dir()

str pip._vendor.platformdirs.windows.Windows.user_downloads_dir

(

self

)

:return: downloads directory tied to the user e.g. ``%USERPROFILE%\\Downloads``

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

user_log_dir()

str pip._vendor.platformdirs.windows.Windows.user_log_dir

(

self

)

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

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

user_music_dir()

str pip._vendor.platformdirs.windows.Windows.user_music_dir

(

self

)

:return: music directory tied to the user e.g. ``%USERPROFILE%\\Music``

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

user_pictures_dir()

str pip._vendor.platformdirs.windows.Windows.user_pictures_dir

(

self

)

:return: pictures directory tied to the user e.g. ``%USERPROFILE%\\Pictures``

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

user_runtime_dir()

str pip._vendor.platformdirs.windows.Windows.user_runtime_dir

(

self

)

:return: runtime directory tied to the user, e.g.
 ``%USERPROFILE%\\AppData\\Local\\Temp\\$appauthor\\$appname``

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

user_state_dir()

str pip._vendor.platformdirs.windows.Windows.user_state_dir

(

self

)

:return: state directory tied to the user, same as `user_data_dir`

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

user_videos_dir()

str pip._vendor.platformdirs.windows.Windows.user_videos_dir

(

self

)

:return: videos directory tied to the user e.g. ``%USERPROFILE%\\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/windows.py