Cache

class dublib.TelebotUtils.Cache.Cache(file_id: int, message_id: int, type: InputFile)[исходный код]: Данные кэша.

class dublib.TelebotUtils.Cache.CachedFile(identificator: PathLike | str, chat_id: int, file_id: str, message_id: int | None = None, data: dict | None = None, type: InputMedia | None = None)[исходный код]

Данные кэшированного файла.

property chat_id: int: Идентификатор чата с файлом.

property data: dict: Словарь дополнительных данных.

property file_id: str: Идентификатор файла на сервере Telegram.

property message_id: int | None: Идентификатор сообщения с файлом.

property type: InputMedia | None: Тип представления файла в Telegram.

class dublib.TelebotUtils.Cache.FileTypes(*values)[исходный код]: Перечисление представлений файлов.

class dublib.TelebotUtils.Cache.RealCachedFile(identificator: PathLike | str, chat_id: int, file_id: str, message_id: int | None = None, data: dict | None = None, type: InputMedia | None = None)[исходный код]

property path: PathLike: Путь к файлу или его виртуальный идентификатор.

to_dict() → dict[исходный код]

Возвращает словарное представление объекта.

Результат:: Словарное представление объекта.
Тип результата:: dict

class dublib.TelebotUtils.Cache.TeleCache(storage_path: PathLike | None = None)[исходный код]

Менеджер кэша загружаемых в Telegram файлов.

cache_real_file(path: PathLike, type: InputMedia | None = None, data: dict | None = None) → RealCachedFile[исходный код]

Кэширует реальный файл.

Параметры:

path (PathLike) – Путь к файлу.
type (types.InputMedia | None) – Тип вложения (по умолчанию types.InputMediaDocument).
data (dict | None) – Словарь дополнительных данных.

Результат:

Данные кэша реального файла.

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

RealCachedFile

cache_virtual_file(path: PathLike, identificator: str, type: InputMedia | None = None, data: dict | None = None) → VirtualCachedFile[исходный код]

Кэширует виртуальный файл.

Параметры:

path (PathLike) – Путь к файлу.
identificator (str) – Идентификатор файла.
type (types.InputMedia | None) – Тип вложения (по умолчанию types.InputMediaDocument).
data (dict | None) – Словарь дополнительных данных.

Результат:

Данные кэша виртуального файла.

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

VirtualCachedFile

clear_real_cache()[исходный код]: Удаляет данные кэшированных файлов, пути к которым более не являются валидными.

drop()[исходный код]: Удаляет данные всех кэшированных файлов.

drop_real_cache()[исходный код]: Удаляет данные всех реальных кэшированных файлов.

drop_virtual_cache()[исходный код]: Удаляет данные всех виртуальных кэшированных файлов.

get_real_cached_file(path: PathLike, autoupload_type: InputMedia | None = None) → RealCachedFile[исходный код]

Возвращает данные кэша реального файла.

Параметры:

path (PathLike) – Путь к файлу.
autoupload_type (types.InputMedia | None) – Если файл отсутствует в кэше, а тип указан, то он автоматически будет выгружен на сервера Telegram.

Исключение:

FileNotFoundError – Выбрасывается при отсутствии файла.

Результат:

Данные кэша реального файла.

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

RealCachedFile

get_virtual_cached_file(identificator: str) → VirtualCachedFile[исходный код]

Возвращает данные кэша виртуального файла.

Параметры:: identificator (str) – Идентификатор файла.
Исключение:: KeyError – Выбрасывается при отсутствии кэша файла с указанным идентификатором.
Результат:: Данные кэша виртуального файла.
Тип результата:: VirtualCachedFile

has_real_cache(path: PathLike) → bool[исходный код]

Проверяет наличие реального файла в кэше.

Параметры:: path (PathLike) – Путь к файлу.
Результат:: Возвращает True, если указанный файл найден в кэше.
Тип результата:: bool

has_virtual_cache(identificator: str) → bool[исходный код]

Проверяет наличие виртуального файла в кэше.

Параметры:: identificator (str) – Идентификатор файла.
Результат:: Возвращает True, если указанный файл найден в кэше.
Тип результата:: bool

register_real_file(path: PathLike, chat_id: int, file_id: str, message_id: int | None = None, data: dict | None = None, type: InputMedia | None = None) → RealCachedFile[исходный код]

Регистрирует в хранилище данные кэша реального файла.

Параметры:

path (PathLike) – Путь к файлу.
chat_id (int) – ID чата.
file_id (str) – ID файла.
message_id (int | None) – ID сообщения с файлом.
data (dict | None) – Словарь дополнительных данных.
type (types.InputMedia | None) – Тип представления файла.

Результат:

Данные кэша реального файла.

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

RealCachedFile

register_virtual_file(identificator: str, chat_id: int, file_id: str, message_id: int | None = None, data: dict | None = None, type: InputMedia | None = None) → VirtualCachedFile[исходный код]

Регистрирует в хранилище данные кэша виртуального файла.

Параметры:

identificator (str) – Идентификатор файла.
chat_id (int) – ID чата.
file_id (str) – ID файла.
message_id (int | None) – ID сообщения с файлом.
data (dict | None) – Словарь дополнительных данных.
type (types.InputMedia | None) – Тип представления файла.

Результат:

Данные кэша виртуального файла.

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

VirtualCachedFile

remove_real_cache(path: PathLike)[исходный код]

Удаляет из хранилища данные кэша реального файла.

Параметры:: path (PathLike) – Путь к файлу.
Исключение:: KeyError – Выбрасывается при отсутствии кэша файла по указанному пути.

remove_virtual_cache(identificator: str)[исходный код]

Удаляет из хранилища данные кэша виртуального файла.

Параметры:: identificator (str) – Идентификатор файла.
Исключение:: KeyError – Выбрасывается при отсутствии кэша файла с указанным идентификатором.

save()[исходный код]: Сохраняет данные кэша.

set_bot(bot: TeleBot | str)[исходный код]

Задаёт используемого для выгрузки бота Telegram.

Параметры:: bot (TeleBot | str) – Токен бота Telegram или объект бота.

set_chat_id(chat_id: int)[исходный код]

Задаёт используемого для выгрузки бота Telegram.

Параметры:: chat_id (int) – ID чата для отправки сообщений с файлами.

class dublib.TelebotUtils.Cache.VirtualCachedFile(identificator: PathLike | str, chat_id: int, file_id: str, message_id: int | None = None, data: dict | None = None, type: InputMedia | None = None)[исходный код]

property identificator: str: Идентификатор файла.

to_dict() → dict[исходный код]

Возвращает словарное представление объекта.

Результат:: Словарное представление объекта.
Тип результата:: dict