appdirs 1.4.4

问题

你的应用程序应该使用哪个目录来存储用户数据？如果在Mac OS X上运行，你应该使用

~/Library/Application Support/<AppName>

如果在Windows上（至少是英文Win XP），那应该是

C:\Documents and Settings\<User>\Application Data\Local Settings\<AppAuthor>\<AppName>

或者可能是

C:\Documents and Settings\<User>\Application Data\<AppAuthor>\<AppName>

用于漫游配置文件，但这又是另一个故事了。

在Linux（和其他类Unix系统）上，根据XDG规范，目录是

~/.local/share/<AppName>

appdirs 来拯救

这种类型的事情正是appdirs模块的作用所在。appdirs将帮助您选择适当的

• 用户数据目录（user_data_dir）

• 用户配置目录（user_config_dir）

• 用户缓存目录（user_cache_dir）

• 站点数据目录（site_data_dir）

• 站点配置目录（site_config_dir）

• 用户日志目录（user_log_dir）

以及

• 是一个单模块，因此其他Python包可以包含它们自己的私有副本

• 对使用的目录名有一定的观点。在文档和代码中寻找“OPINION”，以了解何时应用了观点。

一些示例输出

在Mac OS X上

>>> from appdirs import *
>>> appname = "SuperApp"
>>> appauthor = "Acme"
>>> user_data_dir(appname, appauthor)
'/Users/trentm/Library/Application Support/SuperApp'
>>> site_data_dir(appname, appauthor)
'/Library/Application Support/SuperApp'
>>> user_cache_dir(appname, appauthor)
'/Users/trentm/Library/Caches/SuperApp'
>>> user_log_dir(appname, appauthor)
'/Users/trentm/Library/Logs/SuperApp'

在Windows 7上

>>> from appdirs import *
>>> appname = "SuperApp"
>>> appauthor = "Acme"
>>> user_data_dir(appname, appauthor)
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
>>> user_data_dir(appname, appauthor, roaming=True)
'C:\\Users\\trentm\\AppData\\Roaming\\Acme\\SuperApp'
>>> user_cache_dir(appname, appauthor)
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Cache'
>>> user_log_dir(appname, appauthor)
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Logs'

在Linux上

>>> from appdirs import *
>>> appname = "SuperApp"
>>> appauthor = "Acme"
>>> user_data_dir(appname, appauthor)
'/home/trentm/.local/share/SuperApp
>>> site_data_dir(appname, appauthor)
'/usr/local/share/SuperApp'
>>> site_data_dir(appname, appauthor, multipath=True)
'/usr/local/share/SuperApp:/usr/share/SuperApp'
>>> user_cache_dir(appname, appauthor)
'/home/trentm/.cache/SuperApp'
>>> user_log_dir(appname, appauthor)
'/home/trentm/.cache/SuperApp/log'
>>> user_config_dir(appname)
'/home/trentm/.config/SuperApp'
>>> site_config_dir(appname)
'/etc/xdg/SuperApp'
>>> os.environ['XDG_CONFIG_DIRS'] = '/etc:/usr/local/etc'
>>> site_config_dir(appname, multipath=True)
'/etc/SuperApp:/usr/local/etc/SuperApp'

AppDirs为了方便

>>> from appdirs import AppDirs
>>> dirs = AppDirs("SuperApp", "Acme")
>>> dirs.user_data_dir
'/Users/trentm/Library/Application Support/SuperApp'
>>> dirs.site_data_dir
'/Library/Application Support/SuperApp'
>>> dirs.user_cache_dir
'/Users/trentm/Library/Caches/SuperApp'
>>> dirs.user_log_dir
'/Users/trentm/Library/Logs/SuperApp'

按版本隔离

如果您正在使用多个版本的您的应用程序，并且希望能够并行运行，那么您可能想要对这些目录进行版本隔离

>>> from appdirs import AppDirs
>>> dirs = AppDirs("SuperApp", "Acme", version="1.0")
>>> dirs.user_data_dir
'/Users/trentm/Library/Application Support/SuperApp/1.0'
>>> dirs.site_data_dir
'/Library/Application Support/SuperApp/1.0'
>>> dirs.user_cache_dir
'/Users/trentm/Library/Caches/SuperApp/1.0'
>>> dirs.user_log_dir
'/Users/trentm/Library/Logs/SuperApp/1.0'

appdirs 更新日志