Skip to content

trading_agent.doctor.checks.trading_limits_check

Checks that the limits block of TradingRules.md can be read, and reports the main limits.

Typical usage example:

result = TradingLimitsCheck(Path('workspace/shared/TradingRules.md')).run()

TradingLimitsCheck 

TradingLimitsCheck(rules_file)

Bases: DoctorCheck

Checks the risk engine's limits.

Creates the check.

Parameters:

Name Type Description Default
rules_file Path

The TradingRules.md file.

 required
Source code in src/trading_agent/doctor/checks/trading_limits_check.py 
19
20
21
22
23
24
25
def __init__(self, rules_file: Path):
    """Creates the check.

    Args:
        rules_file (Path): The TradingRules.md file.
    """
    self._rules_file = rules_file

run 

run()

Reads the limits block.

Returns:

Type Description
CheckResult

OK with the main limits, a warning when trading is switched off, or failed when the block cannot be read, in which case the risk engine refuses every new position.
Source code in src/trading_agent/doctor/checks/trading_limits_check.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def run(self) -> doctor_check.CheckResult:
    """Reads the limits block.

    Returns:
        doctor_check.CheckResult: OK with the main limits, a warning when trading is switched off, or failed when the block cannot be read, in which case the risk engine refuses every new position.
    """
    try:
        limits = trading_limits.TradingLimitsReader(self._rules_file).read()
    except trading_limits.LimitsError as error:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.FAILED,
            f'{error}; the risk engine will refuse every order that opens a position.',
        )
    account = limits.account
    summary = f'daily loss {account.daily_loss_limit_percent:g}%, weekly loss {account.weekly_loss_limit_percent:g}%, per order {account.maximum_order_value_percent:g}%, option writing {"allowed" if account.allow_option_writing else "forbidden"}'
    if not account.trading_enabled:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.WARNING,
            f'trading_enabled is false, so no position can be opened ({summary}).',
        )
    return doctor_check.CheckResult(
        doctor_check.CheckStatus.OK,
        f'Trading enabled; {summary}.',
    )