e7 jdZdZdeeeZddlZddlZejddkZ e reZ Gdde Z dd Z d d Zd!d Zd!d ZGddeZGddeZdZdZdZejdkr( ddlZeZn #e$r ddlZeZn #e$reZYnwxYwYnwxYwedkrtdZdZdZ e!deeedZ"e D]Z#e!e#de$e"e#e!deeeZ"e D]Z#e!e#de$e"e#dSdS)"zyUtilities for determining application-specific dirs. See for details and usage. ).rNceZdZdS) AppDirsErrorN)__name__ __module__ __qualname__6lib/python3.11/site-packages/repo_cli/utils/appdirs.pyrrsDr rFcttjdrF|td|rdpd}tjt|||}ntjdkr>tjtjd|}nbtjt j dtjd | }|r tj||}|S) a}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 ".". "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: ~/.config/ # or in $XDG_CONFIG_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_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/" instead of "~/.local/share/". winN#must specify 'appauthor' on Windows CSIDL_APPDATACSIDL_LOCAL_APPDATAdarwinz~/Library/Application Support/XDG_CONFIG_HOMEz ~/.config sysplatform startswithrospathjoin_get_win_folder expandusergetenvlower)appname appauthorversionroamingconstrs r user_data_dirr&s@ |u%%   DEE E+OD/Dw||OE22IwGG  ! !w|| G  ? @ @'  w|| I'););K)H)H I I MMOO  +w||D'** Kr ctjdr@|tdtjtd||}netjdkr>tjtjd|}nd| z}|r tj||}|S)amReturn 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 ".". Typical user data directories are: Mac OS X: /Library/Application Support/ Unix: /etc/xdg/ 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_CONFIG_DIRS[0] default. WARNING: Do not use this on Windows. See the Vista-Fail note above for why. rNrCSIDL_COMMON_APPDATArz/Library/Application Supportz /etc/xdg/) rrrrrrrrrr )r!r"r#rs r site_data_dirr)Rs. |u%% -  DEE Ew||O,BCCYPWXX  ! !w||BG../MNNPWXXW]]__,+w||D'** Kr Tctjdrb|tdtjtd||}|r tj|d}ntjdkr>tjtjd|}nbtjt j dtjd | }|r tj||}|S) aYReturn 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 ".". "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. rNrrCacherz~/Library/CachesXDG_CACHE_HOMEz~/.cacherr!r"r#opinionrs ruser_cache_dirr/xs< |u%%   DEE Ew||O,ABBIwWW  /7<<g..D  ! !w||BG../ABBGLLw|| I&(:(::(F(F G G  +w||D'** Kr ctjdkr>tjtjd|}n{tjdkr6t |||}d}|r tj|d}n5t|||}d}|r tj|d}|r tj||}|S)aReturn 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 ".". "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/ 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. rz~/Library/Logswin32FLogslog)rrrrrrr&r/r-s r user_log_dirr4s: |xw||BG../?@@'JJ  Wi99  .7<<f--Dgy'::  -7<<e,,D+w||D'** Kr cleZdZdZedZedZedZedZdS) EnvAppDirsc0||_||_||_dSN)r!r" root_path)selfr!r"r9s r__init__zEnvAppDirs.__init__s ""r cLtj|jdSNdatarrrr9r:s rr&zEnvAppDirs.user_data_dirw||DNF333r cLtj|jdSr=r?r@s rr)zEnvAppDirs.site_data_dirrAr cLtj|jdS)Ncacher?r@s rr/zEnvAppDirs.user_cache_dirsw||DNG444r cLtj|jdS)Nr3r?r@s rr4zEnvAppDirs.user_log_dirsw||DNE222r N) r r r r;propertyr&r)r/r4r r rr6r6s### 44X444X455X533X333r r6creZdZdZd dZedZedZedZedZ dS) AppDirsz1Convenience wrapper for getting application dirs.NFc>||_||_||_||_dSr8)r!r"r#r$)r:r!r"r#r$s rr;zAppDirs.__init__s" "  r cPt|j|j|j|jS)N)r#r$)r&r!r"r#r$r@s rr&zAppDirs.user_data_dirs* L$.$,     r cDt|j|j|jSNr#)r)r!r"r#r@s rr)zAppDirs.site_data_dirsT\4>4<PPPPr cDt|j|j|jSrL)r/r!r"r#r@s rr/zAppDirs.user_cache_dirsdlDNDLQQQQr cDt|j|j|jSrL)r4r!r"r#r@s rr4zAppDirs.user_log_dirsDL$.$,OOOOr )NF) r r r __doc__r;rFr&r)r/r4r r rrHrHs;;   X QQXQRRXRPPXPPPr rHcddl}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. rNAppDatazCommon AppDataz Local AppDatarr(rz@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)_winregOpenKeyHKEY_CURRENT_USER QueryValueEx) csidl_namerTshell_folder_namekeydirtypes r_get_win_folder_from_registryr] sn NNN# 0.  //!K  C$$S*;<rshhss3 01122   qQG     9   0000f####L,,,,^++++\33333333.PPPPPfPPP>*:6<7 <6 <<< < MMM9OO < < <;OOO < < zGI PE E 4555 77Iu 5 5 5D66 $$$d 3 3 345555 E 3444 77I & &D66 $$$d 3 3 34555566s6BB4B$#B4$B.+B4-B..B43B4