pip._internal.utils.appdirs Namespace Reference

Functions
str	user_cache_dir (str appname)
str	_macos_user_config_dir (str appname, bool roaming=True)
str	user_config_dir (str appname, bool roaming=True)
List[str]	site_config_dirs (str appname)

Detailed Description

This code wraps the vendored appdirs module to so the return values are
compatible for the current pip code base.

The intention is to rewrite current usages gradually, keeping the tests pass,
and eventually drop this after all usages are changed.

Function Documentation

_macos_user_config_dir()

str _macos_user_config_dir ( str  appname, bool   roaming = True  )

protected

Definition at line 20 of file appdirs.py.

def _macos_user_config_dir(appname: str, roaming: bool = True) -> str:
    # Use ~/Application Support/pip, if the directory exists.
    path = _appdirs.user_data_dir(appname, appauthor=False, roaming=roaming)
    if os.path.isdir(path):
        return path
 
    # Use a Linux-like ~/.config/pip, by default.
    linux_like_path = "~/.config/"
    if appname:
        linux_like_path = os.path.join(linux_like_path, appname)
 
    return os.path.expanduser(linux_like_path)
 
 

References i.

Referenced by pip._internal.utils.appdirs.user_config_dir().

Here is the caller graph for this function:

site_config_dirs()

List[str] site_config_dirs

(

str

appname

)

Definition at line 43 of file appdirs.py.

def site_config_dirs(appname: str) -> List[str]:
    if sys.platform == "darwin":
        return [_appdirs.site_data_dir(appname, appauthor=False, multipath=True)]
 
    dirval = _appdirs.site_config_dir(appname, appauthor=False, multipath=True)
    if sys.platform == "win32":
        return [dirval]
 
    # Unix-y system. Look in /etc as well.
    return dirval.split(os.pathsep) + ["/etc"]

References i.

user_cache_dir()

str user_cache_dir

(

str

appname

)

Definition at line 16 of file appdirs.py.

def user_cache_dir(appname: str) -> str:
    return _appdirs.user_cache_dir(appname, appauthor=False)
 
 

References i.

user_config_dir()

str user_config_dir	(	str	appname,
		bool	roaming = True
	)

Definition at line 34 of file appdirs.py.

def user_config_dir(appname: str, roaming: bool = True) -> str:
    if sys.platform == "darwin":
        return _macos_user_config_dir(appname, roaming)
 
    return _appdirs.user_config_dir(appname, appauthor=False, roaming=roaming)
 
 
# for the discussion regarding site_config_dir locations
# see <https://github.com/pypa/pip/issues/1733>

References pip._internal.utils.appdirs._macos_user_config_dir(), and i.

Here is the call graph for this function: