appdirs#
Utilities for determining application-specific dirs.
See <ActiveState/appdirs> for details and usage.
Classes#
Convenience wrapper for getting application dirs. |
Functions#
|
Return full path to the user-specific data dir for this application. |
|
Return full path to the user-shared data dir for this application. |
|
Return full path to the user-specific cache dir for this application. |
|
Return full path to the user-specific log dir for this application. |
|
This is a fallback technique at best. I'm not sure if using the |
|
|
|
Attributes#
- __version_info__ = (1, 2, 0)#
- __version__#
- PY3#
- unicode#
- user_data_dir(appname, appauthor=None, version=None, roaming=False)#
Return full path to the user-specific data dir for this application.
"appname" is the name of application. "appauthor" (only required and used on Windows) is the name of the
appauthor or distributing body for this application. Typically it is the owning company name.
- "version" is an optional version path element to append to the
path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>".
- "roaming" (boolean, default False) can be set True to use the Windows
roaming appdata directory. That means that for users on a Windows network setup for roaming profiles, this user data will be sync'd on login. See <http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx> for a discussion of issues.
- Typical user data directories are:
Mac OS X: ~/Library/Application Support/<AppName> Unix: ~/.config/<appname> # or in $XDG_CONFIG_HOME if defined Win XP (not roaming): C:Documents and Settings<username>Application Data<AppAuthor><AppName> Win XP (roaming): C:Documents and Settings<username>Local SettingsApplication Data<AppAuthor><AppName> Win 7 (not roaming): C:Users<username>AppDataLocal<AppAuthor><AppName> Win 7 (roaming): C:Users<username>AppDataRoaming<AppAuthor><AppName>
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME. We don't use $XDG_DATA_HOME as that data dir is mostly used at the time of installation, instead of the application adding data during runtime. Also, in practice, Linux apps tend to store their data in "~/.config/<appname>" instead of "~/.local/share/<appname>".
- site_data_dir(appname, appauthor=None, version=None)#
Return full path to the user-shared data dir for this application.
"appname" is the name of application. "appauthor" (only required and used on Windows) is the name of the
appauthor or distributing body for this application. Typically it is the owning company name.
- "version" is an optional version path element to append to the
path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>".
- Typical user data directories are:
Mac OS X: /Library/Application Support/<AppName> Unix: /etc/xdg/<appname> Win XP: C:Documents and SettingsAll UsersApplication Data<AppAuthor><AppName> Vista: (Fail! "C:ProgramData" is a hidden system directory on Vista.) Win 7: C:ProgramData<AppAuthor><AppName> # Hidden, but writeable on Win 7.
For Unix, this is using the $XDG_CONFIG_DIRS[0] default.
WARNING: Do not use this on Windows. See the Vista-Fail note above for why.
- user_cache_dir(appname, appauthor=None, version=None, opinion=True)#
Return full path to the user-specific cache dir for this application.
"appname" is the name of application. "appauthor" (only required and used on Windows) is the name of the
appauthor or distributing body for this application. Typically it is the owning company name.
- "version" is an optional version path element to append to the
path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>".
- "opinion" (boolean) can be False to disable the appending of
"Cache" to the base app data dir for Windows. See discussion below.
- Typical user cache directories are:
Mac OS X: ~/Library/Caches/<AppName> Unix: ~/.cache/<appname> (XDG default) Win XP: C:Documents and Settings<username>Local SettingsApplication Data<AppAuthor><AppName>Cache Vista: C:Users<username>AppDataLocal<AppAuthor><AppName>Cache
On Windows the only suggestion in the MSDN docs is that local settings go in the CSIDL_LOCAL_APPDATA directory. This is identical to the non-roaming app data dir (the default returned by user_data_dir above). Apps typically put cache data somewhere under the given dir here. Some examples:
...MozillaFirefoxProfiles<ProfileName>Cache ...AcmeSuperAppCache1.0
OPINION: This function appends "Cache" to the CSIDL_LOCAL_APPDATA value. This can be disabled with the opinion=False option.
- user_log_dir(appname, appauthor=None, version=None, opinion=True)#
Return full path to the user-specific log dir for this application.
"appname" is the name of application. "appauthor" (only required and used on Windows) is the name of the
appauthor or distributing body for this application. Typically it is the owning company name.
- "version" is an optional version path element to append to the
path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be "<major>.<minor>".
- "opinion" (boolean) can be False to disable the appending of
"Logs" to the base app data dir for Windows, and "log" to the base cache dir for Unix. See discussion below.
- Typical user cache directories are:
Mac OS X: ~/Library/Logs/<AppName> Unix: ~/.cache/<appname>/log # or under $XDG_CACHE_HOME if defined Win XP: C:Documents and Settings<username>Local SettingsApplication Data<AppAuthor><AppName>Logs Vista: C:Users<username>AppDataLocal<AppAuthor><AppName>Logs
On Windows the only suggestion in the MSDN docs is that local settings go in the CSIDL_LOCAL_APPDATA directory. (Note: I'm interested in examples of what some windows apps use for a logs dir.)
OPINION: This function appends "Logs" to the CSIDL_LOCAL_APPDATA value for Windows and appends "log" to the user cache dir for Unix. This can be disabled with the opinion=False option.
- class AppDirs(appname, appauthor, version=None, roaming=False)#
Bases:
objectConvenience wrapper for getting application dirs.
- property user_data_dir#
- property site_data_dir#
- property user_cache_dir#
- property user_log_dir#
- _get_win_folder_from_registry(csidl_name)#
This is a fallback technique at best. I'm not sure if using the registry for this guarantees us the correct answer for all CSIDL_* names.
- _get_win_folder_with_pywin32(csidl_name)#
- _get_win_folder_with_ctypes(csidl_name)#
- _get_win_folder#
- appname = 'MyApp'#