rcmpy.xdg
index
/home/vkottler/src/vkottler/workspace/rcmpy/rcmpy/xdg/__init__.py

A module for working with the XDG base directory specification.
 
https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html

 
Package Contents
       

 
Functions
       
config_directories(*parts: str, include_home: bool = True) -> Iterator[pathlib.Path]
Yield a set of preference ordered base directories relative to which
configuration files should be searched.
data_directories(*parts: str, include_home: bool = True) -> Iterator[pathlib.Path]
Yield a set of preference ordered base directories relative to which
data files should be searched.
ensure_absolute(path: Union[pathlib.Path, str, NoneType], create: bool = False) -> pathlib.Path
A wrapper to ensure that a path is an absolute one.
iterate_directories(data: str, sep: str = ':', create: bool = False) -> Iterator[pathlib.Path]
Iterate over directories specified in a PATH-like variable (some
separator).
root_directory(*parts: str) -> pathlib.Path
Create a path from the current file-system's root directory.
user_bin(*parts: str, create: bool = True) -> pathlib.Path
A single base directory relative to which user-specific executable files
may be written.
user_cache(*parts: str, create: bool = True) -> pathlib.Path
A single base directory relative to which user-specific
non-essential (cached) data should be written.
user_config(*parts: str, create: bool = True) -> pathlib.Path
A single base directory relative to which user-specific configuration files
should be written.
user_data(*parts: str, create: bool = True) -> pathlib.Path
A single base directory relative to which user-specific data files should
be written.
user_state(*parts: str, create: bool = True) -> pathlib.Path
A single base directory relative to which user-specific state data
should be written.

 
Data
        Iterator = typing.Iterator
Pathlike = typing.Union[pathlib.Path, str, NoneType]
environ = environ({'TMUX': '/tmp/tmux-1000/default,610,0',...: 'WT_SESSION:WT_PROFILE_ID:', 'EDITOR': 'nvim'})