hop.configure

class hop.configure.Config(fetch_external: bool = True, automatic_offload: bool = True)

A container class for general configuration parameters

hop.configure.get_config_path(type: str = 'general')

Determines the default location for auth configuration.

Parameters:

type – The type of configuration data for which the path should be looked up. Recognized types are ‘general’ and ‘auth’.

Returns:

The path to the requested configuration file.

Raises:

ValueError – Unrecognized config type requested.

hop.configure.load_config(config_path: str | None = None)

Load the configuration settings for the library combining, in order of increasing precedence: 1. The built-in defaults 2. Defaults stored in the configuration file 3. Values currently set in the environment as environment variables

Parameters:

config_path – The path to the configuration file to load. If unspecified, the default location is used.

Return: A Config object with all current settings

hop.configure.write_config_value(name: str, value)

Store a configuration value to the configuation file.

Parameters:

• name – The name of the parameter to store. Must be a valid parameter name.

• value – The parameter value to store. Must be the correct type for the specified parameter.