3
Pfk" @ s d Z ddlmZ ddlZddlZddlmZmZ ddlm Z m
Z
dd Z dd d
Z dd d
Z
dd Zdd Zdd ZeryddlZeZW n ek
r eZY nX dd ZdS )zd
This code was taken from https://github.com/ActiveState/appdirs and modified
to suit our purposes.
)absolute_importN)WINDOWS
expanduser)PY2 text_typec C s t r
Unix: ~/.cache/ (XDG default)
Windows: C:\Users\\AppData\Local\\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`). Apps
typically put cache data somewhere *under* the given dir here. Some
examples:
...\Mozilla\Firefox\Profiles\\Cache
...\Acme\SuperApp\Cache\1.0
OPINION: This function appends "Cache" to the `CSIDL_LOCAL_APPDATA` value.
CSIDL_LOCAL_APPDATAZCachedarwinz~/Library/CachesZXDG_CACHE_HOMEz~/.cache)r ospathnormpath_get_win_folderr
isinstancer _win_path_to_bytesjoinsysplatformr getenv)appnamer
r /usr/lib/python3.6/appdirs.pyuser_cache_dir s
r Fc C sh t r,|r dpd}tjjtjjt|| }n8tjdkrJtjjtd| }ntjjtj dtd| }|S )aS
Return full path to the user-specific data dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"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
for a discussion of issues.
Typical user data directories are:
macOS: ~/Library/Application Support/
Unix: ~/.local/share/ # or in
$XDG_DATA_HOME, if defined
Win XP (not roaming): C:\Documents and Settings\\ ...
...Application Data\
Win XP (roaming): C:\Documents and Settings\\Local ...
...Settings\Application Data\
Win 7 (not roaming): C:\Users\\AppData\Local\
Win 7 (roaming): C:\Users\\AppData\Roaming\
For Unix, we follow the XDG spec and support $XDG_DATA_HOME.
That means, by default "~/.local/share/".
CSIDL_APPDATAr r z ~/Library/Application Support/Z
XDG_DATA_HOMEz~/.local/share)
r r r
r r r r r r r )r roamingconstr
r r r
user_data_dir> s
r Tc C sH t rt| |d}n2tjdkr&t| }n tjdtd}tjj|| }|S )ar Return full path to the user-specific config dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default True) can be set False to not 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
for a discussion of issues.
Typical user data directories are:
macOS: same as user_data_dir
Unix: ~/.config/
Win *: same as user_data_dir
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME.
That means, by default "~/.config/".
)r r ZXDG_CONFIG_HOMEz ~/.config) r r r r r r r r
r )r r r
r r r user_config_dirj s
r c s t r&tjjtd}tjj| g}nVtjdkrBtjjd g}n:tjdd}|rn fdd|j tj
D }ng }|j d |S ) a Return a list of potential user-shared config dirs for this application.
"appname" is the name of application.
Typical user config directories are:
macOS: /Library/Application Support//
Unix: /etc or $XDG_CONFIG_DIRS[i]// for each value in
$XDG_CONFIG_DIRS
Win XP: C:\Documents and Settings\All Users\Application ...
...Data\ Vista: (Fail! "C:\ProgramData" is a hidden *system* directory
on Vista.)
Win 7: Hidden, but writeable on Win 7:
C:\ProgramData\ CSIDL_COMMON_APPDATAr z /Library/Application SupportZXDG_CONFIG_DIRSz/etc/xdgc s g | ]}t jjt| qS r )r r
r r ).0x)r r r
s z$site_config_dirs..z/etc) r r r
r r r r r r splitpathsepappend)r r
ZpathlistZxdg_config_dirsr )r r site_config_dirs s
r# c C s: ddl }dddd| }|j|jd}|j||\}}|S )z
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.
r NZAppDatazCommon AppDataz
Local AppData)r r r z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)_winregOpenKeyHKEY_CURRENT_USERZ QueryValueEx)
csidl_namer$ Zshell_folder_namekeyZ directoryZ_typer r r _get_win_folder_from_registry s r) c C s dddd| }t jd}t jjjd |d d| d}x |D ]}t|dkr:d }P q:W |rzt jd}t jjj|j|drz|}|jS )
N # )r r r i r F T) ctypesZcreate_unicode_bufferZwindllZshell32ZSHGetFolderPathWordZkernel32ZGetShortPathNameWvalue)r' Z csidl_constZbufZ
has_high_charcZbuf2r r r _get_win_folder_with_ctypes s
r2 c
C s6 x0dD ](}y
| j |S ttfk
r, Y qX qW | S )a Encode Windows paths to bytes. Only used on Python 2.
Motivation is to be consistent with other operating systems where paths
are also returned as bytes. This avoids problems mixing bytes and Unicode
elsewhere in the codebase. For more details and discussion see
.
If encoding using ASCII and MBCS fails, return the original Unicode path.
ASCIIMBCS)r3 r4 )encodeUnicodeEncodeError LookupError)r
encodingr r r r s
r )F)T)__doc__Z
__future__r r r Z
pip.compatr r Zpip._vendor.sixr r r r r r# r) r2 r. r ImportErrorr r r r r s$ 0
,
!(