a
lj @ s d dl Z d dlZd dlmZ d dlmZmZ ddlmZ G dd deZ e
e
dd d
Z e
e
dd d Z e
e
dd
dZ
ee
ge
f dddZedde ZdgZdS ) N) lru_cache)CallableOptional )PlatformDirsABCc @ s e Zd ZdZeedddZddeee eddd Zeedd
d Z eedd d
Z
eedddZ eedddZ eedddZ
eedddZeedddZeedddZdS )Windowsa `MSDN on where to store app data files
`_.
Makes use of the
`appname `,
`appauthor `,
`version `,
`roaming `,
`opinion `.returnc C s( | j r
dnd}tjt|}| |S )z
:return: data 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)Zroamingospathnormpathget_win_folder
_append_parts)selfconstr
r D/usr/lib/python3.9/site-packages/pip/_vendor/platformdirs/windows.py
user_data_dir s zWindows.user_data_dirN
opinion_value)r
r r c C st g }| j r`| jdur*| jp | j }|| || j |d urN| jrN|| | jr`|| j tjj|g|R S )NF)ZappnameZ appauthorappendopinionversionr r
join)r r
r paramsZauthorr r r r s
zWindows._append_partsc C s t jtd}| |S )zT:return: data directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname``CSIDL_COMMON_APPDATAr r
r r r r r
r r r
site_data_dir+ s zWindows.site_data_dirc C s | j S )zC:return: config directory tied to the user, same as `user_data_dir`r r r r r user_config_dir1 s zWindows.user_config_dirc C s | j S )zF:return: config directory shared by the users, same as `site_data_dir`)r r" r r r site_config_dir6 s zWindows.site_config_dirc C s t jtd}| j|ddS )z
:return: cache directory tied to the user (if opinionated with ``Cache`` folder within ``$appname``) e.g.
``%USERPROFILE%\AppData\Local\$appauthor\$appname\Cache\$version``
r ZCacher r r r r r user_cache_dir; s zWindows.user_cache_dirc C s | j S )zB:return: state directory tied to the user, same as `user_data_dir`r! r" r r r user_state_dirD s zWindows.user_state_dirc C s | j }| jrtj|d}|S )zy
:return: log directory tied to the user, same as `user_data_dir` if not opinionated else ``Logs`` in it
ZLogs)r r r r
r r r r r user_log_dirI s zWindows.user_log_dirc C s t jtdS )z`
:return: documents directory tied to the user e.g. ``%USERPROFILE%\Documents``
CSIDL_PERSONAL)r r
r r r" r r r user_documents_dirS s zWindows.user_documents_dirc C s$ t jt jtdd}| |S )z
:return: runtime directory tied to the user, e.g.
``%USERPROFILE%\AppData\Local\Temp\$appauthor\$appname``
r ZTemp)r r
r r r r r r r r user_runtime_dirZ s zWindows.user_runtime_dir)__name__
__module__ __qualname____doc__propertystrr r r r r# r$ r% r& r' r) r* r r r r r s(
r )
csidl_namer c C sr | dkr$t jt jt jd dS dddd| }|du rLtd | t j|}|du rntd
| |S ) z&Get folder from environment variables.r( USERPROFILEZ DocumentsAPPDATAZALLUSERSPROFILEZ LOCALAPPDATA)r
r r NUnknown CSIDL name: z Unset environment variable: )r r
r r environget
ValueError)r1 Z env_var_nameresultr r r get_win_folder_from_env_varsd s r9 c C sX ddddd | }|du r*td| ddl}||jd }|||\}}t|S )
zGet folder from the registry.
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.
ZAppDatazCommon AppDataz
Local AppDataZPersonalr
r r r( Nr4 r z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)r6 r7 winregOpenKeyHKEY_CURRENT_USERZ QueryValueExr0 )r1 Zshell_folder_namer; keyZ directory_r r r get_win_folder_from_registryv s r@ c C s ddddd | }|du r*td| td}ttd }|jd|dd
| td d |D rtd}|j |j
|dr|}|j
S )
zGet folder with ctypes. # r: Nr4 i windllr c s s | ]}t |d kV qdS ) N)ord).0cr r r z,get_win_folder_via_ctypes..) r6 r7 ctypesZcreate_unicode_buffergetattrZshell32ZSHGetFolderPathWanyZkernel32ZGetShortPathNameWvalue)r1 Z csidl_constbufrE Zbuf2r r r get_win_folder_via_ctypes s"
rQ r c C s: t tdrtS z dd l} W n ty0 t Y S 0 tS d S )NrE r )hasattrrL rQ r; ImportErrorr9 r@ )r; r r r _pick_get_win_folder s
rT )maxsize)rL r functoolsr typingr r Zapir r r0 r9 r@ rQ rT r __all__r r r r s [