pip._vendor.platformdirs.unix Namespace Reference

Data Structures
class	Unix

Functions
int	getuid ()
str	_get_user_media_dir (str env_var, str fallback_tilde_path)
str|None	_get_user_dirs_folder (str key)

Detailed Description

Unix.

Function Documentation

_get_user_dirs_folder()

str | None _get_user_dirs_folder ( str  key )

protected

Return directory from user-dirs.dirs config file. See https://freedesktop.org/wiki/Software/xdg-user-dirs/.

Definition at line 201 of file unix.py.

def _get_user_dirs_folder(key: str) -> str | None:
    """Return directory from user-dirs.dirs config file. See https://freedesktop.org/wiki/Software/xdg-user-dirs/."""
    user_dirs_config_path = Path(Unix().user_config_dir) / "user-dirs.dirs"
    if user_dirs_config_path.exists():
        parser = ConfigParser()
 
        with user_dirs_config_path.open() as stream:
            # Add fake section header, so ConfigParser doesn't complain
            parser.read_string(f"[top]\n{stream.read()}")
 
        if key not in parser["top"]:
            return None
 
        path = parser["top"][key].strip('"')
        # Handle relative home paths
        return path.replace("$HOME", os.path.expanduser("~"))  # noqa: PTH111
 
    return None
 
 

References i.

Referenced by pip._vendor.platformdirs.unix._get_user_media_dir().

Here is the caller graph for this function:

_get_user_media_dir()

str _get_user_media_dir ( str  env_var, str  fallback_tilde_path  )

protected

Definition at line 191 of file unix.py.

def _get_user_media_dir(env_var: str, fallback_tilde_path: str) -> str:
    media_dir = _get_user_dirs_folder(env_var)
    if media_dir is None:
        media_dir = os.environ.get(env_var, "").strip()
        if not media_dir:
            media_dir = os.path.expanduser(fallback_tilde_path)  # noqa: PTH111
 
    return media_dir
 
 

References pip._vendor.platformdirs.unix._get_user_dirs_folder(), and i.

Referenced by Unix.user_documents_dir(), Unix.user_downloads_dir(), Unix.user_music_dir(), Unix.user_pictures_dir(), and Unix.user_videos_dir().

Here is the call graph for this function:

Here is the caller graph for this function:

getuid()

int getuid

(

)

Definition at line 13 of file unix.py.

    def getuid() -> int:
        msg = "should only be used on Unix"
        raise RuntimeError(msg)