api.rst

API

User directories

These are user-specific (and, generally, user-writeable) directories.

User data directory

platformdirs.user_data_dir

platformdirs.user_data_path

User config directory

platformdirs.user_config_dir

platformdirs.user_config_path

Cache directory

platformdirs.user_cache_dir

platformdirs.user_cache_path

State directory

platformdirs.user_state_dir

platformdirs.user_state_path

Logs directory

platformdirs.user_log_dir

platformdirs.user_log_path

User documents directory

platformdirs.user_documents_dir

platformdirs.user_documents_path

Runtime directory

platformdirs.user_runtime_dir

platformdirs.user_runtime_path

Shared directories

These are system-wide (and, generally, read-only) directories.

Shared data directory

platformdirs.site_data_dir

platformdirs.site_data_path

Shared config directory

platformdirs.site_config_dir

platformdirs.site_config_path

Platforms

ABC

platformdirs.api.PlatformDirsABC

Android

platformdirs.android.Android

macOS

platformdirs.macos.MacOS

Unix (Linux)

platformdirs.unix.Unix

Windows

platformdirs.windows.Windows