j@^UdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z m Z ddl mZe rdd lmZd Zd ed <Gd deZd=dZd>dZdddddddddd Zded <d?d"Zd=d#Zd$d%d&d'd(d)d*d+d,d-d.d/d0d1d2Zd3ed4<ed@d6Zd=d7Zd@d8ZeZd=d9ZdAd<ZdgZ dS)BzWindows.) annotationsN)cache)Path) TYPE_CHECKINGFinal)PlatformDirsABC)Callablei@z Final[int]_KF_FLAG_DONT_VERIFYceZdZdZed%dZddd&d Zed%d Zed%d Zed%d Z ed%dZ ed%dZ ed%dZ ed%dZ ed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%dZed%d Zed%d!Zed%d"Zed%d#Zed%d$Z dS)'Windowsa`MSDN on where to store app data files `_. Makes use of the `appname `, `appauthor `, `version `, `roaming `, `opinion `, `ensure_exists `. returnstrc|jrdnd}tjt |}||S)zData directory tied to the user, e.g. ``%USERPROFILE%\AppData\Local\$appauthor\$appname`` (not roaming) or ``%USERPROFILE%\AppData\Roaming\$appauthor\$appname`` (roaming). CSIDL_APPDATACSIDL_LOCAL_APPDATA)roamingospathnormpathget_win_folder _append_parts)selfconstrs EC:\Projects\Historical\venv\Lib\site-packages\platformdirs/windows.py user_data_dirzWindows.user_data_dirsF$(<J5Jwu 5 566!!$'''N opinion_valuerr str | Nonec~g}|jr|jdur#|jp|j}||||j||jr|||jr||jt jj|g|R}||d|S)NFprivate) appname appauthorappendopinionversionrrjoin_optionally_create_directory)rrrparamsauthors rrzWindows._append_parts&s < ,~U**74< f%%% MM$, ' ' '(T\( m,,,| , dl+++w|D*6*** ))$)>>> rctjtd}||S)zLData directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname``.CSIDL_COMMON_APPDATArrrrrrrs r site_data_dirzWindows.site_data_dir5s6w/E F FGG!!$'''rc|jS)z;Config directory tied to the user, same as `user_data_dir`.rrs ruser_config_dirzWindows.user_config_dir; !!rc|jS)z:Config directory shared by users, same as `site_data_dir`.r1r4s rsite_config_dirzWindows.site_config_dir@r6rctjtd}||dS)zCache directory tied to the user (if opinionated with ``Cache`` folder within ``$appname``) e.g. ``%USERPROFILE%\AppData\Local\$appauthor\$appname\Cache\$version``.rCacherr/r0s ruser_cache_dirzWindows.user_cache_dirEs;w/D E EFF!!$g!>>>rctjtd}||dS)z\Cache directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname\Cache\$version``.r.r;rr/r0s rsite_cache_dirzWindows.site_cache_dirKs;w/E F FGG!!$g!>>>rc|jS)z:State directory tied to the user, same as `user_data_dir`.r3r4s ruser_state_dirzWindows.user_state_dirQr6rc|jS)z9State directory shared by users, same as `site_data_dir`.r8r4s rsite_state_dirzWindows.site_state_dirVr6rc|j}|jr7tj|d}||d|S)z_Log directory tied to the user, same as `user_data_dir` if not opinionated else ``Logs`` in it.LogsFr")rr'rrr)r*r0s r user_log_dirzWindows.user_log_dir[J! < C7<<f--D  - -dE - B B B rc|j}|jr7tj|d}||d|S)z^Log directory shared by users, same as `site_data_dir` if not opinionated else ``Logs`` in it.rDFr")r1r'rrr)r*r0s r site_log_dirzWindows.site_log_dirdrFrcZtjtdS)zFDocuments directory tied to the user e.g. ``%USERPROFILE%\Documents``.CSIDL_PERSONALrrrrr4s ruser_documents_dirzWindows.user_documents_dirm#w/? @ @AAArcZtjtdS)zFDownloads directory tied to the user e.g. ``%USERPROFILE%\Downloads``.CSIDL_DOWNLOADSrKr4s ruser_downloads_dirzWindows.user_downloads_dirr#w/@ A ABBBrcZtjtdS)zDPictures directory tied to the user e.g. ``%USERPROFILE%\Pictures``.CSIDL_MYPICTURESrKr4s ruser_pictures_dirzWindows.user_pictures_dirws#w/A B BCCCrcZtjtdS)z@Videos directory tied to the user e.g. ``%USERPROFILE%\Videos``. CSIDL_MYVIDEOrKr4s ruser_videos_dirzWindows.user_videos_dir|"w ? ?@@@rcZtjtdS)z>Music directory tied to the user e.g. ``%USERPROFILE%\Music``. CSIDL_MYMUSICrKr4s ruser_music_dirzWindows.user_music_dirrXrcZtjtdS)zCDesktop directory tied to the user, e.g. ``%USERPROFILE%\Desktop``.CSIDL_DESKTOPDIRECTORYrKr4s ruser_desktop_dirzWindows.user_desktop_dirs#w/G H HIIIrcztjtjdS)zEProjects directory tied to the user, e.g. ``%USERPROFILE%\Projects``.z ~/Projects)rrr expanduserr4s ruser_projects_dirzWindows.user_projects_dirs*w 2 2< @ @AAArcZtjtdS)z0Public share directory e.g. ``C:\Users\Public``. CSIDL_PUBLICrKr4s ruser_publicshare_dirzWindows.user_publicshare_dirs"w~ > >???rcZtjtdS)zTTemplates directory tied to the user e.g. ``%APPDATA%\Microsoft\Windows\Templates``.CSIDL_TEMPLATESrKr4s ruser_templates_dirzWindows.user_templates_dirrQrc tjtt t ddz dz dz S)zQFonts directory tied to the user e.g. ``%LOCALAPPDATA%\Microsoft\Windows\Fonts``.r Microsoftr Fonts)rrrrrrr4s ruser_fonts_dirzWindows.user_fonts_dirsEwD8M)N)N$O$OR]$]`i$ils$s t tuuurc|jS)zCPreference directory tied to the user, same as ``user_config_dir``.)r5r4s ruser_preference_dirzWindows.user_preference_dirs ##rcZtjtdS)zABin directory tied to the user, e.g. ``%LOCALAPPDATA%\Programs``.CSIDL_USER_PROGRAM_FILESrKr4s r user_bin_dirzWindows.user_bin_dirs#w/I J JKKKrctjtjt ddS)z;Bin directory shared by users, e.g. ``C:\ProgramData\bin``.r.bin)rrrr)rr4s r site_bin_dirzWindows.site_bin_dirs4w ^Runtime directory shared by users, same as `user_runtime_dir`.)r|r4s rsite_runtime_dirzWindows.site_runtime_dirs $$r)rr)rrrr rr)!__name__ __module__ __qualname____doc__propertyrrr1r5r9r<r>r@rBrErHrLrPrTrWr[r^rardrgrkrmrprsrvryr|r~rrr r s(((X( GK      (((X( """X""""X"???X? ???X? """X""""X"XXBBBXBCCCXCDDDXDAAAXAAAAXAJJJXJBBBXB@@@X@CCCXCvvvXv$$$X$LLLXL]]]X]BBBXBIIIXI(((X( %%%X%%%rr csidl_namerrct|}||Sdddd|}|d|}t|tj|x}sd|}t||S)z&Get folder from environment variables.NAPPDATAALLUSERSPROFILE LOCALAPPDATA)rr.rUnknown CSIDL name: zUnset environment variable: )(get_win_folder_if_csidl_name_not_env_varget ValueErrorrenviron)rresult env_var_namemsgs rget_win_folder_from_env_varsrs 5j A AF  # 1- c*oo  1Z11oojnn\22 2F;\;;oo Mrr ct|x}E|^}}tjjtjt |g|RS|dkrUtjdp5ttd j dz S|dkr~tjtjtjdp tjdpd d d d d SdS)zMGet a folder for a CSIDL name that does not exist as an environment variable.NrcPUBLIC~Publicrx PROGRAMDATArzC:\ProgramDatarir Start MenuPrograms) _ENV_VAR_SUBFOLDERSrrrr)r_non_empty_envrrrr`parent)renv_var_and_partsenv_varpartss rrrs044Z@@@M+%w|BG,,^G-D-DEENNNNN^##z~~h''X3tCyy/C/C/E/E/Lx/W+X+XX,,,w|| G  RZ^^M::tbjnnM^>_>_tct u u         4r) USERPROFILE Documents)r Downloads)rPictures)rVideos)rMusic)rDesktop)rrir rr)rrir Templates)rr) rJrOrSrVrZr]rurfroz!Final[dict[str, tuple[str, ...]]]rnamecftj|x}r|St|)N)rrrKeyError)rvalues rrrs. t$$$u 4..rc vddh}ddddddd d d d d dd |}|t|Stjdkrtddl}||vr|jn|j}||d5}| ||\}}dddn #1swxYwYt|S)zGet folder from the registry. This is a fallback technique at best. I'm not sure if using the registry for these guarantees us the correct answer for all CSIDL_* names. r.rxAppDatazCommon AppDataz Local AppDataPersonal&{374DE290-123F-4565-9164-39C4925E467B}z My PictureszMy VideozMy MusicrrzCommon Programsr) rr.rrJrOrSrVrZr]rurxrfNwin32rz@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders) rrsysplatformNotImplementedErrorwinregHKEY_LOCAL_MACHINEHKEY_CURRENT_USEROpenKey QueryValueExr)r machine_namesshell_folder_namerhkeykey directory_s rget_win_folder_from_registryrs? M # 0.$C)##"+$!2&   c*oo +J777 |w!!MMM)3m(C(C6 $ $IaD a b bCfi**30ABB 1CCCCCCCCCCCCCCC y>>s;B!!B%(B%z&{3EB685DB-65F9-4CF6-A03A-E3EF65729F3D}z&{62AB5D82-FDC1-4DC3-A9DD-070D1D495D97}z&{F1B32785-6FBA-4FCF-9D55-7B8E7F157091}z&{FDD39AD0-238F-46AF-ADB4-6C85480369C7}z&{33E28130-4E1E-4676-835A-98395C3BC3BB}z&{18989B1D-99B5-455B-841C-AB7C74E4DDFC}z&{4BD8D571-6D19-48D3-BE97-422220080E43}rz&{B4BFCC3A-DB2C-424C-B029-7FE99A87C641}z&{A77F5D77-2E2B-44C3-A6A2-ABA601054A51}z&{0139D44E-6AFE-49F2-8690-3DAFCAE6FFB8}z&{A63293E8-664E-48DB-A079-DF759E0509F7}z&{DFDF76A2-C82A-4D63-906A-5644AC457385}z&{5CD7AEE2-2219-4A67-B85D-6C9CE15660CB})rr.rrJrSrVrZrOr]rurxrfrcrozdict[str, str]_KNOWN_FOLDER_GUIDSCallable[[str], str]c tjdkrtddlm}m}m}m}mm G fdd||d|j _ j |gj _ dj_ jgj_ |d|j_ | j j| jgj_ d  fd }|S)zBuild the resolver once; a fresh ``_GUID`` per call leaks ctypes pointer types. See https://github.com/tox-dev/platformdirs/issues/501. rr)HRESULTPOINTER StructureWinDLLbyrefwintypescZeZdZdjfdjfdjfdjdzfgZdS)/_build_get_win_folder_via_ctypes.._GUIDData1Data2Data3Data4N)rrrDWORDWORDBYTE_fields_)rsr_GUIDrJsC hn % hm $ hm $ hma' (  rrole32Nshell32rrrct|}|d|}t|}|| } |t d||j}||d|}t||S)Nrz'SHGetKnownFolderPath returned NULL for ) rrrCLSIDFromStringLPWSTRSHGetKnownFolderPathr r CoTaskMemFree) r folder_guidrguidpath_ptrrrrrrrs rresolvez1_build_get_win_folder_via_ctypes..resolve\s)--j99  555CS// !uww k55;;777??$$$$UU4[[2FeeT\oo^^^ H%%% >HJHHCS// ! rrrrr)rrrctypesrrrrrrrrestype LPCOLESTRargtypesrLPVOIDrrHANDLEr) rrrrrrrrrrs @@@@@r _build_get_win_folder_via_ctypesr8ss |w!!           F7OOE$+E!&.&8''%..%IE""&E$,O#4E fYG+2G (-4WU^^X^X_^e^efnfu^v^v,wG )( Nrc0t|S)zGet folder via :func:`SHGetKnownFolderPath`. See https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath. )r)rs rget_win_folder_via_ctypesrss . + - -j 9 99rc ddl}tS#t$rYnwxYw ddl}tS#t$r t cYSwxYw)zjSelect the best method to resolve Windows folder paths: ctypes, then registry, then environment variables.rN)rr ImportErrorrrr)rrs r_pick_get_win_folderr|sy) )(      , ,+ ,,,++++,s )==cd|d}ttj|dx}r|St |S)zGet a Windows folder path, checking for ``WIN_PD_OVERRIDE_*`` environment variable overrides first. For example, ``CSIDL_LOCAL_APPDATA`` can be overridden by setting ``WIN_PD_OVERRIDE_LOCAL_APPDATA``. WIN_PD_OVERRIDE_CSIDL_) removeprefix_is_fully_qualifiedrrrstrip_resolve_win_folder)rroverrides rrrsd E!8!8!B!BDDGrz~~gr'B'B'H'H'J'JJ8KK z * **rrboolctj|\}}|dp#t|o|dS)N)\/)ntpath splitdrive startswithr)rdrivetails rrrsF#D))KE4   K ( ( ZT%[[-YT__[=Y=YZrr)rrrr )rrrr)rr)rrrr)!r __future__rrrr functoolsrpathlibrtypingrrapir collections.abcr r __annotations__r rrrrrrrrrrrr__all__rrrrsZ"""""" '''''''' )(((((($.----l%l%l%l%l%ol%l%l%^(*333.-8SG < : :     $$$$P>DC>@==?F>E?< H''$7777t:::: , , , , +*,, + + + +[[[[ r