Merge pull request #592 from python-telegram-bot/snake_case

prefer snake_case for telegram.Bot methods

telegram/bot.py

@@ -160,7 +160,7 @@ class Bot(TelegramObject):
         return decorator
 
     @log
-    def getMe(self, timeout=None, **kwargs):
+    def get_me(self, timeout=None, **kwargs):
         """A simple method for testing your bot's auth token.
 
         Args:
@@ -186,7 +186,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendMessage(self,
+    def send_message(self,
                      chat_id,
                      text,
                      parse_mode=None,
@@ -243,7 +243,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def forwardMessage(self,
+    def forward_message(self,
                         chat_id,
                         from_chat_id,
                         message_id,
@@ -285,7 +285,7 @@ class Bot(TelegramObject):
         return url, data
 
     @log
-    def sendPhoto(self,
+    def send_photo(self,
                    chat_id,
                    photo,
                    caption=None,
@@ -339,7 +339,7 @@ class Bot(TelegramObject):
             **kwargs)
 
     @log
-    def sendAudio(self,
+    def send_audio(self,
                    chat_id,
                    audio,
                    duration=None,
@@ -417,7 +417,7 @@ class Bot(TelegramObject):
             **kwargs)
 
     @log
-    def sendDocument(self,
+    def send_document(self,
                       chat_id,
                       document,
                       filename=None,
@@ -478,7 +478,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendSticker(self,
+    def send_sticker(self,
                      chat_id,
                      sticker,
                      disable_notification=False,
@@ -519,7 +519,7 @@ class Bot(TelegramObject):
         return url, data
 
     @log
-    def sendVideo(self,
+    def send_video(self,
                    chat_id,
                    video,
                    duration=None,
@@ -579,7 +579,7 @@ class Bot(TelegramObject):
             **kwargs)
 
     @log
-    def sendVoice(self,
+    def send_voice(self,
                    chat_id,
                    voice,
                    duration=None,
@@ -643,7 +643,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendLocation(self,
+    def send_location(self,
                       chat_id,
                       latitude,
                       longitude,
@@ -685,7 +685,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendVenue(self,
+    def send_venue(self,
                    chat_id,
                    latitude,
                    longitude,
@@ -744,7 +744,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendContact(self,
+    def send_contact(self,
                      chat_id,
                      phone_number,
                      first_name,
@@ -793,7 +793,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendGame(self,
+    def send_game(self,
                   chat_id,
                   game_short_name,
                   disable_notification=False,
@@ -836,7 +836,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def sendChatAction(self, chat_id, action, timeout=None, **kwargs):
+    def send_chat_action(self, chat_id, action, timeout=None, **kwargs):
         """Use this method when you need to tell the user that something is happening on the bot's
         side. The status is set for 5 seconds or less (when a message arrives from your bot,
         Telegram clients clear its typing status).
@@ -865,7 +865,7 @@ class Bot(TelegramObject):
         return url, data
 
     @log
-    def answerInlineQuery(self,
+    def answer_inline_query(self,
                             inline_query_id,
                             results,
                             cache_time=300,
@@ -930,7 +930,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def getUserProfilePhotos(self, user_id, offset=None, limit=100, timeout=None, **kwargs):
+    def get_user_profile_photos(self, user_id, offset=None, limit=100, timeout=None, **kwargs):
         """Use this method to get a list of profile pictures for a user.
 
         Args:
@@ -966,7 +966,7 @@ class Bot(TelegramObject):
         return UserProfilePhotos.de_json(result, self)
 
     @log
-    def getFile(self, file_id, timeout=None, **kwargs):
+    def get_file(self, file_id, timeout=None, **kwargs):
         """Use this method to get basic info about a file and prepare it for downloading. For the
         moment, bots can download files of up to 20MB in size.
 
@@ -996,7 +996,7 @@ class Bot(TelegramObject):
         return File.de_json(result, self)
 
     @log
-    def kickChatMember(self, chat_id, user_id, timeout=None, **kwargs):
+    def kick_chat_member(self, chat_id, user_id, timeout=None, **kwargs):
         """Use this method to kick a user from a group or a supergroup.
 
         In the case of supergroups, the user will not be able to return to the group on their own
@@ -1028,7 +1028,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def unbanChatMember(self, chat_id, user_id, timeout=None, **kwargs):
+    def unban_chat_member(self, chat_id, user_id, timeout=None, **kwargs):
         """Use this method to unban a previously kicked user in a supergroup.
         The user will not return to the group automatically, but will be able to join via link,
         etc. The bot must be an administrator in the group for this to work.
@@ -1058,7 +1058,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def answerCallbackQuery(self,
+    def answer_callback_query(self,
                               callback_query_id,
                               text=None,
                               show_alert=False,
@@ -1111,7 +1111,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def editMessageText(self,
+    def edit_message_text(self,
                           text,
                           chat_id=None,
                           message_id=None,
@@ -1170,7 +1170,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def editMessageCaption(self,
+    def edit_message_caption(self,
                              chat_id=None,
                              message_id=None,
                              inline_message_id=None,
@@ -1227,7 +1227,7 @@ class Bot(TelegramObject):
 
     @log
     @message
-    def editMessageReplyMarkup(self,
+    def edit_message_reply_markup(self,
                                   chat_id=None,
                                   message_id=None,
                                   inline_message_id=None,
@@ -1280,7 +1280,7 @@ class Bot(TelegramObject):
         return url, data
 
     @log
-    def getUpdates(self,
+    def get_updates(self,
                     offset=None,
                     limit=100,
                     timeout=0,
@@ -1363,7 +1363,7 @@ class Bot(TelegramObject):
         return [Update.de_json(u, self) for u in result]
 
     @log
-    def setWebhook(self,
+    def set_webhook(self,
                     url=None,
                     certificate=None,
                     timeout=None,
@@ -1432,7 +1432,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def deleteWebhook(self, timeout=None, **kwargs):
+    def delete_webhook(self, timeout=None, **kwargs):
         """Use this method to remove webhook integration if you decide to switch back to
         getUpdates. Returns True on success. Requires no parameters.
 
@@ -1457,7 +1457,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def leaveChat(self, chat_id, timeout=None, **kwargs):
+    def leave_chat(self, chat_id, timeout=None, **kwargs):
         """Use this method for your bot to leave a group, supergroup or channel.
 
         Args:
@@ -1484,7 +1484,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def getChat(self, chat_id, timeout=None, **kwargs):
+    def get_chat(self, chat_id, timeout=None, **kwargs):
         """Use this method to get up to date information about the chat (current name of the user
         for one-on-one conversations, current username of a user, group or channel, etc.).
 
@@ -1513,7 +1513,7 @@ class Bot(TelegramObject):
         return Chat.de_json(result, self)
 
     @log
-    def getChatAdministrators(self, chat_id, timeout=None, **kwargs):
+    def get_chat_administrators(self, chat_id, timeout=None, **kwargs):
         """Use this method to get a list of administrators in a chat. On success, returns an Array
         of ChatMember objects that contains information about all chat administrators except other
         bots. If the chat is a group or a supergroup and no administrators were appointed, only the
@@ -1543,7 +1543,7 @@ class Bot(TelegramObject):
         return [ChatMember.de_json(x, self) for x in result]
 
     @log
-    def getChatMembersCount(self, chat_id, timeout=None, **kwargs):
+    def get_chat_members_count(self, chat_id, timeout=None, **kwargs):
         """Use this method to get the number of members in a chat.
 
         Args:
@@ -1570,7 +1570,7 @@ class Bot(TelegramObject):
         return result
 
     @log
-    def getChatMember(self, chat_id, user_id, timeout=None, **kwargs):
+    def get_chat_member(self, chat_id, user_id, timeout=None, **kwargs):
         """Use this method to get information about a member of a chat.
 
         Args:
@@ -1597,7 +1597,7 @@ class Bot(TelegramObject):
 
         return ChatMember.de_json(result, self)
 
-    def getWebhookInfo(self, timeout=None, **kwargs):
+    def get_webhook_info(self, timeout=None, **kwargs):
         """Use this method to get current webhook status.
 
         If the bot is using getUpdates, will return an object with the url field empty.
@@ -1619,7 +1619,7 @@ class Bot(TelegramObject):
 
         return WebhookInfo.de_json(result, self)
 
-    def setGameScore(self,
+    def set_game_score(self,
                        user_id,
                        score,
                        chat_id=None,
@@ -1684,7 +1684,7 @@ class Bot(TelegramObject):
         else:
             return Message.de_json(result, self)
 
-    def getGameHighScores(self,
+    def get_game_high_scores(self,
                              user_id,
                              chat_id=None,
                              message_id=None,
@@ -1736,39 +1736,38 @@ class Bot(TelegramObject):
         return (self.__class__, (self.token, self.base_url.replace(self.token, ''),
                                  self.base_file_url.replace(self.token, '')))
 
-# snake_case (PEP8) aliases
-
-    get_me = getMe
-    send_message = sendMessage
-    forward_message = forwardMessage
-    send_photo = sendPhoto
-    send_audio = sendAudio
-    send_document = sendDocument
-    send_sticker = sendSticker
-    send_video = sendVideo
-    send_voice = sendVoice
-    send_location = sendLocation
-    send_venue = sendVenue
-    send_contact = sendContact
-    send_game = sendGame
-    send_chat_action = sendChatAction
-    answer_inline_query = answerInlineQuery
-    get_user_profile_photos = getUserProfilePhotos
-    get_file = getFile
-    kick_chat_member = kickChatMember
-    unban_chat_member = unbanChatMember
-    answer_callback_query = answerCallbackQuery
-    edit_message_text = editMessageText
-    edit_message_caption = editMessageCaption
-    edit_message_reply_markup = editMessageReplyMarkup
-    get_updates = getUpdates
-    set_webhook = setWebhook
-    delete_webhook = deleteWebhook
-    leave_chat = leaveChat
-    get_chat = getChat
-    get_chat_administrators = getChatAdministrators
-    get_chat_member = getChatMember
-    get_chat_members_count = getChatMembersCount
-    get_webhook_info = getWebhookInfo
-    set_game_score = setGameScore
-    get_game_high_scores = getGameHighScores
+    # camelCase aliases
+    getMe = get_me
+    sendMessage = send_message
+    forwardMessage = forward_message
+    sendPhoto = send_photo
+    sendAudio = send_audio
+    sendDocument = send_document
+    sendSticker = send_sticker
+    sendVideo = send_video
+    sendVoice = send_voice
+    sendLocation = send_location
+    sendVenue = send_venue
+    sendContact = send_contact
+    sendGame = send_game
+    sendChatAction = send_chat_action
+    answerInlineQuery = answer_inline_query
+    getUserProfilePhotos = get_user_profile_photos
+    getFile = get_file
+    kickChatMember = kick_chat_member
+    unbanChatMember = unban_chat_member
+    answerCallbackQuery = answer_callback_query
+    editMessageText = edit_message_text
+    editMessageCaption = edit_message_caption
+    editMessageReplyMarkup = edit_message_reply_markup
+    getUpdates = get_updates
+    setWebhook = set_webhook
+    deleteWebhook = delete_webhook
+    leaveChat = leave_chat
+    getChat = get_chat
+    getChatAdministrators = get_chat_administrators
+    getChatMember = get_chat_member
+    getChatMembersCount = get_chat_members_count
+    getWebhookInfo = get_webhook_info
+    setGameScore = set_game_score
+    getGameHighScores = get_game_high_scores