bundles / astropy 7.0.1 / astropy / config / paths / get_config_dir
staticmethod
astropy.config.paths:get_config_dir
source: /astropy/config/paths.py :72
Signature
def get_config_dir ( rootname : str = astropy ) → str Summary
Determines the package configuration directory name and creates the directory if it doesn't exist.
Extended Summary
This directory is typically $HOME/.astropy/config, but if the XDG_CONFIG_HOME environment variable is set and the $XDG_CONFIG_HOME/astropy directory exists, it will be that directory. If neither exists, the former will be created and symlinked to the latter.
Parameters
rootname: strName of the root configuration directory. For example, if
rootname = 'pkgname', the configuration directory would be<home>/.pkgname/rather than<home>/.astropy(depending on platform).
Returns
configdir: PathThe absolute path to the configuration directory.
See also
- get_config_dir_path
same as this function, except that the return value is a pathlib.Path
Aliases
-
astropy.config.get_config_dir -
astropy.config.set_temp_config._default_path_getter