File: //usr/local/lib/python3.10/dist-packages/platformdirs/__pycache__/api.cpython-310.pyc
o
j�hA$ � @ sp d Z ddlmZ ddlZddlmZmZ ddlmZ ddl m
Z
e
r.ddl m Z ddl m
Z
G d d
� d
e�ZdS ) z Base API.� )� annotationsN)�ABC�abstractmethod)�Path)�
TYPE_CHECKING)�Iterator)�Literalc @ s� e Zd ZdZ dpdqdd�Zdrdd�Zdsdd�Zdtd d �Zee dud d ���Z
ee dud d!���Z ee dud"d#���Z ee dud$d%���Z
ee dud&d'���Zee dud(d)���Zee dud*d+���Zee dud,d-���Zee dud.d/���Zee dud0d1���Zee dud2d3���Zee dud4d5���Zee dud6d7���Zee dud8d9���Zee dud:d;���Zee dud<d=���Zedvd>d?��Zedvd@dA��ZedvdBdC��Z edvdDdE��Z edvdFdG��Z edvdHdI��Z edvdJdK��Z edvdLdM��Z!edvdNdO��Z"edvdPdQ��Z#edvdRdS��Z$edvdTdU��Z%edvdVdW��Z&edvdXdY��Z'edvdZd[��Z(edvd\d]��Z)dwd_d`�Z*dwdadb�Z+dwdcdd�Z,dwdedf�Z-dxdhdi�Z.dxdjdk�Z/dxdldm�Z0dxdndo�Z1dS )y�PlatformDirsABCz-Abstract base class for platform directories.NFT�appname�
str | None� appauthor�str | Literal[False] | None�version�roaming�bool� multipath�opinion�
ensure_exists�return�Nonec C s6 || _ || _ || _ || _ || _ || _|| _dS )aY
Create a new platform directory.
:param appname: See `appname`.
:param appauthor: See `appauthor`.
:param version: See `version`.
:param roaming: See `roaming`.
:param multipath: See `multipath`.
:param opinion: See `opinion`.
:param ensure_exists: See `ensure_exists`.
N)r
r r r r r r )�selfr
r r r r r r � r �;/usr/local/lib/python3.10/dist-packages/platformdirs/api.py�__init__ s zPlatformDirsABC.__init__�base�strc G sZ t |dd � �}| jr|�| j� | jr|�| j� tjj|d g|�R � }| �|� |S )N� r )�listr
�appendr �os�path�join� _optionally_create_directory)r r �paramsr r r r � _append_app_name_and_versionQ s
z,PlatformDirsABC._append_app_name_and_versionr c C s | j rt|�jddd� d S d S )NT)�parents�exist_ok)r r �mkdir�r r r r r r" [ s �z,PlatformDirsABC._optionally_create_directory� directoryr c C s | j r |�tj�d }t|�S )Nr )r � partitionr �pathsepr )r r) r r r � _first_item_as_path_if_multipath_ s z0PlatformDirsABC._first_item_as_path_if_multipathc C � dS )z(:return: data directory tied to the userNr �r r r r �
user_data_dire � z PlatformDirsABC.user_data_dirc C r- )z':return: data directory shared by usersNr r. r r r �
site_data_dirj r0 z PlatformDirsABC.site_data_dirc C r- )z*:return: config directory tied to the userNr r. r r r �user_config_diro r0 z PlatformDirsABC.user_config_dirc C r- )z-:return: config directory shared by the usersNr r. r r r �site_config_dirt r0 z PlatformDirsABC.site_config_dirc C r- )z):return: cache directory tied to the userNr r. r r r �user_cache_diry r0 z PlatformDirsABC.user_cache_dirc C r- )z(:return: cache directory shared by usersNr r. r r r �site_cache_dir~ r0 z PlatformDirsABC.site_cache_dirc C r- )z):return: state directory tied to the userNr r. r r r �user_state_dir� r0 z PlatformDirsABC.user_state_dirc C r- )z':return: log directory tied to the userNr r. r r r � user_log_dir� r0 z PlatformDirsABC.user_log_dirc C r- )z-:return: documents directory tied to the userNr r. r r r �user_documents_dir� r0 z"PlatformDirsABC.user_documents_dirc C r- )z-:return: downloads directory tied to the userNr r. r r r �user_downloads_dir� r0 z"PlatformDirsABC.user_downloads_dirc C r- )z,:return: pictures directory tied to the userNr r. r r r �user_pictures_dir� r0 z!PlatformDirsABC.user_pictures_dirc C r- )z*:return: videos directory tied to the userNr r. r r r �user_videos_dir� r0 z PlatformDirsABC.user_videos_dirc C r- )z):return: music directory tied to the userNr r. r r r �user_music_dir� r0 z PlatformDirsABC.user_music_dirc C r- )z+:return: desktop directory tied to the userNr r. r r r �user_desktop_dir� r0 z PlatformDirsABC.user_desktop_dirc C r- )z+:return: runtime directory tied to the userNr r. r r r �user_runtime_dir� r0 z PlatformDirsABC.user_runtime_dirc C r- )z*:return: runtime directory shared by usersNr r. r r r �site_runtime_dir� r0 z PlatformDirsABC.site_runtime_dirc C �
t | j�S )z#:return: data path tied to the user)r r/ r. r r r �user_data_path� �
z PlatformDirsABC.user_data_pathc C r@ )z":return: data path shared by users)r r1 r. r r r �site_data_path� rB z PlatformDirsABC.site_data_pathc C r@ )z%:return: config path tied to the user)r r2 r. r r r �user_config_path� rB z PlatformDirsABC.user_config_pathc C r@ )z(:return: config path shared by the users)r r3 r. r r r �site_config_path� rB z PlatformDirsABC.site_config_pathc C r@ )z$:return: cache path tied to the user)r r4 r. r r r �user_cache_path� rB z PlatformDirsABC.user_cache_pathc C r@ )z#:return: cache path shared by users)r r5 r. r r r �site_cache_path� rB z PlatformDirsABC.site_cache_pathc C r@ )z$:return: state path tied to the user)r r6 r. r r r �user_state_path� rB z PlatformDirsABC.user_state_pathc C r@ )z":return: log path tied to the user)r r7 r. r r r �
user_log_path� rB z PlatformDirsABC.user_log_pathc C r@ )z*:return: documents a path tied to the user)r r8 r. r r r �user_documents_path� rB z#PlatformDirsABC.user_documents_pathc C r@ )z(:return: downloads path tied to the user)r r9 r. r r r �user_downloads_path� rB z#PlatformDirsABC.user_downloads_pathc C r@ )z':return: pictures path tied to the user)r r: r. r r r �user_pictures_path� rB z"PlatformDirsABC.user_pictures_pathc C r@ )z%:return: videos path tied to the user)r r; r. r r r �user_videos_path� rB z PlatformDirsABC.user_videos_pathc C r@ )z$:return: music path tied to the user)r r< r. r r r �user_music_path� rB z PlatformDirsABC.user_music_pathc C r@ )z&:return: desktop path tied to the user)r r= r. r r r �user_desktop_path� rB z!PlatformDirsABC.user_desktop_pathc C r@ )z&:return: runtime path tied to the user)r r> r. r r r �user_runtime_path� rB z!PlatformDirsABC.user_runtime_pathc C r@ )z%:return: runtime path shared by users)r r? r. r r r �site_runtime_path rB z!PlatformDirsABC.site_runtime_path�
Iterator[str]c c � � | j V | jV dS )z4:yield: all user and site configuration directories.N)r2 r3 r. r r r �iter_config_dirs � � z PlatformDirsABC.iter_config_dirsc c rS )z+:yield: all user and site data directories.N)r/ r1 r. r r r �iter_data_dirs
rU z PlatformDirsABC.iter_data_dirsc c rS )z,:yield: all user and site cache directories.N)r4 r5 r. r r r �iter_cache_dirs rU z PlatformDirsABC.iter_cache_dirsc c rS )z.:yield: all user and site runtime directories.N)r> r? r. r r r �iter_runtime_dirs rU z!PlatformDirsABC.iter_runtime_dirs�Iterator[Path]c c � � | � � D ]}t|�V qdS )z.:yield: all user and site configuration paths.N)rT r r( r r r �iter_config_paths � � �z!PlatformDirsABC.iter_config_pathsc c rZ )z%:yield: all user and site data paths.N)rV r r( r r r �iter_data_paths r\ z PlatformDirsABC.iter_data_pathsc c rZ )z&:yield: all user and site cache paths.N)rW r r( r r r �iter_cache_paths# r\ z PlatformDirsABC.iter_cache_pathsc c rZ )z(:yield: all user and site runtime paths.N)rX r r( r r r �iter_runtime_paths( r\ z"PlatformDirsABC.iter_runtime_paths)NNNFFTF)r
r r r
r r r r r r r r r r r r )r r r r )r r r r )r) r r r )r r )r r )r rR )r rY )2�__name__�
__module__� __qualname__�__doc__r r$ r" r, �propertyr r/ r1 r2 r3 r4 r5 r6 r7 r8 r9 r: r; r< r= r> r? rA rC rD rE rF rG rH rI rJ rK rL rM rN rO rP rQ rT rV rW rX r[ r] r^ r_ r r r r r s� �
?
r )rc �
__future__r r �abcr r �pathlibr �typingr �collections.abcr r r r r r r �<module> s