mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-09-02 15:25:41 +00:00
Code Issues Releases Wiki Activity

Update parse_mode parameter docstrings

Browse Source
This commit is contained in:
Dan
2019-06-26 16:36:24 +02:00
parent 197cf5506c
commit 39e25147bd
20 changed files with 150 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
pyrogram/client/methods/messages/edit_inline_caption.py
View File

@@ -38,8 +38,11 @@ class EditInlineCaption(BaseClient):
New caption of the media message. New caption of the media message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*): reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object. An InlineKeyboardMarkup object.

7
pyrogram/client/methods/messages/edit_inline_text.py
View File

@@ -42,8 +42,11 @@ class EditInlineText(BaseClient):
New text of the message. New text of the message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.

7
pyrogram/client/methods/messages/edit_message_caption.py
View File

@@ -46,8 +46,11 @@ class EditMessageCaption(BaseClient):
New caption of the media message. New caption of the media message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*): reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object. An InlineKeyboardMarkup object.

7
pyrogram/client/methods/messages/edit_message_text.py
View File

@@ -48,8 +48,11 @@ class EditMessageText(BaseClient):
New text of the message. New text of the message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.

7
pyrogram/client/methods/messages/send_animation.py
View File

@@ -70,8 +70,11 @@ class SendAnimation(BaseClient):
Pass True to automatically unsave the sent animation. Defaults to False. Pass True to automatically unsave the sent animation. Defaults to False.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of sent animation in seconds. Duration of sent animation in seconds.

7
pyrogram/client/methods/messages/send_audio.py
View File

@@ -67,8 +67,11 @@ class SendAudio(BaseClient):
Audio caption, 0-1024 characters. Audio caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of the audio in seconds. Duration of the audio in seconds.

7
pyrogram/client/methods/messages/send_cached_media.py
View File

@@ -59,8 +59,11 @@ class SendCachedMedia(BaseClient):
Media caption, 0-1024 characters. Media caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_notification (``bool``, *optional*): disable_notification (``bool``, *optional*):
Sends the message silently. Sends the message silently.

7
pyrogram/client/methods/messages/send_document.py
View File

@@ -68,8 +68,11 @@ class SendDocument(BaseClient):
Document caption, 0-1024 characters. Document caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_notification (``bool``, *optional*): disable_notification (``bool``, *optional*):
Sends the message silently. Sends the message silently.

7
pyrogram/client/methods/messages/send_message.py
View File

@@ -51,8 +51,11 @@ class SendMessage(BaseClient):
Text of the message to be sent. Text of the message to be sent.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.

7
pyrogram/client/methods/messages/send_photo.py
View File

@@ -62,8 +62,11 @@ class SendPhoto(BaseClient):
Photo caption, 0-1024 characters. Photo caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
ttl_seconds (``int``, *optional*): ttl_seconds (``int``, *optional*):
Self-Destruct Timer. Self-Destruct Timer.

7
pyrogram/client/methods/messages/send_video.py
View File

@@ -66,8 +66,11 @@ class SendVideo(BaseClient):
Video caption, 0-1024 characters. Video caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of sent video in seconds. Duration of sent video in seconds.

7
pyrogram/client/methods/messages/send_voice.py
View File

@@ -62,8 +62,11 @@ class SendVoice(BaseClient):
Voice message caption, 0-1024 characters. Voice message caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of the voice message in seconds. Duration of the voice message in seconds.

14
pyrogram/client/types/bots_and_keyboards/callback_query.py
View File

@@ -189,8 +189,11 @@ class CallbackQuery(Object, Update):
New text of the message. New text of the message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.
@@ -238,8 +241,11 @@ class CallbackQuery(Object, Update):
New caption of the message. New caption of the message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*): reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object. An InlineKeyboardMarkup object.

7
pyrogram/client/types/input_media/input_media_animation.py
View File

@@ -38,8 +38,11 @@ class InputMediaAnimation(InputMedia):
Caption of the animation to be sent, 0-1024 characters Caption of the animation to be sent, 0-1024 characters
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs By default, texts are parsed using both Markdown and HTML styles.
in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
width (``int``, *optional*): width (``int``, *optional*):
Animation width. Animation width.

7
pyrogram/client/types/input_media/input_media_audio.py
View File

@@ -40,8 +40,11 @@ class InputMediaAudio(InputMedia):
Caption of the audio to be sent, 0-1024 characters Caption of the audio to be sent, 0-1024 characters
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs By default, texts are parsed using both Markdown and HTML styles.
in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of the audio in seconds Duration of the audio in seconds

7
pyrogram/client/types/input_media/input_media_document.py
View File

@@ -38,8 +38,11 @@ class InputMediaDocument(InputMedia):
Caption of the document to be sent, 0-1024 characters Caption of the document to be sent, 0-1024 characters
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs By default, texts are parsed using both Markdown and HTML styles.
in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
""" """
__slots__ = ["thumb"] __slots__ = ["thumb"]

7
pyrogram/client/types/input_media/input_media_photo.py
View File

@@ -34,8 +34,11 @@ class InputMediaPhoto(InputMedia):
Caption of the photo to be sent, 0-1024 characters Caption of the photo to be sent, 0-1024 characters
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs By default, texts are parsed using both Markdown and HTML styles.
in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
""" """
__slots__ = [] __slots__ = []

7
pyrogram/client/types/input_media/input_media_video.py
View File

@@ -40,8 +40,11 @@ class InputMediaVideo(InputMedia):
Caption of the video to be sent, 0-1024 characters Caption of the video to be sent, 0-1024 characters
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs By default, texts are parsed using both Markdown and HTML styles.
in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
width (``int``, *optional*): width (``int``, *optional*):
Video width. Video width.

7
pyrogram/client/types/input_message_content/input_text_message_content.py
View File

@@ -31,8 +31,11 @@ class InputTextMessageContent(InputMessageContent):
Text of the message to be sent, 1-4096 characters. Text of the message to be sent, 1-4096 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs By default, texts are parsed using both Markdown and HTML styles.
in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.

70
pyrogram/client/types/messages_and_media/message.py
View File

@@ -686,8 +686,11 @@ class Message(Object, Update):
Defaults to ``True`` in group chats and ``False`` in private chats. Defaults to ``True`` in group chats and ``False`` in private chats.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.
@@ -780,8 +783,11 @@ class Message(Object, Update):
Animation caption, 0-1024 characters. Animation caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of sent animation in seconds. Duration of sent animation in seconds.
@@ -914,8 +920,11 @@ class Message(Object, Update):
Audio caption, 0-1024 characters. Audio caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of the audio in seconds. Duration of the audio in seconds.
@@ -1040,8 +1049,11 @@ class Message(Object, Update):
Media caption, 0-1024 characters. Media caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_notification (``bool``, *optional*): disable_notification (``bool``, *optional*):
Sends the message silently. Sends the message silently.
@@ -1255,8 +1267,11 @@ class Message(Object, Update):
Document caption, 0-1024 characters. Document caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_notification (``bool``, *optional*): disable_notification (``bool``, *optional*):
Sends the message silently. Sends the message silently.
@@ -1642,8 +1657,11 @@ class Message(Object, Update):
Photo caption, 0-1024 characters. Photo caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
ttl_seconds (``int``, *optional*): ttl_seconds (``int``, *optional*):
Self-Destruct Timer. Self-Destruct Timer.
@@ -2037,8 +2055,11 @@ class Message(Object, Update):
Video caption, 0-1024 characters. Video caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of sent video in seconds. Duration of sent video in seconds.
@@ -2290,8 +2311,11 @@ class Message(Object, Update):
Voice message caption, 0-1024 characters. Voice message caption, 0-1024 characters.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your caption. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
duration (``int``, *optional*): duration (``int``, *optional*):
Duration of the voice message in seconds. Duration of the voice message in seconds.
@@ -2385,8 +2409,11 @@ class Message(Object, Update):
New text of the message. New text of the message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
disable_web_page_preview (``bool``, *optional*): disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message. Disables link previews for links in this message.
@@ -2439,8 +2466,11 @@ class Message(Object, Update):
New caption of the message. New caption of the message.
parse_mode (``str``, *optional*): parse_mode (``str``, *optional*):
Pass "markdown" or "html" if you want Telegram apps to show bold, italic, fixed-width text or inline By default, texts are parsed using both Markdown and HTML styles.
URLs in your message. Defaults to "markdown". You can combine both syntaxes together.
Pass "markdown" to enable Markdown-style parsing only.
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*): reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object. An InlineKeyboardMarkup object.