This module implements the Choices system for user preferences.
The environment variable CHOICESPATH gives a list of directories to search
for choices. Changed choices are saved back to the first directory in the
The choices system is DEPRECATED. See choices.migrate().
- load(dir, leaf)
- When you want to load user choices, use this function. 'dir' is
the subdirectory within Choices where the choices are saved (usually
this will be the name of your program). 'leaf' is the file within it.
If serveral files are present, the most important one is returned. If
no files are there, returns None.
Eg ('Edit', 'Options') - > '/usr/local/share/Choices/Edit/Options'
- migrate(dir, site)
- Move <Choices>/dir (if it exists) to $XDG_CONFIG_HOME/site/dir, and
put a symlink in its place. The choices load and save functions cannot
be used for 'dir' after this; use the basedir module instead. 'site'
should be a domain name owned or managed by you. Eg:
- save(dir, leaf, create=1)
- Returns a path to save to, or None if saving is disabled.
If 'create' is FALSE then no directories are created. 'dir' and
'leaf' are as for load().