Cluster · разработчикам

Text

HTML-текст с экранированием обычных значений и подсчётом длины в UTF-16.

Все методы SDK · Типы и ошибки

Получение объекта

text = app.text().bold("Cluster").line("Ready")

__init__

Создаёт Text. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.

def __init__(text: object = '') -> None: ...

Аргументы

• text: object, по умолчанию ''. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

None. Создаёт Text. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

# Обычный способ получения объекта:
text = app.text().bold("Cluster").line("Ready")

__str__

Возвращает собранный HTML для Telegram.

def __str__() -> str: ...

Аргументы

Нет.

Результат

str. Возвращает собранный HTML для Telegram.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

html = str(text)

plain

Возвращает текст без HTML-разметки.

def plain() -> str: ...

Свойство: читается без скобок и без await.

Аргументы

Нет.

Результат

str. Возвращает текст без HTML-разметки.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

value = text.plain

length

Возвращает длину plain в кодовых единицах UTF-16, как для смещений сущностей Telegram.

def length() -> int: ...

Свойство: читается без скобок и без await.

Аргументы

Нет.

Результат

int. Возвращает длину plain в кодовых единицах UTF-16, как для смещений сущностей Telegram.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

value = text.length

add

Добавляет обычное значение с HTML-экранированием либо копирует части другого Text.

def add(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет обычное значение с HTML-экранированием либо копирует части другого Text.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.add("Cluster")

line

Перед добавляемым текстом вставляет перенос, если текст уже непустой.

def line(text: object = '') -> Self: ...

Аргументы

• text: object, по умолчанию ''. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Перед добавляемым текстом вставляет перенос, если текст уже непустой.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.line()

mark

Оборачивает текст в переданный HTML-тег. Низкоуровневый метод: tag и attrs не экранируются и должны быть доверенными.

def mark(tag: str, text: object, attrs: str = '') -> Self: ...

Аргументы

• tag: str, обязательный. Доверенное имя HTML-тега. Содержимое tag не экранируется.
• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.
• attrs: str, по умолчанию ''. Доверенные HTML-атрибуты вместе с пробелом перед ними. Не вставляй сюда пользовательский ввод.

Результат

Self. Тот же объект после успешной операции. Оборачивает текст в переданный HTML-тег. Низкоуровневый метод: tag и attrs не экранируются и должны быть доверенными.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.mark("b", "Cluster")

bold

Добавляет жирный текст; обычные значения экранируются.

def bold(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет жирный текст; обычные значения экранируются.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.bold("Cluster")

italic

Добавляет курсивный текст.

def italic(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет курсивный текст.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.italic("Cluster")

underline

Добавляет подчёркнутый текст.

def underline(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет подчёркнутый текст.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.underline("Cluster")

strike

Добавляет зачёркнутый текст.

def strike(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет зачёркнутый текст.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.strike("Cluster")

spoiler

Добавляет спойлер Telegram.

def spoiler(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет спойлер Telegram.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.spoiler("Cluster")

code

Добавляет строковое представление значения как экранированный код.

def code(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет строковое представление значения как экранированный код.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.code("Cluster")

pre

Добавляет строковое представление значения в блок кода.

def pre(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет строковое представление значения в блок кода.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.pre("Cluster")

quote

Добавляет цитату blockquote.

def quote(text: object) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.

Результат

Self. Тот же объект после успешной операции. Добавляет цитату blockquote.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.quote("Cluster")

link

Добавляет ссылку с экранированием адреса. Разрешены схемы http, https, tg и mailto.

def link(text: object, url: str) -> Self: ...

Аргументы

• text: object, обязательный. Значение преобразуется в строку с экранированием либо добавляется как Text. У code/pre всегда используется строковое представление.
• url: str, обязательный. Полный HTTPS-адрес; для Socket требуется WSS. Ядро проверяет домен и допустимость адреса.

Результат

Self. Тот же объект после успешной операции. Добавляет ссылку с экранированием адреса. Разрешены схемы http, https, tg и mailto.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• ValueError('Invalid link'): условие проверяется до продолжения операции.

Пример

result = text.link("Cluster", "https://example.org/status")

clear

Удаляет все части текста.

def clear() -> Self: ...

Аргументы

Нет.

Результат

Self. Тот же объект после успешной операции. Удаляет все части текста.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = text.clear()