OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2025-01-03 09:49:21 +01:00
Code Issues Projects Releases Packages Wiki Activity

Refactor of telegram.Bot class and docstrings #232

Browse source
This commit is contained in:
Leandro Toledo 2016-04-19 09:04:25 -03:00
parent 9a340d2ea9
commit fc277d7393
2 changed files with 165 additions and 156 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/source/telegram.bot.rst
View file

@ -3,5 +3,4 @@ telegram.bot module
.. automodule:: telegram.bot .. automodule:: telegram.bot
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:

286
telegram/bot.py
View file

@ -52,15 +52,21 @@ class Bot(TelegramObject):
def __init__(self, def __init__(self,
token, token,
base_url=None): base_url=None,
base_file_url=None):
self.token = self._valid_token(token) self.token = self._valid_token(token)
if base_url is None: if not base_url:
self.base_url = 'https://api.telegram.org/bot%s' % self.token self.base_url = 'https://api.telegram.org/bot%s' % \
self.token
else: else:
self.base_url = base_url + self.token self.base_url = base_url + self.token
self.base_file_url = 'https://api.telegram.org/file/bot%s' % self.token if not base_file_url:
self.base_file_url = 'https://api.telegram.org/file/bot%s' % \
self.token
else:
self.base_file_url = base_file_url + self.token
self.bot = None self.bot = None
@ -145,28 +151,14 @@ class Bot(TelegramObject):
decorator decorator
""" """
url, data = func(self, *args, **kwargs) url, data = func(self, *args, **kwargs)
return Bot._post_message(url, data, kwargs)
return decorator
@staticmethod
def _post_message(url, data, kwargs, timeout=None, network_delay=2.):
"""Posts a message to the telegram servers.
Returns:
telegram.Message
"""
if not data.get('chat_id'):
raise TelegramError('Invalid chat_id')
if kwargs.get('reply_to_message_id'): if kwargs.get('reply_to_message_id'):
reply_to_message_id = kwargs.get('reply_to_message_id') data['reply_to_message_id'] = \
data['reply_to_message_id'] = reply_to_message_id kwargs.get('reply_to_message_id')
if kwargs.get('disable_notification'): if kwargs.get('disable_notification'):
disable_notification = kwargs.get('disable_notification') data['disable_notification'] = \
data['disable_notification'] = disable_notification kwargs.get('disable_notification')
if kwargs.get('reply_markup'): if kwargs.get('reply_markup'):
reply_markup = kwargs.get('reply_markup') reply_markup = kwargs.get('reply_markup')
@ -175,14 +167,17 @@ class Bot(TelegramObject):
else: else:
data['reply_markup'] = reply_markup data['reply_markup'] = reply_markup
result = request.post(url, data, timeout=timeout, result = request.post(url, data,
network_delay=network_delay) timeout=kwargs.get('timeout'),
network_delay=kwargs.get('network_delay'))
if result is True: if result is True:
return result return result
return Message.de_json(result) return Message.de_json(result)
return decorator
@log @log
def getMe(self): def getMe(self):
"""A simple method for testing your bot's auth token. """A simple method for testing your bot's auth token.
@ -210,29 +205,36 @@ class Bot(TelegramObject):
"""Use this method to send text messages. """Use this method to send text messages.
Args: Args:
chat_id: chat_id (str): Unique identifier for the target chat or
Unique identifier for the message recipient - telegram.Chat id. username of the target channel (in the format
parse_mode: @channelusername).
Send 'Markdown', if you want Telegram apps to show bold, italic and text (str): Text of the message to be sent. The current maximum
inline URLs in your bot's message. [Optional] length is 4096 UTF-8 characters.
text: parse_mode (Optional[str]): Send Markdown or HTML, if you want
Text of the message to be sent. The current maximum length is 4096 Telegram apps to show bold, italic, fixed-width text or inline
UTF8 characters. URLs in your bot's message.
disable_web_page_preview: disable_web_page_preview (Optional[bool]): Disables link previews
Disables link previews for links in this message. [Optional] for links in this message.
disable_notification: **kwargs (dict): Arbitrary keyword arguments.
Sends the message silently. iOS users will not receive
a notification, Android users will receive a notification Keyword Args:
with no sound. Other apps coming soon. [Optional] disable_notification (Optional[bool]): Sends the message silently.
reply_to_message_id: iOS users will not receive a notification, Android users will
If the message is a reply, ID of the original message. [Optional] receive a notification with no sound.
reply_markup: reply_to_message_id (Optional[int]): If the message is a reply,
Additional interface options. A JSON-serialized object for a custom ID of the original message.
reply keyboard, instructions to hide keyboard or to force a reply reply_markup (Optional[:class:`telegram.ReplyMarkup`]): Additional
from the user. [Optional] interface options. A JSON-serialized object for an inline
keyboard, custom reply keyboard, instructions to hide reply
keyboard or to force a reply from the user.
Returns: Returns:
A telegram.Message instance representing the message posted. :class:`telegram.Message`: On success, the sent message is
returned.
Raises:
:class:`telegram.TelegramError`
""" """
url = '%s/sendMessage' % self.base_url url = '%s/sendMessage' % self.base_url
@ -275,6 +277,7 @@ class Bot(TelegramObject):
url = '%s/forwardMessage' % self.base_url url = '%s/forwardMessage' % self.base_url
data = {} data = {}
if chat_id: if chat_id:
data['chat_id'] = chat_id data['chat_id'] = chat_id
if from_chat_id: if from_chat_id:
@ -472,12 +475,12 @@ class Bot(TelegramObject):
return url, data return url, data
@log @log
@message
def sendVideo(self, def sendVideo(self,
chat_id, chat_id,
video, video,
duration=None, duration=None,
caption=None, caption=None,
timeout=None,
**kwargs): **kwargs):
"""Use this method to send video files, Telegram clients support mp4 """Use this method to send video files, Telegram clients support mp4
videos (other formats may be sent as telegram.Document). videos (other formats may be sent as telegram.Document).
@ -522,7 +525,7 @@ class Bot(TelegramObject):
if caption: if caption:
data['caption'] = caption data['caption'] = caption
return self._post_message(url, data, kwargs, timeout=timeout) return url, data
@log @log
@message @message
@ -752,39 +755,37 @@ class Bot(TelegramObject):
next_offset=None, next_offset=None,
switch_pm_text=None, switch_pm_text=None,
switch_pm_parameter=None): switch_pm_parameter=None):
"""Use this method to reply to an inline query. """Use this method to send answers to an inline query. No more than
50 results per query are allowed.
Args: Args:
inline_query_id (str): inline_query_id (str): Unique identifier for the answered query.
Unique identifier for answered query results (list[:class:`telegram.InlineQueryResult`]): A list of
results (list[InlineQueryResult]): results for the inline query.
A list of results for the inline query cache_time (Optional[int]): The maximum amount of time the
result of the inline query may be cached on the server.
Keyword Args: is_personal (Optional[bool]): Pass `True`, if results may be
cache_time (Optional[int]): cached on the server side only for the user that sent the
The maximum amount of time the result of the inline query query. By default, results may be returned to any user who
may be cached on the server sends the same query.
is_personal (Optional[bool]): next_offset (Optional[str]): Pass the offset that a client
Pass True, if results may be cached on the server side only should send in the next query with the same text to receive
for the user that sent the query. By default, results may be more results. Pass an empty string if there are no more
returned to any user who sends the same query. results or if you don't support pagination. Offset length
next_offset (Optional[str]): can't exceed 64 bytes.
Pass the offset that a client should send in the next query switch_pm_text (Optional[str]): If passed, clients will display
with the same text to receive more results. Pass an empty a button with specified text that switches the user to a
string if there are no more results or if you don't support private chat with the bot and sends the bot a start message
pagination. Offset length can't exceed 64 bytes. with the parameter switch_pm_parameter.
switch_pm_text (Optional[str]): switch_pm_parameter (Optional[str]): Parameter for the start
If passed, clients will display a button with specified text message sent to the bot when user presses the switch button.
that switches the user to a private chat with the bot and
sends the bot a start message with the parameter
switch_pm_parameter.
switch_pm_parameter (Optional[str]):
Parameter for the start message sent to the bot when user
presses the switch button.
Returns: Returns:
A boolean if answering was successful bool: On success, `True` is returned.
Raises:
:class:`telegram.TelegramError`
""" """
validate_string(inline_query_id, 'inline_query_id') validate_string(inline_query_id, 'inline_query_id')
@ -936,22 +937,25 @@ class Bot(TelegramObject):
callback_query_id, callback_query_id,
text=None, text=None,
show_alert=False): show_alert=False):
"""Use this method to send answers to callback queries sent from inline """Use this method to send answers to callback queries sent from
keyboards. The answer will be displayed to the user as a notification inline keyboards. The answer will be displayed to the user as a
at the top of the chat screen or as an alert. notification at the top of the chat screen or as an alert.
Args: Args:
callback_query_id: callback_query_id (str): Unique identifier for the query to be
Unique identifier for the query to be answered. answered.
text: text (Optional[str]): Text of the notification. If not
Text of the notification. If not specified, nothing will be shown specified, nothing will be shown to the user.
to the user. show_alert (Optional[bool]): If `True`, an alert will be shown
show_alert: by the client instead of a notification at the top of the chat
If true, an alert will be shown by the client instead of a screen. Defaults to `False`.
notification at the top of the chat screen. Defaults to false.
Returns: Returns:
True on success. bool: On success, `True` is returned.
Raises:
:class:`telegram.TelegramError`
""" """
url = '%s/answerCallbackQuery' % self.base_url url = '%s/answerCallbackQuery' % self.base_url
@ -1014,9 +1018,9 @@ class Bot(TelegramObject):
data['message_id'] = message_id data['message_id'] = message_id
if inline_message_id: if inline_message_id:
data['inline_message_id'] = inline_message_id data['inline_message_id'] = inline_message_id
if reply_markup: if parse_mode:
data['parse_mode'] = parse_mode data['parse_mode'] = parse_mode
if reply_markup: if disable_web_page_preview:
data['disable_web_page_preview'] = disable_web_page_preview data['disable_web_page_preview'] = disable_web_page_preview
if reply_markup: if reply_markup:
if isinstance(reply_markup, ReplyMarkup): if isinstance(reply_markup, ReplyMarkup):
@ -1029,88 +1033,94 @@ class Bot(TelegramObject):
return Message.de_json(result) return Message.de_json(result)
@log @log
@message
def editMessageCaption(self, def editMessageCaption(self,
caption,
chat_id=None, chat_id=None,
message_id=None, message_id=None,
inline_message_id=None, inline_message_id=None,
reply_markup=None): caption=None,
"""Use this method to edit captions of messages sent by the bot or via **kwargs):
the bot (for inline bots). """Use this method to edit captions of messages sent by the bot or
via the bot (for inline bots).
Args: Args:
caption: chat_id (Optional[str]): Required if inline_message_id is not
New caption of the message. specified. Unique identifier for the target chat or username of
chat_id: the target channel (in the format @channelusername).
Required if inline_message_id is not specified. Unique identifier message_id (Optional[str]): Required if inline_message_id is not
for the target chat or username of the target channel (in the specified. Unique identifier of the sent message.
format @channelusername). inline_message_id (Optional[str]): Required if chat_id and
message_id: message_id are not specified. Identifier of the inline message.
Required if inline_message_id is not specified. Unique identifier caption (Optional[str]): New caption of the message.
of the sent message. **kwargs (Optional[dict]): Arbitrary keyword arguments.
inline_message_id:
Required if chat_id and message_id are not specified. Identifier of Keyword Args:
the inline message. reply_markup (Optional[:class:`telegram.InlineKeyboardMarkup`]):
reply_markup:
A JSON-serialized object for an inline keyboard. A JSON-serialized object for an inline keyboard.
Returns: Returns:
Returns a telegram.Message object. :class:`telegram.Message`: On success, if edited message is sent by
the bot, the edited Message is returned, otherwise `True` is
returned.
Raises:
:class:`telegram.TelegramError`
""" """
url = '%s/editMessageCaption' % self.base_url url = '%s/editMessageCaption' % self.base_url
data = {'caption': caption} data = {}
if caption:
data['caption'] = caption
if chat_id: if chat_id:
data['chat_id'] = chat_id data['chat_id'] = chat_id
if message_id: if message_id:
data['message_id'] = message_id data['message_id'] = message_id
if inline_message_id: if inline_message_id:
data['inline_message_id'] = inline_message_id data['inline_message_id'] = inline_message_id
if reply_markup:
if isinstance(reply_markup, ReplyMarkup):
data['reply_markup'] = reply_markup.to_json()
else:
data['reply_markup'] = reply_markup
result = request.post(url, data) return url, data
return Message.de_json(result)
@log @log
@message
def editMessageReplyMarkup(self, def editMessageReplyMarkup(self,
reply_markup,
chat_id=None, chat_id=None,
message_id=None, message_id=None,
inline_message_id=None): inline_message_id=None,
**kwargs):
"""Use this method to edit only the reply markup of messages sent by """Use this method to edit only the reply markup of messages sent by
the bot or via the bot (for inline bots). the bot or via the bot (for inline bots).
Args: Args:
reply_markup: chat_id (Optional[str]): Required if inline_message_id is not
specified. Unique identifier for the target chat or username of
the target channel (in the format @channelusername).
message_id (Optional[str]): Required if inline_message_id is not
specified. Unique identifier of the sent message.
inline_message_id (Optional[str]): Required if chat_id and
message_id are not specified. Identifier of the inline message.
**kwargs (Optional[dict]): Arbitrary keyword arguments.
Keyword Args:
reply_markup (Optional[:class:`telegram.InlineKeyboardMarkup`]):
A JSON-serialized object for an inline keyboard. A JSON-serialized object for an inline keyboard.
chat_id:
Required if inline_message_id is not specified. Unique identifier
for the target chat or username of the target channel (in the
format @channelusername).
message_id:
Required if inline_message_id is not specified. Unique identifier
of the sent message.
inline_message_id:
Required if chat_id and message_id are not specified. Identifier of
the inline message.
Returns: Returns:
Returns a telegram.Message object. :class:`telegram.Message`: On success, if edited message is sent by
the bot, the edited message is returned, otherwise `True` is
returned.
Raises:
:class:`telegram.TelegramError`
""" """
url = '%s/editMessageReplyMarkup' % self.base_url url = '%s/editMessageReplyMarkup' % self.base_url
if isinstance(reply_markup, ReplyMarkup): data = {}
reply_markup = reply_markup.to_json()
data = {'reply_markup': reply_markup}
if chat_id: if chat_id:
data['chat_id'] = chat_id data['chat_id'] = chat_id
@ -1119,9 +1129,7 @@ class Bot(TelegramObject):
if inline_message_id: if inline_message_id:
data['inline_message_id'] = inline_message_id data['inline_message_id'] = inline_message_id
result = request.post(url, data) return url, data
return Message.de_json(result)
@log @log
def getUpdates(self, def getUpdates(self,
@ -1157,6 +1165,7 @@ class Bot(TelegramObject):
url = '%s/getUpdates' % self.base_url url = '%s/getUpdates' % self.base_url
data = {} data = {}
if offset: if offset:
data['offset'] = offset data['offset'] = offset
if limit: if limit:
@ -1195,6 +1204,7 @@ class Bot(TelegramObject):
url = '%s/setWebhook' % self.base_url url = '%s/setWebhook' % self.base_url
data = {} data = {}
if webhook_url or webhook_url == '': if webhook_url or webhook_url == '':
data['url'] = webhook_url data['url'] = webhook_url
if certificate: if certificate: