Налаштування

Для читання налаштувань потрібне право settings:read. Для зміни — settings:write.

Прочитати налаштуванняСкопіювати посилання на розділ

settings = terminal.settings(category="multiview")
for row in settings.data:
    print(row.category, row.key, row.value, row.writable)

Налаштування — це рядок із category, key і value. writable показує, чи може API його змінити. Без аргументів ви отримаєте налаштування всього термінала.

Прочитати налаштування стаканаСкопіювати посилання на розділ

book = terminal.orderbook_settings(12, "binance:futures:BTCUSDT")
for category, keys in book.data.items():
    for key, setting in keys.items():
        print(category, key, setting.value, setting.resolved_from)

Попередній виклик показує, що збережено. Цей показує, що в підсумку отримує стакан: він бере кожне налаштування з першого місця, де є значення, а resolved_from називає це місце.

Змінити налаштуванняСкопіювати посилання на розділ

from spectre_terminal import SettingChange

applied = terminal.update_settings([
    SettingChange("multiview", "stack_width_px", 300),
    SettingChange("general", "auto_scroll", True, instrument="binance:futures:BTCUSDT", connection_id=12),
])
print(applied.applied)

Один виклик приймає до 100 змін. Де зберігається зміна, залежить від того, що ви передаєте разом із нею.

Спершу термінал звіряє кожну зміну зі своїм списком налаштувань. Якщо хоч одну відхилено, не зберігається нічого.

Потім зміни застосовуються по черзі. Якщо одна не вдається, виклик зупиняється з помилкою, а зміни перед нею залишаються застосованими.

Плече через налаштування не змінюється. Використовуйте Змінити плече.

Змінити тему або гарячу клавішуСкопіювати посилання на розділ

from spectre_terminal import SettingChange

terminal.update_settings([
    SettingChange("appearance", "theme", {"stack": "dark"}),
    SettingChange("hotkeys_orderbook", "close_position", {"code": "KeyX", "modifiers": []}),
])

Тема приймає будь-які з stack, graphic та interface. Останні дві приймають лише light або dark.

Гаряча клавіша приймає code і modifiers або null. Комбінацію, яку використовує інша дія, буде відхилено.

Стежити за змінамиСкопіювати посилання на розділ

import asyncio
from spectre_terminal import Event

async def main():
    async with terminal.stream() as stream:
        await stream.subscribe("settings")
        async for frame in stream:
            if isinstance(frame, Event) and frame.topic == "settings":
                print(frame.data.scope, frame.data.category, frame.data.key, frame.data.value)

asyncio.run(main())

Кадр надходить на кожен збережений рядок, хто б його не зберіг. Підписка не надсилає початкового стану, тож спершу прочитайте значення через settings(). Докладніше: Стрімінг.

Коли виклик не вдаєтьсяСкопіювати посилання на розділ