koapy.config

Module Contents

Functions

read_config(filename: Optional[Union[os.PathLike, str]] = None, encoding: Optional[str] = None) → Config
config_from_dict(dictionary: Mapping[str, Any]) → Config
find_user_config_file_in(searching_directory: Optional[Union[os.PathLike, str]] = None) → Optional[pathlib.Path]
find_user_config_file_from(starting_directory: Optional[Union[os.PathLike, str]] = None) → Optional[pathlib.Path]
set_user_config(c: Config) → Config
initialize_config_from_given_path(filename: Optional[Union[os.PathLike, str]] = None) → bool
initialize_config_from_expected_paths() → bool
get_config() → Config
get_user_config() → Config
dump_config(config: Config, compact: bool = False, indent: int = 4) → str
save_config(filename: Union[os.PathLike, str], config: Optional[Config] = None, compact: bool = False, indent: int = 4, encoding: Optional[str] = None)
save_user_config(filename: Optional[Union[os.PathLike, str]] = None, user_config: Optional[Config] = None, compact: bool = False, indent: int = 4, encoding: Optional[str] = None)
get_executable_from_conda_envname(envname: str) → str
get_executable_from_conda_envpath(envpath: str) → str
get_executable_from_executable_config(executable_config: Config) → Optional[str]
get_32bit_executable() → Optional[str]
get_64bit_executable() → Optional[str]

Attributes

Config
default_config_filename
default_config_file_directory
default_config_filepath
current_working_directory
home_directory
default_user_config_filename
user_config_filename_cadidates
default_user_config_filepath
default_encoding
default_config
empty_config
user_config
config
debug

koapy.config.Config

koapy.config.default_config_filename = config.conf

koapy.config.default_config_file_directory

koapy.config.default_config_filepath

koapy.config.current_working_directory

koapy.config.home_directory

koapy.config.default_user_config_filename = koapy.conf

koapy.config.user_config_filename_cadidates

koapy.config.default_user_config_filepath

koapy.config.default_encoding = utf-8

koapy.config.read_config(filename: Optional[Union[os.PathLike, str]] = None, encoding: Optional[str] = None) → Config

koapy.config.config_from_dict(dictionary: Mapping[str, Any]) → Config

koapy.config.default_config

koapy.config.find_user_config_file_in(searching_directory: Optional[Union[os.PathLike, str]] = None) → Optional[pathlib.Path]

koapy.config.find_user_config_file_from(starting_directory: Optional[Union[os.PathLike, str]] = None) → Optional[pathlib.Path]

koapy.config.empty_config

koapy.config.user_config

koapy.config.config

koapy.config.set_user_config(c: Config) → Config

koapy.config.initialize_config_from_given_path(filename: Optional[Union[os.PathLike, str]] = None) → bool

koapy.config.initialize_config_from_expected_paths() → bool

koapy.config.get_config() → Config

koapy.config.get_user_config() → Config

koapy.config.debug = False

koapy.config.dump_config(config: Config, compact: bool = False, indent: int = 4) → str

koapy.config.save_config(filename: Union[os.PathLike, str], config: Optional[Config] = None, compact: bool = False, indent: int = 4, encoding: Optional[str] = None)

koapy.config.save_user_config(filename: Optional[Union[os.PathLike, str]] = None, user_config: Optional[Config] = None, compact: bool = False, indent: int = 4, encoding: Optional[str] = None)

koapy.config.get_executable_from_conda_envname(envname: str) → str

koapy.config.get_executable_from_conda_envpath(envpath: str) → str

koapy.config.get_executable_from_executable_config(executable_config: Config) → Optional[str]

koapy.config.get_32bit_executable() → Optional[str]

koapy.config.get_64bit_executable() → Optional[str]