platformdirs API reference

49 public APIs from platformdirs (tox-dev/platformdirs) — 2 classes, 32 functions, 15 methods. Signatures extracted by static analysis of the actual source.

Repository: tox-dev/platformdirs

Kind	Count
Classes	2
Functions	32
Methods	15

API list

funcsrc.platformdirs.__main__.main() -> None

Run the main entry point.

classsrc.platformdirs.android.Android

Platform directories for Android.

methodsrc.platformdirs.android.Android.site_bin_dir() -> str

Bin directory shared by users, same as `user_bin_dir`.

methodsrc.platformdirs.android.Android.site_log_dir() -> str

Log directory shared by users, same as `user_log_dir`.

methodsrc.platformdirs.android.Android.user_bin_dir() -> str

Bin directory tied to the user, e.g.

methodsrc.platformdirs.android.Android.user_config_dir() -> str

Config directory tied to the user, e.g.

methodsrc.platformdirs.android.Android.user_data_dir() -> str

Data directory tied to the user, e.g.

methodsrc.platformdirs.android.Android.user_desktop_dir() -> str

Desktop directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_documents_dir() -> str

Documents directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_downloads_dir() -> str

Downloads directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_fonts_dir() -> str

Fonts directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_music_dir() -> str

Music directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_pictures_dir() -> str

Pictures directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_projects_dir() -> str

Projects directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_publicshare_dir() -> str

Public share directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_templates_dir() -> str

Templates directory tied to the user e.g.

methodsrc.platformdirs.android.Android.user_videos_dir() -> str

Videos directory tied to the user e.g.

classsrc.platformdirs.macos.MacOS

Platform directories for the macOS operating system.

funcsrc.platformdirs.site_bin_dir() -> str

:returns: bin directory shared by users

funcsrc.platformdirs.site_bin_path() -> Path

:returns: bin path shared by users

funcsrc.platformdirs.user_applications_dir() -> str

:returns: applications directory tied to the user

funcsrc.platformdirs.user_applications_path() -> Path

:returns: applications path tied to the user

funcsrc.platformdirs.user_bin_dir() -> str

:returns: bin directory tied to the user

funcsrc.platformdirs.user_bin_path() -> Path

:returns: bin path tied to the user

funcsrc.platformdirs.user_desktop_dir() -> str

:returns: desktop directory tied to the user

funcsrc.platformdirs.user_desktop_path() -> Path

:returns: desktop path tied to the user

funcsrc.platformdirs.user_documents_dir() -> str

:returns: documents directory tied to the user

funcsrc.platformdirs.user_documents_path() -> Path

:returns: documents path tied to the user

funcsrc.platformdirs.user_downloads_dir() -> str

:returns: downloads directory tied to the user

funcsrc.platformdirs.user_downloads_path() -> Path

:returns: downloads path tied to the user

funcsrc.platformdirs.user_fonts_dir() -> str

:returns: fonts directory tied to the user

funcsrc.platformdirs.user_fonts_path() -> Path

:returns: fonts path tied to the user

funcsrc.platformdirs.user_music_dir() -> str

:returns: music directory tied to the user

funcsrc.platformdirs.user_music_path() -> Path

:returns: music path tied to the user

funcsrc.platformdirs.user_pictures_dir() -> str

:returns: pictures directory tied to the user

funcsrc.platformdirs.user_pictures_path() -> Path

:returns: pictures path tied to the user

funcsrc.platformdirs.user_preference_dir() -> str

:returns: preference directory tied to the user

funcsrc.platformdirs.user_preference_path() -> Path

:returns: preference path tied to the user

funcsrc.platformdirs.user_projects_dir() -> str

:returns: projects directory tied to the user

funcsrc.platformdirs.user_projects_path() -> Path

:returns: projects path tied to the user

funcsrc.platformdirs.user_publicshare_dir() -> str

:returns: public share directory tied to the user

funcsrc.platformdirs.user_publicshare_path() -> Path

:returns: public share path tied to the user

funcsrc.platformdirs.user_templates_dir() -> str

:returns: templates directory tied to the user

funcsrc.platformdirs.user_templates_path() -> Path

:returns: templates path tied to the user

funcsrc.platformdirs.user_videos_dir() -> str

:returns: videos directory tied to the user

funcsrc.platformdirs.user_videos_path() -> Path

:returns: videos path tied to the user

funcsrc.platformdirs.windows.get_win_folder_from_env_vars(csidl_name:str) -> str

Get folder from environment variables.

funcsrc.platformdirs.windows.get_win_folder_from_registry(csidl_name:str) -> str

Get folder from the registry.

funcsrc.platformdirs.windows.get_win_folder_via_ctypes(csidl_name:str) -> str

Get folder via :func:`SHGetKnownFolderPath`.

About this data

These signatures were extracted from the public source of tox-dev/platformdirs using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries