Параметры форматирования¶

Функции форматирования Markdown & HTML.

Added in version 4.5.1.

telebot.formatting.apply_html_entities(text: str, entities: List | None, custom_subs: Dict[str, str] | None) → str¶

Author: @sviat9440 Updaters: @badiboy, @EgorKhabarov Message: «Test parse _formatting_, [url](https://example.com), [text_mention](tg://user?id=123456) and mention @username»

Example:¶

apply_html_entities(text, entities)
>> "<b>Test</b> parse <i>formatting</i>, <a href="https://example.com">url</a>, <a href="tg://user?id=123456">text_mention</a> and mention @username"

Custom subs:: You can customize the substitutes. By default, there is no substitute for the entities: hashtag, bot_command, email. You can add or modify substitute an existing entity.

Example:¶

apply_html_entities(
    text,
    entities,
    {"bold": "<strong class="example">{text}</strong>", "italic": "<i class="example">{text}</i>", "mention": "<a href={url}>{text}</a>"},
)
>> "<strong class="example">Test</strong> parse <i class="example">formatting</i>, <a href="https://example.com">url</a> and <a href="tg://user?id=123456">text_mention</a> and mention <a href="https://t.me/username">@username</a>"

telebot.formatting.escape_html(content: str) → str¶

Пропускает HTML символы в HTML строке.

Параметры:: content (str) – HTML строка, которую нужно пропустить.
Результат:: Пропускаемая строка.
Тип результата:: str

telebot.formatting.escape_markdown(content: str) → str¶

Пропускает Markdown символы в Markdown строке.

Credits to: simonsmh

Параметры:: content (str) – Markdown строка, которую нужно пропустить.
Результат:: Пропускаемая строка.
Тип результата:: str

telebot.formatting.format_text(*args, separator='\n')¶

Преобразовывает набор строк в одну.

format_text( # just an example
    mbold('Hello'),
    mitalic('World')
)

Параметры:

args (str) – Строки для преобразования.
separator (str) – Символ для разделения строк.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hbold(content: str, escape: bool | None = True) → str¶

Возвращает выделенную жирным шрифтом HTML строку.

Параметры:

content (str) – Строка для выделения жирным шрифтом.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hcite(content: str, escape: bool | None = True) → str¶

Returns a html-formatted block-quotation string.

Параметры:

content (str) – Строка для выделения жирным шрифтом.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hcode(content: str, escape: bool | None = True) → str¶

Возвращает выделенную как код HTML строку.

Параметры:

content (str) – Строка для выделения как код.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hide_link(url: str) → str¶

Делает невидимым URL изображения.

Параметры:: url (str) – URL изображения.
Результат:: Невидимый URL.
Тип результата:: str

telebot.formatting.hitalic(content: str, escape: bool | None = True) → str¶

Возвращает выделенную курсивом HTML строку.

Параметры:

content (str) – Строка для выделения курсивом.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hlink(content: str, url: str, escape: bool | None = True) → str¶

Возвращает HTML строку с гиперссылкой.

Параметры:

content (str) – Строка для добавления гиперссылки.
url (str) – URL для создания гиперссылки.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hpre(content: str, escape: bool | None = True, language: str = '') → str¶

Возвращает предварительно отформатированную HTML строку.

Параметры:

content (str) – Строка для предварительного форматирования.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hspoiler(content: str, escape: bool | None = True) → str¶

Возвращает выделенную как спойлер HTML строку.

Параметры:

content (str) – Строка для выделения как спойлер.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hstrikethrough(content: str, escape: bool | None = True) → str¶

Возвращает зачеркнутую HTML строку.

Параметры:

content (str) – Строка для зачеркивания.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.hunderline(content: str, escape: bool | None = True) → str¶

Возвращает подчеркнутую HTML строку.

Параметры:

content (str) – Строка для подчёркивания.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mbold(content: str, escape: bool | None = True) → str¶

Возвращает выделенную жирным шрифтом Markdown строку.

Параметры:

content (str) – Строка для выделения жирным шрифтом.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mcite(content: str, escape: bool | None = True) → str¶

Returns a Markdown-formatted block-quotation string.

Параметры:

content (str) – Строка для выделения жирным шрифтом.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mcode(content: str, language: str = '', escape: bool | None = True) → str¶

Возвращает выделенную как код Markdown строку.

Параметры:

content (str) – Строка для выделения как код.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mitalic(content: str, escape: bool | None = True) → str¶

Возвращает выделенную курсивом Markdown строку.

Параметры:

content (str) – Строка для выделения курсивом.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mlink(content: str, url: str, escape: bool | None = True) → str¶

Возвращает Markdown строку с гиперссылкой.

Параметры:

content (str) – Строка для добавления гиперссылки.
url (str) – URL для создания гиперссылки.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mspoiler(content: str, escape: bool | None = True) → str¶

Возвращает выделенную как спойлер Markdown строку.

Параметры:

content (str) – Строка для выделения как спойлер.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.mstrikethrough(content: str, escape: bool | None = True) → str¶

Возвращает зачеркнутую Markdown строку.

Параметры:

content (str) – Строка для зачеркивания.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str

telebot.formatting.munderline(content: str, escape: bool | None = True) → str¶

Возвращает подчеркнутую Markdown строку.

Параметры:

content (str) – Строка для подчёркивания.
escape (bool) – True если вам нужно пропустить спец. символы. По умолчанию True.

Результат:

Преобразованная строка.

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

str