Бот

Экземпляр бота может быть создан из litegram.Bot (from litegram import Bot). Вы не сможете использовать методы без экземпляра бота с настроенным токеном.

Этот класс имеет псевдонимы для всех методов, именованных в snake_case.

Например, sendMessage называется send_message и имеет ту же спецификацию, что и все методы на основе классов.

Предупреждение

Полный список методов можно найти в соответствующем разделе документации

class litegram.client.bot.Bot(token: str, session: BaseSession | None = None, default: DefaultBotProperties | None = None, **kwargs: Any)[исходный код]

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

__init__(token: str, session: BaseSession | None = None, default: DefaultBotProperties | None = None, **kwargs: Any) → None[исходный код]

Класс Bot

Параметры:

  • token – Токен Telegram-бота, полученный от @BotFather

  • session – Сессия HTTP-клиента (например, HttpxSession). Если не указана, она будет создана автоматически.

  • default – Свойства бота по умолчанию. Если указаны, они будут распространяться на методы API во время выполнения.

Исключение:

TokenValidationError – Если токен имеет неверный формат, будет выброшено это исключение

property token: str
property id: int

Получить ID бота из токена

Результат:

context(auto_close: bool = True) → AsyncIterator[Bot][исходный код]

Сгенерировать контекст бота

Параметры:

auto_close – закрыть сессию при выходе

Результат:

async me() → User[исходный код]

Кэшированный псевдоним для метода getMe

Результат:

async download_file(file_path: str | Path, destination: BinaryIO | Path | str | None = None, timeout: int = 30, chunk_size: int = 65536, seek: bool = True) → BinaryIO | None[исходный код]

Скачать файл по file_path в место назначения.

Если вы хотите автоматически создать место назначения (io.BytesIO), используйте значение по умолчанию для destination и обработайте результат этого метода.

Параметры:

  • file_path – Путь к файлу на сервере Telegram (вы можете получить его из litegram.types.File)

  • destination – Имя файла, путь к файлу или экземпляр io.IOBase. Например, io.BytesIO, по умолчанию None

  • timeout – Общий таймаут в секундах, по умолчанию 30

  • chunk_size – Размер фрагментов файла, по умолчанию 64 КБ

  • seek – Перейти в начало файла после завершения загрузки. Используется только если destination имеет тип typing.BinaryIO, по умолчанию True

async download(file: str | Downloadable, destination: BinaryIO | pathlib.Path | str | None = None, timeout: int = 30, chunk_size: int = 65536, seek: bool = True) → BinaryIO | None[исходный код]

Скачать файл по file_id или объекту Downloadable в место назначения.

Если вы хотите автоматически создать место назначения (io.BytesIO), используйте значение по умолчанию для destination и обработайте результат этого метода.

Параметры:

  • file – file_id или объект Downloadable

  • destination – Имя файла, путь к файлу или экземпляр io.IOBase. Например, io.BytesIO, по умолчанию None

  • timeout – Общий таймаут в секундах, по умолчанию 30

  • chunk_size – Размер фрагментов файла, по умолчанию 64 КБ

  • seek – Перейти в начало файла после завершения загрузки. Используется только если destination имеет тип typing.BinaryIO, по умолчанию True