diff --git a/src/linkahead/configuration.py b/src/linkahead/configuration.py index a87aca4ff01aad3d5b9add743ba8a0dc7f37b41a..5081c28af253d3da31926ab1c9449309cc171c4f 100644 --- a/src/linkahead/configuration.py +++ b/src/linkahead/configuration.py @@ -82,6 +82,22 @@ def get_config() -> ConfigParser: def config_to_yaml(config: ConfigParser) -> dict[str, dict[str, Union[int, str, bool, tuple, None]]]: + """ + Generates and returns a dict with all config options and their values + defined in the config. + The values of the options 'debug', 'timeout', and 'ssl_insecure' are + parsed, all other values are saved as string. + + Parameters + ---------- + config : ConfigParser + The config to be converted to a dict + + Returns + ------- + valobj : dict + A dict with config options and their values as key value pairs + """ valobj: dict[str, dict[str, Union[int, str, bool, tuple, None]]] = {} for s in config.sections(): valobj[s] = {} diff --git a/src/linkahead/connection/connection.py b/src/linkahead/connection/connection.py index a9f075672829bcd03b46185cdd18130f81f34fee..74dd23177c548dd640c6dd1c03ce4069c366802b 100644 --- a/src/linkahead/connection/connection.py +++ b/src/linkahead/connection/connection.py @@ -422,8 +422,10 @@ def configure_connection(**kwargs): - "keyring" Uses the `keyring` library. - "auth_token" Uses only a given auth_token. - timeout : int + timeout : int, tuple, or None A connection timeout in seconds. (Default: 210) + If a tuple is given, they are used as connect and read timeouts + respectively, timeout None disables the timeout. ssl_insecure : bool Whether SSL certificate warnings should be ignored. Only use this for