Справочник API: Python
Справочник по каждому классу, методу, полю и ошибке пакета brokapi для Python собирается из docstring в коде (pdoc), поэтому он не
расходится с кодом. Он на английском. Книга объясняет, как это устроено и что делать, справочник отвечает на вопрос «что делает
этот метод и какие ошибки поднимет».
Справочник лежит рядом с книгой: Справочник API Python. Вверху его страниц есть путь назад в книгу. Страницы не делают запросов к внешним адресам: шрифты и стили свои.
Тот же справочник текстом, одним файлом, для чтения агентом: python/api-reference.md (сигнатуры и описания классов и методов без оформления).
| Модуль | Что в нем | Справочник |
|---|---|---|
brokapi | connect, Client, EventStream, merge, new_cid: все, что нужно для работы, и общий обзор | brokapi |
brokapi.models | данные: инструменты, стакан, заявки, события, возможности | brokapi.models |
brokapi.record | запись событий в файл и проигрыш из файла (тот же формат, что у Rust) | brokapi.record |
brokapi.errors | исключения с теми же именами, что у Error в Rust, и ErrorClass | brokapi.errors |
brokapi.numbers | точное округление до шага цены (round_to_step) | brokapi.numbers |
brokapi.testing | имитации брокеров для тестов | brokapi.testing |
Примеры в docstring, помеченные >>>, запускаются тестом (pytest --doctest-modules), так что справочник не может тихо устареть.
Справочник Rust: Справочник API: Rust. Имена ошибок, событий и возможностей у Python те же, что у ядра, поэтому Ошибки и что с ними делать и События и возможности верны для обоих.
Листать можно клавишами Влево и Вправо.