B Khh3'@sdZddlmZddlZddlZddlmZddlmZddl m Z ej dkr^d d d d Z n dd lm Z Gddde Z ddddddZdddddZdgZdS)zUnix.) annotationsN) ConfigParser)Path)PlatformDirsABCwin32int)returncCsd}t|dS)Nzshould only be used on Unix) RuntimeError)msgr ;/tmp/pip-install-vv81h98y/platformdirs/platformdirs/unix.pygetuid sr)rc@seZdZdZeddddZeddddZdddd d Zeddd d Zeddd dZ eddddZ eddddZ eddddZ eddddZ eddddZeddddZeddddZeddddZedddd Zeddd!d"Zeddd#d$Zeddd%d&Zed'dd(d)Zed'dd*d+Zed'dd,d-Zdd'd.d/d0Zd1S)2Unixa On Unix/Linux, we follow the `XDG Basedir Spec `_. The spec allows overriding directories with environment variables. The examples show are the default values, alongside the name of the environment variable that overrides them. Makes use of the `appname `, `version `, `multipath `, `opinion `, `ensure_exists `. str)r cCs,tjdd}|s"tjd}||S)z :return: data directory tied to the user, e.g. ``~/.local/share/$appname/$version`` or ``$XDG_DATA_HOME/$appname/$version`` XDG_DATA_HOMEz~/.local/share)osenvirongetstrippath expanduser_append_app_name_and_version)selfrr r r user_data_dir"s zUnix.user_data_dircCs.tjdd}|s$dtjd}||S)aY :return: data directories shared by users (if `multipath ` is enabled and ``XDG_DATA_DIR`` is set and a multi path the response is also a multi path separated by the OS path separator), e.g. ``/usr/local/share/$appname/$version`` or ``/usr/share/$appname/$version`` XDG_DATA_DIRSrz/usr/local/sharez /usr/share)rrrrpathsep_with_multi_path)rrr r r site_data_dir-szUnix.site_data_dir)rr cs<|tj}js|dd}fdd|D}tj|S)Nrrcsg|]}tj|qSr )rrrr).0p)rr r >sz)Unix._with_multi_path..)splitrr multipathjoin)rr path_listr )rr r:s   zUnix._with_multi_pathcCs,tjdd}|s"tjd}||S)z :return: config directory tied to the user, e.g. ``~/.config/$appname/$version`` or ``$XDG_CONFIG_HOME/$appname/$version`` XDG_CONFIG_HOMErz ~/.config)rrrrrrr)rrr r r user_config_dirAs zUnix.user_config_dircCs$tjdd}|sd}||S)a/ :return: config directories shared by users (if `multipath ` is enabled and ``XDG_DATA_DIR`` is set and a multi path the response is also a multi path separated by the OS path separator), e.g. ``/etc/xdg/$appname/$version`` XDG_CONFIG_DIRSrz/etc/xdg)rrrrr)rrr r r site_config_dirLszUnix.site_config_dircCs,tjdd}|s"tjd}||S)z :return: cache directory tied to the user, e.g. ``~/.cache/$appname/$version`` or ``~/$XDG_CACHE_HOME/$appname/$version`` XDG_CACHE_HOMErz~/.cache)rrrrrrr)rrr r r user_cache_dirYs zUnix.user_cache_dircCs |dS)zO:return: cache directory shared by users, e.g. ``/var/cache/$appname/$version``z /var/cache)r)rr r r site_cache_dirdszUnix.site_cache_dircCs,tjdd}|s"tjd}||S)z :return: state directory tied to the user, e.g. ``~/.local/state/$appname/$version`` or ``$XDG_STATE_HOME/$appname/$version`` XDG_STATE_HOMErz~/.local/state)rrrrrrr)rrr r r user_state_diris zUnix.user_state_dircCs(|j}|jr$tj|d}|||S)zg:return: log directory tied to the user, same as `user_state_dir` if not opinionated else ``log`` in itlog)r/opinionrrr%Z_optionally_create_directory)rrr r r user_log_dirts  zUnix.user_log_dircCs tddS)zC:return: documents directory tied to the user, e.g. ``~/Documents``ZXDG_DOCUMENTS_DIRz ~/Documents)_get_user_media_dir)rr r r user_documents_dir}szUnix.user_documents_dircCs tddS)zC:return: downloads directory tied to the user, e.g. ``~/Downloads``ZXDG_DOWNLOAD_DIRz ~/Downloads)r3)rr r r user_downloads_dirszUnix.user_downloads_dircCs tddS)zA:return: pictures directory tied to the user, e.g. ``~/Pictures``ZXDG_PICTURES_DIRz ~/Pictures)r3)rr r r user_pictures_dirszUnix.user_pictures_dircCs tddS)z=:return: videos directory tied to the user, e.g. ``~/Videos``ZXDG_VIDEOS_DIRz~/Videos)r3)rr r r user_videos_dirszUnix.user_videos_dircCs tddS)z;:return: music directory tied to the user, e.g. ``~/Music``Z XDG_MUSIC_DIRz~/Music)r3)rr r r user_music_dirszUnix.user_music_dircCs tddS)z?:return: desktop directory tied to the user, e.g. ``~/Desktop``ZXDG_DESKTOP_DIRz ~/Desktop)r3)rr r r user_desktop_dirszUnix.user_desktop_dircCs^tjdd}|sTtjdrHdt}t| sTdt}n dt}| |S)az :return: runtime directory tied to the user, e.g. ``/run/user/$(id -u)/$appname/$version`` or ``$XDG_RUNTIME_DIR/$appname/$version``. For FreeBSD/OpenBSD/NetBSD, it would return ``/var/run/user/$(id -u)/$appname/$version`` if exists, otherwise ``/tmp/runtime-$(id -u)/$appname/$version``, if``$XDG_RUNTIME_DIR`` is not set. XDG_RUNTIME_DIRr)freebsdopenbsdnetbsdz/var/run/user/z /tmp/runtime-z /run/user/) rrrrsysplatform startswithrrexistsr)rrr r r user_runtime_dirs     zUnix.user_runtime_dircCs6tjdd}|s,tjdr(d}nd}||S)am :return: runtime directory shared by users, e.g. ``/run/$appname/$version`` or ``$XDG_RUNTIME_DIR/$appname/$version``. Note that this behaves almost exactly like `user_runtime_dir` if ``$XDG_RUNTIME_DIR`` is set, but will fall back to paths associated to the root user instead of a regular logged-in user if it's not set. If you wish to ensure that a logged-in root user path is returned e.g. ``/run/user/0``, use `user_runtime_dir` instead. For FreeBSD/OpenBSD/NetBSD, it would return ``/var/run/$appname/$version`` if ``$XDG_RUNTIME_DIR`` is not set. r:r)r;r<r=z/var/runz/run)rrrrr>r?r@r)rrr r r site_runtime_dirs  zUnix.site_runtime_dirrcCs ||jS)zd:return: data path shared by users. Only return first item, even if ``multipath`` is set to ``True``) _first_item_as_path_if_multipathr)rr r r site_data_pathszUnix.site_data_pathcCs ||jS)zj:return: config path shared by the users. Only return first item, even if ``multipath`` is set to ``True``)rDr*)rr r r site_config_pathszUnix.site_config_pathcCs ||jS)ze:return: cache path shared by users. Only return first item, even if ``multipath`` is set to ``True``)rDr-)rr r r site_cache_pathszUnix.site_cache_path) directoryr cCs|jr|tjd}t|S)Nr)r$r#rrr)rrHr r r rDsz%Unix._first_item_as_path_if_multipathN)__name__ __module__ __qualname____doc__propertyrrrr(r*r,r-r/r2r4r5r6r7r8r9rBrCrErFrGrDr r r r rs,        rr)env_varfallback_tilde_pathr cCs6t|}|dkr2tj|d}|s2tj|}|S)Nr)_get_user_dirs_folderrrrrrr)rNrOZ media_dirr r r r3s  r3z str | None)keyr c Csttjd}|r|t}|}|d|WdQRX||dkrVdS|d|d}| dt j dSdS)zkReturn directory from user-dirs.dirs config file. See https://freedesktop.org/wiki/Software/xdg-user-dirs/.zuser-dirs.dirsz[top] Ntop"z$HOME~) rrr(rAropen read_stringreadrreplacerrr)rQZuser_dirs_config_pathparserstreamrr r r rPs  rP)rL __future__rrr> configparserrZpathlibrapirr?rrr3rP__all__r r r r s      G