lib.xdg module

XDG Utilities

get_base_dir(xdg_type)[source]
Return type

Path

Returns

The base/general XDG user directory.

Parameters

xdg_type (Literal[‘cache’, ‘config’, ‘data’, ‘runtime’]) –

get_full_dir(xdg_type, *, up=0)[source]
Return type

Path

Returns

Full XDG user directory (including scriptname).

Parameters
  • xdg_type (Literal[‘cache’, ‘config’, ‘data’, ‘runtime’]) –

  • up (int) –

init_full_dir(xdg_type, *, up=0)[source]
Return type

Path

Returns

Full XDG user directory (including scriptname).

Side Effects:

Ensures the full XDG user directory exists before returning it.

Parameters
  • xdg_type (Literal[‘cache’, ‘config’, ‘data’, ‘runtime’]) –

  • up (int) –