Skip to content

trading_agent.tools.cancel_price_alert_tool

The cancel_price_alert tool: removes one of the desk's price alerts.

Typical usage example:

tool = CancelPriceAlertTool(store)

CancelPriceAlertArguments

Bases: BaseModel

The arguments of cancel_price_alert.

Attributes:

Name Type Description
alert_id str

The alert's id, as set_price_alert listed it.

CancelPriceAlertTool 

CancelPriceAlertTool(store)

Bases: Tool

Removes a price alert.

Creates the tool.

Parameters:

Name Type Description Default
store PriceAlertStore

The desk's alerts.

 required
Source code in src/trading_agent/tools/cancel_price_alert_tool.py 
37
38
39
40
41
42
43
def __init__(self, store: price_alert_store_module.PriceAlertStore):
    """Creates the tool.

    Args:
        store (price_alert_store_module.PriceAlertStore): The desk's alerts.
    """
    self._store = store

run async 

run(arguments)

Removes the alert.

Parameters:

Name Type Description Default
arguments CancelPriceAlertArguments

The alert's id.

 required

Returns:

Type Description
ToolResult

A confirmation with the alerts left, or why nothing was removed.
Source code in src/trading_agent/tools/cancel_price_alert_tool.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
async def run(
    self, arguments: CancelPriceAlertArguments
) -> tool.ToolResult:
    """Removes the alert.

    Args:
        arguments (CancelPriceAlertArguments): The alert's id.

    Returns:
        tool.ToolResult: A confirmation with the alerts left, or why nothing was removed.
    """
    removed = self._store.remove(arguments.alert_id)
    remaining = self._store.alerts()
    listing = (
        '; '.join(
            f'{alert.alert_id}: {alert.describe()}' for alert in remaining
        )
        or 'none'
    )
    if removed is None:
        return tool.ToolResult.error(
            f'No alert {arguments.alert_id}. Active alerts: {listing}.'
        )
    return tool.ToolResult.success(
        f'Removed {removed.describe()}. Active alerts: {listing}.'
    )