o
Xai}` @ sz d Z dZdeeeZddlZddlZejd dkZ e r eZ
ej drDddl Z e
d d Ze dr9dZne d rAd
Znd Znej Zd4d
dZd4ddZd4ddZd4ddZd5ddZd4ddZd5ddZG d d d eZd d Zd d! Zd"d# Zd$d% Z edkrzddl Z eZ W n1 e y z
dd&l!m"Z" eZ W n e y zddl#Z$e Z W n e y eZ Y nw Y nw Y nw e%d'kr9d(Z&d)Z'd*Z(e)d+e e)d, ee&e'd-d.Z*e(D ]
Z+e)d/e+e,e*e+f qe)d0 ee&e'Z*e(D ]
Z+e)d/e+e,e*e+f qe)d1 ee&Z*e(D ]Z+e)d/e+e,e*e+f qe)d2 ee&d d3Z*e(D ]Z+e)d/e+e,e*e+f q*dS dS )6zyUtilities for determining application-specific dirs.
See for details and usage.
) . Nr javaWindowswin32ZMacdarwinZlinux2Fc C s t dkr/|du r
| }|rdpd}tjt|}| r.|dur'tj||| }n/tj|| }n't dkrCtjd}| rBtj|| }ntdtjd }| rVtj|| }| ra|ratj||}|S )
aJ 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.
"appauthor" (only used on Windows) is the name of the
appauthor or distributing body for this application. Typically
it is the owning company name. This falls back to appname. You may
pass False to disable it.
"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 ".".
Only applied when appname is present.
"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:
Mac OS X: ~/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/".
r N
CSIDL_APPDATACSIDL_LOCAL_APPDATAFr z ~/Library/Application Support/
XDG_DATA_HOMEz~/.local/sharesystemospathnormpath_get_win_folderjoin
expandusergetenv)appname appauthorversionroamingconstr r /builddir/build/BUILDROOT/alt-python310-setuptools-58.3.0-4.el8.x86_64/opt/alt/python310/lib/python3.10/site-packages/pkg_resources/_vendor/appdirs.py
user_data_dir- s* r c s
t dkr)|du r
}tjtd} r(|dur!tj|| }nWtj| }nOt dkr=tjd} r.".
Only applied when appname is present.
"multipath" is an optional parameter only applicable to *nix
which indicates that the entire list of data dirs should be
returned. By default, the first item from XDG_DATA_DIRS is
returned, or '/usr/local/share/',
if XDG_DATA_DIRS is not set
Typical site data directories are:
Mac OS X: /Library/Application Support/
Unix: /usr/local/share/ or /usr/share/
Win XP: C:\Documents and Settings\All Users\Application Data\\
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.)
Win 7: C:\ProgramData\\ # Hidden, but writeable on Win 7.
For Unix, this is using the $XDG_DATA_DIRS[0] default.
WARNING: Do not use this on Windows. See the Vista-Fail note above for why.
r NCSIDL_COMMON_APPDATAFr z /Library/Application Support
XDG_DATA_DIRSz/usr/local/sharez
/usr/sharec S g | ] }t j|t jqS r r r r rstripsep.0xr r r
z!site_data_dir..c g | ]
}t j| gqS r r r# r r$ r r r r' r )
r r r r r r r r pathsepsplitr r r multipathr Zpathlistr r+ r
site_data_dird s< r1 c C X t dv r t| |d|}ntdtjd}| r tj|| }| r*|r*tj||}|S )a 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.
"appauthor" (only used on Windows) is the name of the
appauthor or distributing body for this application. Typically
it is the owning company name. This falls back to appname. You may
pass False to disable it.
"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 ".".
Only applied when appname is present.
"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 config directories are:
Mac OS X: same as user_data_dir
Unix: ~/.config/ # or in $XDG_CONFIG_HOME, if defined
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 NXDG_CONFIG_HOMEz ~/.configr r r r r r r r r r r r r r r user_config_dir s r7 c s t dv rt |} r|rtj||}|S tdd}dd |tjD } r;|r2tj | fdd|D }|rEtj|}|S |d }|S )a Return full path to the user-shared data dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"appauthor" (only used on Windows) is the name of the
appauthor or distributing body for this application. Typically
it is the owning company name. This falls back to appname. You may
pass False to disable it.
"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 ".".
Only applied when appname is present.
"multipath" is an optional parameter only applicable to *nix
which indicates that the entire list of config dirs should be
returned. By default, the first item from XDG_CONFIG_DIRS is
returned, or '/etc/xdg/', if XDG_CONFIG_DIRS is not set
Typical site config directories are:
Mac OS X: same as site_data_dir
Unix: /etc/xdg/ or $XDG_CONFIG_DIRS[i]/ for each value in
$XDG_CONFIG_DIRS
Win *: same as site_data_dir
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.)
For Unix, this is using the $XDG_CONFIG_DIRS[0] default, if multipath=False
WARNING: Do not use this on Windows. See the Vista-Fail note above for why.
r3 XDG_CONFIG_DIRSz/etc/xdgc S r r r! r$ r r r r' r( z#site_config_dir..c r) r r* r$ r+ r r r' r, r )r r1 r r r r r. r- r/ r r+ r site_config_dir s
r9 Tc C s t dkr2|du r
| }tjtd}| r1|dur!tj||| }ntj|| }|r1tj|d}n't dkrFtjd}| rEtj|| }ntdtjd }| rYtj|| }| rd|rdtj||}|S )
a Return full path to the user-specific cache dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"appauthor" (only used on Windows) is the name of the
appauthor or distributing body for this application. Typically
it is the owning company name. This falls back to appname. You may
pass False to disable it.
"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 ".".
Only applied when appname is present.
"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/
Unix: ~/.cache/ (XDG default)
Win XP: C:\Documents and Settings\\Local Settings\Application Data\\\Cache
Vista: 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` above). 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.
This can be disabled with the `opinion=False` option.
r Nr FCacher z~/Library/CachesXDG_CACHE_HOMEz~/.cacher
r r r opinionr r r r user_cache_dir s, ! r> c C r2 )a Return full path to the user-specific state dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"appauthor" (only used on Windows) is the name of the
appauthor or distributing body for this application. Typically
it is the owning company name. This falls back to appname. You may
pass False to disable it.
"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 ".".
Only applied when appname is present.
"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 state directories are:
Mac OS X: same as user_data_dir
Unix: ~/.local/state/ # or in $XDG_STATE_HOME, if defined
Win *: same as user_data_dir
For Unix, we follow this Debian proposal
to extend the XDG spec and support $XDG_STATE_HOME.
That means, by default "~/.local/state/".
r3 NXDG_STATE_HOMEz~/.local/stater5 r6 r r r user_state_dir: s r@ c C s t dkrtjtjd| }n't dkr&t| ||}d}|r%tj|d}nt| ||}d}|r7tj|d}| rB|rBtj||}|S )a Return full path to the user-specific log dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"appauthor" (only used on Windows) is the name of the
appauthor or distributing body for this application. Typically
it is the owning company name. This falls back to appname. You may
pass False to disable it.
"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 ".".
Only applied when appname is present.
"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 log directories are:
Mac OS X: ~/Library/Logs/
Unix: ~/.cache//log # or under $XDG_CACHE_HOME if defined
Win XP: C:\Documents and Settings\\Local Settings\Application Data\\\Logs
Vista: C:\Users\\AppData\Local\\\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.
r z~/Library/Logsr FZLogslog)r r r r r r r> r< r r r user_log_dird s$
rB c @ sr e Zd ZdZ dddZedd Zedd Zed
d Zed d
Z edd Z
edd Z edd Z dS )AppDirsz1Convenience wrapper for getting application dirs.NFc C s" || _ || _|| _|| _|| _d S )N)r r r r r0 )selfr r r r r0 r r r __init__ s
zAppDirs.__init__c C t | j| j| j| jdS N)r r )r r r r r rD r r r r
zAppDirs.user_data_dirc C rF N)r r0 )r1 r r r r0 rH r r r r1 rI zAppDirs.site_data_dirc C rF rG )r7 r r r r rH r r r r7 rI zAppDirs.user_config_dirc C rF rJ )r9 r r r r0 rH r r r r9 rI zAppDirs.site_config_dirc C t | j| j| jdS Nr )r> r r r rH r r r r>
zAppDirs.user_cache_dirc C rK rL )r@ r r r rH r r r r@ rN zAppDirs.user_state_dirc C rK rL )rB r r r rH r r r rB rN zAppDirs.user_log_dir)NNNFF)
__name__
__module__ __qualname____doc__rE propertyr r1 r7 r9 r> r@ rB r r r r rC s&
rC c C sH t rddl}nddl}dddd| }||jd}|||\}}|S )zThis 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 AppDatar
r r z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)PY3winreg_winregOpenKeyHKEY_CURRENT_USER QueryValueEx)
csidl_namerW Zshell_folder_namekeydirtyper r r _get_win_folder_from_registry s
r_ c C s ddl m}m} |dt|| dd}z3t|}d}|D ] }t|dkr(d} nq |rDz
dd l}||}W W |S t yC Y W |S w W |S t
yP Y |S w )Nr )shellconshellF T) win32com.shellr` ra SHGetFolderPathgetattrunicodeordwin32apiGetShortPathName ImportError UnicodeError)r[ r` ra r]
has_high_charcrh r r r _get_win_folder_with_pywin32 s2 rn c C s dd l }dddd| }|d}|jjd |d d| d}|D ] }t|dkr,d } nq |r@|d}|jj|j|dr@|}|jS )
Nr # rT i Frb T) ctypescreate_unicode_bufferwindllZshell32ZSHGetFolderPathWrg Zkernel32ZGetShortPathNameWvalue)r[ rr Z csidl_constbufrl rm Zbuf2r r r _get_win_folder_with_ctypes s(
rw c C s dd l }ddlm} ddlm} |jjd }|d|}|jj }|
d t |j | d |j j
| |j| d}d}|D ] } t| dkrJd } nq>|ri|d|}|jj }
|
|||ri|j| d}|S )
Nr )jna)r rm Frb T)arrayZcom.sunrx Zcom.sun.jna.platformr ZWinDefZMAX_PATHZzerosZShell32ZINSTANCErd re ZShlObjZSHGFP_TYPE_CURRENTZNativeZtoStringtostringr" rg ZKernel32ri ) r[ r{ rx r Zbuf_sizerv ra r] rl rm Zkernelr r r _get_win_folder_with_jna s( r} )rt __main__ZMyAppZ MyCompany)r r7 r> r@ rB r1 r9 z-- app dirs %s --z%-- app dirs (with optional 'version')z1.0rM z%s: %sz)
-- app dirs (without optional 'version')z+
-- app dirs (without optional 'appauthor')z(
-- app dirs (with disabled 'appauthor'))r )NNNF)NNNT)-rR __version_info__r mapstr __version__sysr version_inforU rf platform
startswithjava_veros_namer r r1 r7 r9 r> r@ rB objectrC r_ rn rw r} rc Zwin32comr rj rr rt Z com.sun.jnacomrO r r propsprintdirspropre r r r r s
7
B
(
3
9
*30