Модуль moexalgo.session

class moexalgo.session.Client(sync: bool = True, **options)

Базовые классы: HasOptions

Клиент для работы с API.

sync

Синхронный режим работы.

Type:

bool

authorized

Авторизован ли клиент.

Type:

bool

httpx_cli

Клиент для работы с HTTP.

Type:

httpx.Client | httpx.AsyncClient

authorize(username: str, password: str) → str | None

Авторизация клиента.

Параметры:

  • username (str) – Имя пользователя.

  • password (str) – Пароль пользователя.

Результат:

return – Сертификат авторизации или None, если авторизация не удалась.

Тип результата:

Optional[str]

property authorized: bool

Авторизован ли клиент.

Результат:

return – True если клиент авторизован, иначе False.

Тип результата:

bool

static format_error(exc: HTTPStatusError) → str

Форматирование ошибки.

Параметры:

exc (httpx.HTTPStatusError) – Исключение HTTP.

Результат:

return – Сообщение об ошибке и рекомендации.

Тип результата:

str

get_objects(path: str, deserializer: Callable[[dict], dict | list], **params) → dict | list

Получение объектов по переданному адресу.

Параметры:

  • path (str) – Путь к объектам.

  • deserializer (callable) – Функция десериализации.

  • params (dict) – Параметры запроса.

Результат:

return – Объекты или список объектов.

Тип результата:

Union[dict, list]

Исключение:

  • httpx.HTTPStatusError – Вызывается, если запрос завершился неудачно.

  • ValueError – Вызывается, если получен неверный ответ.

property sync: bool

Синхронный режим работы клиента.

Результат:

return – True если клиент синхронный, иначе False.

Тип результата:

bool

class moexalgo.session.HasOptions(auth_cert: str | None = None, base_url: str | None = None, timeout: int = 300, **options)

Базовые классы: object

Базовый класс для объектов с опциями.

options

Опционные параметры.

Type:

dict

property options: dict

Опционные параметры использованные при создании сессии/клиента.

Результат:

return – Опционные параметры.

Тип результата:

dict

class moexalgo.session.Session(cs: HasOptions | None = None, **options)

Базовые классы: HasOptions

Сессия для работы с API.

_client

Клиент для работы с API.

Type:

Client

moexalgo.session.authorize(username: str, password: str) → bool

Авторизация сессии по умолчанию.

Параметры:

  • username (str) – Имя пользователя.

  • password (str) – Пароль пользователя.

Результат:

return – True, если авторизация прошла успешно, иначе False.

Тип результата:

bool

moexalgo.session.data_gen(cs: Session, path: str, options: dict, offset: int, limit: int, section: str = 'data') → Iterator[dict] | None

Генератор данных.

Параметры:

  • cs (Session) – Сессия клиента.

  • path (str) – Путь к данным.

  • options (dict) – Опции запроса.

  • offset (int) – Смещение данных.

  • limit (int) – Лимит данных.

  • section (str, optional) – Секция данных, by default „data“.

Результат:

return – Итератор с данными или None, если данных нет.

Тип результата:

Optional[Iterator[dict]]