File: //usr/local/lib/python3.10/dist-packages/platformdirs/__pycache__/windows.cpython-310.pyc
o
j�h�' � @ s� d Z ddlmZ ddlZddlZddlmZ ddlmZ ddl m
Z
er*ddl m Z G d d
� d
e
�Z
ddd�Zd dd�Zddd�Zddd�Zd dd�Zedd�e� �Zd
gZdS ) zWindows.� )� annotationsN)� lru_cache)�
TYPE_CHECKING� )�PlatformDirsABC)�Callablec @ s e Zd ZdZed+dd��Zdd�d,d d �Zed+d
d��Zed+dd��Zed+dd��Z ed+dd��Z
ed+dd��Z ed+dd��Z ed+dd��Z
ed+dd ��Zed+d d ��Zed+d d ��Zed+d!d"��Zed+d#d$��Zed+d%d&��Zed+d'd(��Zed+d)d*��ZdS )-�Windowsa�
`MSDN on where to store app data files <https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid>`_.
Makes use of the `appname <platformdirs.api.PlatformDirsABC.appname>`, `appauthor
<platformdirs.api.PlatformDirsABC.appauthor>`, `version <platformdirs.api.PlatformDirsABC.version>`, `roaming
<platformdirs.api.PlatformDirsABC.roaming>`, `opinion <platformdirs.api.PlatformDirsABC.opinion>`, `ensure_exists
<platformdirs.api.PlatformDirsABC.ensure_exists>`.
�return�strc C s( | j rdnd}tj�t|��}| �|�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_APPDATA�CSIDL_LOCAL_APPDATA)�roaming�os�path�normpath�get_win_folder�
_append_parts)�self�constr � r �?/usr/local/lib/python3.10/dist-packages/platformdirs/windows.py�
user_data_dir s
zWindows.user_data_dirN��
opinion_valuer r �
str | Nonec C s� g }| j r0| jdur| jp| j }|�|� |�| j � |d ur'| jr'|�|� | jr0|�| j� tjj|g|�R � }| �|� |S )NF) �appname� appauthor�append�opinion�versionr r �join� _optionally_create_directory)r r r �params�authorr r r r & s
zWindows._append_partsc C s t j�td��}| �|�S )zT:return: data directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname``�CSIDL_COMMON_APPDATA�r r r r r �r r r r r �
site_data_dir5 s
zWindows.site_data_dirc C � | j S )zC:return: config directory tied to the user, same as `user_data_dir`�r �r r r r �user_config_dir; � zWindows.user_config_dirc C r( )zF:return: config directory shared by the users, same as `site_data_dir`)r' r* r r r �site_config_dir@ r, zWindows.site_config_dirc C � t j�td��}| j|dd�S )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 �Cacher r% r& r r r �user_cache_dirE s zWindows.user_cache_dirc C r. )zd:return: cache directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname\Cache\$version``r$ r/ r r% r& r r r �site_cache_dirN s zWindows.site_cache_dirc C r( )zB:return: state directory tied to the user, same as `user_data_dir`r) r* r r r �user_state_dirT r, zWindows.user_state_dirc C s( | j }| jrtj�|d�}| �|� |S )zg:return: log directory tied to the user, same as `user_data_dir` if not opinionated else ``Logs`` in it�Logs)r r r r r r! r& r r r � user_log_dirY s
zWindows.user_log_dirc C � t j�td��S )zN:return: documents directory tied to the user e.g. ``%USERPROFILE%\Documents``�CSIDL_PERSONAL�r r r r r* r r r �user_documents_dirb � zWindows.user_documents_dirc C r5 )zN:return: downloads directory tied to the user e.g. ``%USERPROFILE%\Downloads``�CSIDL_DOWNLOADSr7 r* r r r �user_downloads_dirg r9 zWindows.user_downloads_dirc C r5 )zL:return: pictures directory tied to the user e.g. ``%USERPROFILE%\Pictures``�CSIDL_MYPICTURESr7 r* r r r �user_pictures_dirl r9 zWindows.user_pictures_dirc C r5 )zH:return: videos directory tied to the user e.g. ``%USERPROFILE%\Videos``�
CSIDL_MYVIDEOr7 r* r r r �user_videos_dirq r9 zWindows.user_videos_dirc C r5 )zF:return: music directory tied to the user e.g. ``%USERPROFILE%\Music``�
CSIDL_MYMUSICr7 r* r r r �user_music_dirv r9 zWindows.user_music_dirc C r5 )zK:return: desktop directory tied to the user, e.g. ``%USERPROFILE%\Desktop``�CSIDL_DESKTOPDIRECTORYr7 r* r r r �user_desktop_dir{ r9 zWindows.user_desktop_dirc C s$ t j�t j�td�d��}| �|�S )z�
:return: runtime directory tied to the user, e.g.
``%USERPROFILE%\AppData\Local\Temp\$appauthor\$appname``
r �Temp)r r r r r r r& r r r �user_runtime_dir� s
zWindows.user_runtime_dirc C r( )zF:return: runtime directory shared by users, same as `user_runtime_dir`)rE r* r r r �site_runtime_dir� r, zWindows.site_runtime_dir)r r
)r r
r r r r
)�__name__�
__module__� __qualname__�__doc__�propertyr r r' r+ r- r0 r1 r2 r4 r8 r; r= r? rA rC rE rF r r r r r sF
r �
csidl_namer
r c C sj t | �}|dur
|S dddd��| �}|du r d| � �}t|��tj�|�}|du r3d|� �}t|��|S )z&Get folder from environment variables.N�APPDATA�ALLUSERSPROFILE� LOCALAPPDATA)r r$ r �Unknown CSIDL name: z Unset environment variable: )�(get_win_folder_if_csidl_name_not_env_var�get�
ValueErrorr �environ)rL �result� env_var_name�msgr r r � get_win_folder_from_env_vars� s" ��
rX r c C s� | dkrt j�t j�t jd �d�S | dkr$t j�t j�t jd �d�S | dkr6t j�t j�t jd �d�S | dkrHt j�t j�t jd �d �S | d
krZt j�t j�t jd �d �S d S )
zMGet a folder for a CSIDL name that does not exist as an environment variable.r6 � USERPROFILE� Documentsr: � Downloadsr< �Picturesr> �Videosr@ �MusicN)r r r r rT )rL r r r rQ � s rQ c C sr ddddddddd �� | �}|d
u rd | � �}t|��tjd kr"t�d
d
l}|�|jd�}|�||�\}}t |�S )z�
Get 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.
�AppDatazCommon AppDataz
Local AppData�Personalz&{374DE290-123F-4565-9164-39C4925E467B}z My PictureszMy VideozMy Music)r r$ r r6 r: r< r> r@ NrP �win32r z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)
rR rS �sys�platform�NotImplementedError�winreg�OpenKey�HKEY_CURRENT_USER� QueryValueExr
)rL �shell_folder_namerW re �key� directory�_r r r � get_win_folder_from_registry� s( � �
rm c
C s� ddl }ddddddd d
d d � �| �}|du r d
| � �}t|��|�d�}t|d�}|j�d|dd|� tdd� |D ��rM|�d�}|j� |j
|d�rM|}| dkrYt j �
|j
d�S |j
S )zGet folder with ctypes.r N� �# � � �' � �
�( � ) r r$ r r6 r< r> r@ r: rB rP i �windllc s s � | ] }t |�d kV qdS )� N)�ord)�.0�cr r r � <genexpr>� s � z,get_win_folder_via_ctypes.<locals>.<genexpr>r: r[ )�ctypesrR rS �create_unicode_buffer�getattr�shell32�SHGetFolderPathW�any�kernel32�GetShortPathNameW�valuer r r )rL r} � csidl_constrW �bufrw �buf2r r r �get_win_folder_via_ctypes� s4 �
�
r� �Callable[[str], str]c C sT zdd l } W n ty Y nw t| d�rtS zdd l}W tS ty) t Y S w )Nr rw )r} � ImportError�hasattrr� re rX rm )r} re r r r �_pick_get_win_folder� s �
��r� )�maxsize)rL r
r r
)rL r
r r )r r� )rJ �
__future__r r rb � functoolsr �typingr �apir �collections.abcr r rX rQ rm r� r� r �__all__r r r r �<module> s$
'�