Let us walk on the 3-isogeny graph
Loading...
Searching...
No Matches
Namespaces | Functions | Variables
pip._vendor.platformdirs Namespace Reference

Namespaces

namespace  __main__
 
namespace  android
 
namespace  api
 
namespace  macos
 
namespace  unix
 
namespace  version
 
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

◆ _set_platform_dir_class()

type[PlatformDirsABC] _set_platform_dir_class ( )
protected

Definition at line 24 of file __init__.py.

24def _set_platform_dir_class() -> type[PlatformDirsABC]:
25 if sys.platform == "win32":
26 from pip._vendor.platformdirs.windows import Windows as Result
27 elif sys.platform == "darwin":
28 from pip._vendor.platformdirs.macos import MacOS as Result
29 else:
30 from pip._vendor.platformdirs.unix import Unix as Result
31
32 if os.getenv("ANDROID_DATA") == "/data" and os.getenv("ANDROID_ROOT") == "/system":
33 if os.getenv("SHELL") or os.getenv("PREFIX"):
34 return Result
35
36 from pip._vendor.platformdirs.android import _android_folder
37
38 if _android_folder() is not None:
39 from pip._vendor.platformdirs.android import Android
40
41 return Android # return to avoid redefinition of result
42
43 return Result
44
45
pip._vendor.platformdirs.android
Definition android.py:1
pip._vendor.platformdirs.macos
Definition macos.py:1
pip._vendor.platformdirs.unix
Definition unix.py:1
pip._vendor.platformdirs.windows
Definition windows.py:1
i
for i
Definition prime_search.m:10

References i.

◆ site_cache_dir()

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

Definition at line 170 of file __init__.py.

176) -> str:
177 """
178 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
179 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
180 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
181 :param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
182 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
183 :returns: cache directory tied to the user
184 """
185 return PlatformDirs(
186 appname=appname,
187 appauthor=appauthor,
188 version=version,
189 opinion=opinion,
190 ensure_exists=ensure_exists,
191 ).site_cache_dir
192
193

References pip._vendor.platformdirs.PlatformDirs.

◆ site_cache_path()

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

Definition at line 387 of file __init__.py.

393) -> Path:
394 """
395 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
396 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
397 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
398 :param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
399 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
400 :returns: cache directory tied to the user
401 """
402 return PlatformDirs(
403 appname=appname,
404 appauthor=appauthor,
405 version=version,
406 opinion=opinion,
407 ensure_exists=ensure_exists,
408 ).site_cache_path
409
410

◆ site_config_dir()

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

Definition at line 122 of file __init__.py.

128) -> str:
129 """
130 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
131 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
132 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
133 :param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
134 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
135 :returns: config directory shared by the users
136 """
137 return PlatformDirs(
138 appname=appname,
139 appauthor=appauthor,
140 version=version,
141 multipath=multipath,
142 ensure_exists=ensure_exists,
143 ).site_config_dir
144
145

References pip._vendor.platformdirs.PlatformDirs.

◆ site_config_path()

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

Definition at line 363 of file __init__.py.

369) -> Path:
370 """
371 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
372 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
373 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
374 :param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
375 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
376 :returns: config path shared by the users
377 """
378 return PlatformDirs(
379 appname=appname,
380 appauthor=appauthor,
381 version=version,
382 multipath=multipath,
383 ensure_exists=ensure_exists,
384 ).site_config_path
385
386

◆ site_data_dir()

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

Definition at line 74 of file __init__.py.

80) -> str:
81 """
82 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
83 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
84 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
85 :param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
86 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
87 :returns: data directory shared by users
88 """
89 return PlatformDirs(
90 appname=appname,
91 appauthor=appauthor,
92 version=version,
93 multipath=multipath,
94 ensure_exists=ensure_exists,
95 ).site_data_dir
96
97

References pip._vendor.platformdirs.PlatformDirs.

◆ site_data_path()

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

Definition at line 315 of file __init__.py.

321) -> Path:
322 """
323 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
324 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
325 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
326 :param multipath: See `multipath <platformdirs.api.PlatformDirsABC.multipath>`.
327 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
328 :returns: data path shared by users
329 """
330 return PlatformDirs(
331 appname=appname,
332 appauthor=appauthor,
333 version=version,
334 multipath=multipath,
335 ensure_exists=ensure_exists,
336 ).site_data_path
337
338

◆ user_cache_dir()

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

Definition at line 146 of file __init__.py.

152) -> str:
153 """
154 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
155 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
156 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
157 :param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
158 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
159 :returns: cache directory tied to the user
160 """
161 return PlatformDirs(
162 appname=appname,
163 appauthor=appauthor,
164 version=version,
165 opinion=opinion,
166 ensure_exists=ensure_exists,
167 ).user_cache_dir
168
169

References pip._vendor.platformdirs.PlatformDirs.

◆ user_cache_path()

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

Definition at line 411 of file __init__.py.

417) -> Path:
418 """
419 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
420 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
421 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
422 :param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
423 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
424 :returns: cache path tied to the user
425 """
426 return PlatformDirs(
427 appname=appname,
428 appauthor=appauthor,
429 version=version,
430 opinion=opinion,
431 ensure_exists=ensure_exists,
432 ).user_cache_path
433
434

◆ user_config_dir()

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

Definition at line 98 of file __init__.py.

104) -> str:
105 """
106 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
107 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
108 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
109 :param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
110 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
111 :returns: config directory tied to the user
112 """
113 return PlatformDirs(
114 appname=appname,
115 appauthor=appauthor,
116 version=version,
117 roaming=roaming,
118 ensure_exists=ensure_exists,
119 ).user_config_dir
120
121

References pip._vendor.platformdirs.PlatformDirs.

◆ user_config_path()

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

Definition at line 339 of file __init__.py.

345) -> Path:
346 """
347 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
348 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
349 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
350 :param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
351 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
352 :returns: config path tied to the user
353 """
354 return PlatformDirs(
355 appname=appname,
356 appauthor=appauthor,
357 version=version,
358 roaming=roaming,
359 ensure_exists=ensure_exists,
360 ).user_config_path
361
362

◆ user_data_dir()

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

Definition at line 50 of file __init__.py.

56) -> str:
57 """
58 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
59 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
60 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
61 :param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
62 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
63 :returns: data directory tied to the user
64 """
65 return PlatformDirs(
66 appname=appname,
67 appauthor=appauthor,
68 version=version,
69 roaming=roaming,
70 ensure_exists=ensure_exists,
71 ).user_data_dir
72
73

References pip._vendor.platformdirs.PlatformDirs.

◆ user_data_path()

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

Definition at line 291 of file __init__.py.

297) -> Path:
298 """
299 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
300 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
301 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
302 :param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
303 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
304 :returns: data path tied to the user
305 """
306 return PlatformDirs(
307 appname=appname,
308 appauthor=appauthor,
309 version=version,
310 roaming=roaming,
311 ensure_exists=ensure_exists,
312 ).user_data_path
313
314

◆ user_documents_dir()

str user_documents_dir ( ) 
:returns: documents directory tied to the user

Definition at line 242 of file __init__.py.

242def user_documents_dir() -> str:
243 """:returns: documents directory tied to the user"""
244 return PlatformDirs().user_documents_dir
245
246

◆ user_documents_path()

Path user_documents_path ( ) 
:returns: documents path tied to the user

Definition at line 483 of file __init__.py.

483def user_documents_path() -> Path:
484 """:returns: documents path tied to the user"""
485 return PlatformDirs().user_documents_path
486
487

◆ user_downloads_dir()

str user_downloads_dir ( ) 
:returns: downloads directory tied to the user

Definition at line 247 of file __init__.py.

247def user_downloads_dir() -> str:
248 """:returns: downloads directory tied to the user"""
249 return PlatformDirs().user_downloads_dir
250
251

◆ user_downloads_path()

Path user_downloads_path ( ) 
:returns: downloads path tied to the user

Definition at line 488 of file __init__.py.

488def user_downloads_path() -> Path:
489 """:returns: downloads path tied to the user"""
490 return PlatformDirs().user_downloads_path
491
492

◆ user_log_dir()

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

Definition at line 218 of file __init__.py.

224) -> str:
225 """
226 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
227 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
228 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
229 :param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
230 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
231 :returns: log directory tied to the user
232 """
233 return PlatformDirs(
234 appname=appname,
235 appauthor=appauthor,
236 version=version,
237 opinion=opinion,
238 ensure_exists=ensure_exists,
239 ).user_log_dir
240
241

References pip._vendor.platformdirs.PlatformDirs.

◆ user_log_path()

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

Definition at line 459 of file __init__.py.

465) -> Path:
466 """
467 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
468 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
469 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
470 :param opinion: See `roaming <platformdirs.api.PlatformDirsABC.opinion>`.
471 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
472 :returns: log path tied to the user
473 """
474 return PlatformDirs(
475 appname=appname,
476 appauthor=appauthor,
477 version=version,
478 opinion=opinion,
479 ensure_exists=ensure_exists,
480 ).user_log_path
481
482

◆ user_music_dir()

str user_music_dir ( ) 
:returns: music directory tied to the user

Definition at line 262 of file __init__.py.

262def user_music_dir() -> str:
263 """:returns: music directory tied to the user"""
264 return PlatformDirs().user_music_dir
265
266

◆ user_music_path()

Path user_music_path ( ) 
:returns: music path tied to the user

Definition at line 503 of file __init__.py.

503def user_music_path() -> Path:
504 """:returns: music path tied to the user"""
505 return PlatformDirs().user_music_path
506
507

◆ user_pictures_dir()

str user_pictures_dir ( ) 
:returns: pictures directory tied to the user

Definition at line 252 of file __init__.py.

252def user_pictures_dir() -> str:
253 """:returns: pictures directory tied to the user"""
254 return PlatformDirs().user_pictures_dir
255
256

◆ user_pictures_path()

Path user_pictures_path ( ) 
:returns: pictures path tied to the user

Definition at line 493 of file __init__.py.

493def user_pictures_path() -> Path:
494 """:returns: pictures path tied to the user"""
495 return PlatformDirs().user_pictures_path
496
497

◆ user_runtime_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 
) 
: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

Definition at line 267 of file __init__.py.

273) -> str:
274 """
275 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
276 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
277 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
278 :param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
279 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
280 :returns: runtime directory tied to the user
281 """
282 return PlatformDirs(
283 appname=appname,
284 appauthor=appauthor,
285 version=version,
286 opinion=opinion,
287 ensure_exists=ensure_exists,
288 ).user_runtime_dir
289
290

◆ user_runtime_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 
) 
: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

Definition at line 508 of file __init__.py.

514) -> Path:
515 """
516 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
517 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
518 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
519 :param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
520 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
521 :returns: runtime path tied to the user
522 """
523 return PlatformDirs(
524 appname=appname,
525 appauthor=appauthor,
526 version=version,
527 opinion=opinion,
528 ensure_exists=ensure_exists,
529 ).user_runtime_path
530
531

◆ user_state_dir()

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

Definition at line 194 of file __init__.py.

200) -> str:
201 """
202 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
203 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
204 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
205 :param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
206 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
207 :returns: state directory tied to the user
208 """
209 return PlatformDirs(
210 appname=appname,
211 appauthor=appauthor,
212 version=version,
213 roaming=roaming,
214 ensure_exists=ensure_exists,
215 ).user_state_dir
216
217

References pip._vendor.platformdirs.PlatformDirs.

◆ user_state_path()

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

Definition at line 435 of file __init__.py.

441) -> Path:
442 """
443 :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
444 :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
445 :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
446 :param roaming: See `roaming <platformdirs.api.PlatformDirsABC.roaming>`.
447 :param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
448 :returns: state path tied to the user
449 """
450 return PlatformDirs(
451 appname=appname,
452 appauthor=appauthor,
453 version=version,
454 roaming=roaming,
455 ensure_exists=ensure_exists,
456 ).user_state_path
457
458

◆ user_videos_dir()

str user_videos_dir ( ) 
:returns: videos directory tied to the user

Definition at line 257 of file __init__.py.

257def user_videos_dir() -> str:
258 """:returns: videos directory tied to the user"""
259 return PlatformDirs().user_videos_dir
260
261

◆ user_videos_path()

Path user_videos_path ( ) 
:returns: videos path tied to the user

Definition at line 498 of file __init__.py.

498def user_videos_path() -> Path:
499 """:returns: videos path tied to the user"""
500 return PlatformDirs().user_videos_path
501
502

Variable Documentation

◆ AppDirs

type[PlatformDirsABC] AppDirs = PlatformDirs

Definition at line 47 of file __init__.py.

◆ PlatformDirs

type[PlatformDirsABC] PlatformDirs = _set_platform_dir_class()

Definition at line 46 of file __init__.py.

Referenced by pip._vendor.platformdirs.site_cache_dir(), pip._vendor.platformdirs.site_config_dir(), pip._vendor.platformdirs.site_data_dir(), pip._vendor.platformdirs.user_cache_dir(), pip._vendor.platformdirs.user_config_dir(), pip._vendor.platformdirs.user_data_dir(), pip._vendor.platformdirs.user_log_dir(), and pip._vendor.platformdirs.user_state_dir().