Skip to content

trading_agent.configuration.configuration_loader

Reads trading_agent.toml into an AgentConfiguration.

Typical usage example:

loader = ConfigurationLoader(Path('trading_agent.toml')) configuration = loader.load()

ConfigurationError

Bases: ValueError

The configuration file is missing, unreadable or invalid.

ConfigurationLoader 

ConfigurationLoader(configuration_path)

Reads and checks one configuration file.

Attributes:

Name Type Description
configuration_path

The TOML file to read.

Remembers which file to read, without reading it yet.

Parameters:

Name Type Description Default
configuration_path Path

The TOML file to read.

 required
Source code in src/trading_agent/configuration/configuration_loader.py 
28
29
30
31
32
33
34
def __init__(self, configuration_path: Path):
    """Remembers which file to read, without reading it yet.

    Args:
        configuration_path (Path): The TOML file to read.
    """
    self.configuration_path = configuration_path

load 

load()

Reads the file and checks every value in it.

Returns:

Type Description
AgentConfiguration

The checked configuration.

Raises:

Type Description
ConfigurationError

The file is missing, is not valid TOML, or holds a value of the wrong kind.
Source code in src/trading_agent/configuration/configuration_loader.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def load(self) -> agent_configuration.AgentConfiguration:
    """Reads the file and checks every value in it.

    Returns:
        agent_configuration.AgentConfiguration: The checked configuration.

    Raises:
        ConfigurationError: The file is missing, is not valid TOML, or holds a value of the wrong kind.
    """
    try:
        text = self.configuration_path.read_text(encoding='utf-8')
    except FileNotFoundError as error:
        raise ConfigurationError(
            f'Configuration file not found: {self.configuration_path}'
        ) from error
    try:
        parsed = tomllib.loads(text)
    except tomllib.TOMLDecodeError as error:
        raise ConfigurationError(
            f'{self.configuration_path} is not valid TOML: {error}'
        ) from error
    try:
        return agent_configuration.AgentConfiguration.model_validate(parsed)
    except pydantic.ValidationError as error:
        raise ConfigurationError(
            f'{self.configuration_path} has invalid values:\n{error}'
        ) from error