Base Directories

save_data_path(resource...)

Ensure $XDG_DATA_HOME/<resource>/ exists, and return its path. 'resource' should normally be the name of your application or a shared resource. Use this when saving or updating application data.

load_data_paths(resource...)

Returns an iterator which gives each directory named 'resource' in the application data search path. Information provided by earlier directories should take precedence over later ones.

$XDG_DATA_HOME or the default, ~/.local/share

A list of directory paths in which application data may be stored, in preference order.

save_config_path(resource...)

Ensure $XDG_CONFIG_HOME/<resource>/ exists, and return its path. 'resource' should normally be the name of your application. Use this when saving configuration settings.

load_config_paths(resource...)

Returns an iterator which gives each directory named 'resource' in the configuration search path. Information provided by earlier directories should take precedence over later ones, and the user-specific config dir comes first.

function load_first_config(resource...)

Returns the first result from loadconfigpaths, or None if there is nothing to load.

$XDG_CONFIG_HOME or the default, ~/.config

A list of directory paths in which configuration may be stored, in preference order.

save_cache_path(resource...)

Ensure $XDG_CACHE_HOME/<resource>/ exists, and return its path. 'resource' should normally be the name of your application or a shared resource.

$XDG_CACHE_HOME or the default, ~/.cache

get_runtime_dir()

Returns the value of $XDG_RUNTIME_DIR, a directory path.

This directory is intended for 'user-specific non-essential runtime files and other file objects (such as sockets, named pipes, ...)', and 'communication and synchronization purposes'.