Use snake_case method names

Renamed:
- Message.formatMentions
- _util.digitToChar
- _util.generateMessageID
- _util.getSignatureID
- _util.generateOfflineThreadingID
- Client._markAlive

Renamed following Client methods:
- isLoggedIn
- getSession
- setSession
- _forcedFetch
- fetchThreads
- fetchAllUsersFromThreads
- fetchAllUsers
- searchForUsers
- searchForPages
- searchForGroups
- searchForThreads
- searchForMessageIDs
- searchForMessages
- _fetchInfo
- fetchUserInfo
- fetchPageInfo
- fetchGroupInfo
- fetchThreadInfo
- fetchThreadMessages
- fetchThreadList
- fetchUnread
- fetchUnseen
- fetchImageUrl
- fetchMessageInfo
- fetchPollOptions
- fetchPlanInfo
- _getPrivateData
- getPhoneNumbers
- getEmails
- getUserActiveStatus
- fetchThreadImages
- _oldMessage
- _doSendRequest
- quickReply
- _sendLocation
- sendLocation
- sendPinnedLocation
- _sendFiles
- sendRemoteFiles
- sendLocalFiles
- sendRemoteVoiceClips
- sendLocalVoiceClips
- forwardAttachment
- createGroup
- addUsersToGroup
- removeUserFromGroup
- _adminStatus
- addGroupAdmins
- removeGroupAdmins
- changeGroupApprovalMode
- _usersApproval
- acceptUsersToGroup
- denyUsersFromGroup
- _changeGroupImage
- changeGroupImageRemote
- changeGroupImageLocal
- changeThreadTitle
- changeNickname
- changeThreadColor
- changeThreadEmoji
- reactToMessage
- createPlan
- editPlan
- deletePlan
- changePlanParticipation
- createPoll
- updatePollVote
- setTypingStatus
- markAsDelivered
- _readStatus
- markAsRead
- markAsUnread
- markAsSeen
- friendConnect
- removeFriend
- blockUser
- unblockUser
- moveThreads
- deleteThreads
- markAsSpam
- deleteMessages
- muteThread
- unmuteThread
- muteThreadReactions
- unmuteThreadReactions
- muteThreadMentions
- unmuteThreadMentions
- _pullMessage
- _parseMessage
- _doOneListen
- setActiveStatus
- onLoggingIn
- on2FACode
- onLoggedIn
- onListening
- onListenError
- onMessage
- onColorChange
- onEmojiChange
- onTitleChange
- onImageChange
- onNicknameChange
- onAdminAdded
- onAdminRemoved
- onApprovalModeChange
- onMessageSeen
- onMessageDelivered
- onMarkedSeen
- onMessageUnsent
- onPeopleAdded
- onPersonRemoved
- onFriendRequest
- onInbox
- onTyping
- onGamePlayed
- onReactionAdded
- onReactionRemoved
- onBlock
- onUnblock
- onLiveLocation
- onCallStarted
- onCallEnded
- onUserJoinedCall
- onPollCreated
- onPollVoted
- onPlanCreated
- onPlanEnded
- onPlanEdited
- onPlanDeleted
- onPlanParticipation
- onQprimer
- onChatTimestamp
- onBuddylistOverlay
- onUnknownMesssageType
- onMessageError

examples/echobot.py

@@ -2,9 +2,9 @@ from fbchat import Client
 
 # Subclass fbchat.Client and override required methods
 class EchoBot(Client):
-    def onMessage(self, author_id, message_object, thread_id, thread_type, **kwargs):
-        self.markAsDelivered(thread_id, message_object.uid)
-        self.markAsRead(thread_id)
+    def on_message(self, author_id, message_object, thread_id, thread_type, **kwargs):
+        self.mark_as_delivered(thread_id, message_object.uid)
+        self.mark_as_read(thread_id)
 
         print("{} from {} in {}".format(message_object, thread_id, thread_type.name))
 

examples/fetch.py

@@ -5,24 +5,24 @@ from fbchat.models import *
 client = Client("<email>", "<password>")
 
 # Fetches a list of all users you're currently chatting with, as `User` objects
-users = client.fetchAllUsers()
+users = client.fetch_all_users()
 
 print("users' IDs: {}".format([user.uid for user in users]))
 print("users' names: {}".format([user.name for user in users]))
 
 
-# If we have a user id, we can use `fetchUserInfo` to fetch a `User` object
-user = client.fetchUserInfo("<user id>")["<user id>"]
+# If we have a user id, we can use `fetch_user_info` to fetch a `User` object
+user = client.fetch_user_info("<user id>")["<user id>"]
 # We can also query both mutiple users together, which returns list of `User` objects
-users = client.fetchUserInfo("<1st user id>", "<2nd user id>", "<3rd user id>")
+users = client.fetch_user_info("<1st user id>", "<2nd user id>", "<3rd user id>")
 
 print("user's name: {}".format(user.name))
 print("users' names: {}".format([users[k].name for k in users]))
 
 
-# `searchForUsers` searches for the user and gives us a list of the results,
+# `search_for_users` searches for the user and gives us a list of the results,
 # and then we just take the first one, aka. the most likely one:
-user = client.searchForUsers("<name of user>")[0]
+user = client.search_for_users("<name of user>")[0]
 
 print("user ID: {}".format(user.uid))
 print("user's name: {}".format(user.name))
@@ -31,15 +31,15 @@ print("Is user client's friend: {}".format(user.is_friend))
 
 
 # Fetches a list of the 20 top threads you're currently chatting with
-threads = client.fetchThreadList()
+threads = client.fetch_thread_list()
 # Fetches the next 10 threads
-threads += client.fetchThreadList(offset=20, limit=10)
+threads += client.fetch_thread_list(offset=20, limit=10)
 
 print("Threads: {}".format(threads))
 
 
 # Gets the last 10 messages sent to the thread
-messages = client.fetchThreadMessages(thread_id="<thread id>", limit=10)
+messages = client.fetch_thread_messages(thread_id="<thread id>", limit=10)
 # Since the message come in reversed order, reverse them
 messages.reverse()
 
@@ -48,14 +48,14 @@ for message in messages:
     print(message.text)
 
 
-# If we have a thread id, we can use `fetchThreadInfo` to fetch a `Thread` object
-thread = client.fetchThreadInfo("<thread id>")["<thread id>"]
+# If we have a thread id, we can use `fetch_thread_info` to fetch a `Thread` object
+thread = client.fetch_thread_info("<thread id>")["<thread id>"]
 print("thread's name: {}".format(thread.name))
 print("thread's type: {}".format(thread.type))
 
 
-# `searchForThreads` searches works like `searchForUsers`, but gives us a list of threads instead
-thread = client.searchForThreads("<name of thread>")[0]
+# `search_for_threads` searches works like `search_for_users`, but gives us a list of threads instead
+thread = client.search_for_threads("<name of thread>")[0]
 print("thread's name: {}".format(thread.name))
 print("thread's type: {}".format(thread.type))
 
@@ -64,6 +64,6 @@ print("thread's type: {}".format(thread.type))
 
 
 # Print image url for 20 last images from thread.
-images = client.fetchThreadImages("<thread id>")
+images = client.fetch_thread_images("<thread id>")
 for image in islice(image, 20):
     print(image.large_preview_url)

examples/interract.py

@@ -38,7 +38,7 @@ client.send(
 )
 
 # Will send the image located at `<image path>`
-client.sendLocalImage(
+client.send_local_image(
     "<image path>",
     message=Message(text="This is a local image"),
     thread_id=thread_id,
@@ -46,7 +46,7 @@ client.sendLocalImage(
 )
 
 # Will download the image at the URL `<image url>`, and then send it
-client.sendRemoteImage(
+client.send_remote_image(
     "<image url>",
     message=Message(text="This is a remote image"),
     thread_id=thread_id,
@@ -57,35 +57,35 @@ client.sendRemoteImage(
 # Only do these actions if the thread is a group
 if thread_type == ThreadType.GROUP:
     # Will remove the user with ID `<user id>` from the thread
-    client.removeUserFromGroup("<user id>", thread_id=thread_id)
+    client.remove_user_from_group("<user id>", thread_id=thread_id)
 
     # Will add the user with ID `<user id>` to the thread
-    client.addUsersToGroup("<user id>", thread_id=thread_id)
+    client.add_users_to_group("<user id>", thread_id=thread_id)
 
     # Will add the users with IDs `<1st user id>`, `<2nd user id>` and `<3th user id>` to the thread
-    client.addUsersToGroup(
+    client.add_users_to_group(
         ["<1st user id>", "<2nd user id>", "<3rd user id>"], thread_id=thread_id
     )
 
 
 # Will change the nickname of the user `<user_id>` to `<new nickname>`
-client.changeNickname(
+client.change_nickname(
     "<new nickname>", "<user id>", thread_id=thread_id, thread_type=thread_type
 )
 
 # Will change the title of the thread to `<title>`
-client.changeThreadTitle("<title>", thread_id=thread_id, thread_type=thread_type)
+client.change_thread_title("<title>", thread_id=thread_id, thread_type=thread_type)
 
 # Will set the typing status of the thread to `TYPING`
-client.setTypingStatus(
+client.set_typing_status(
     TypingStatus.TYPING, thread_id=thread_id, thread_type=thread_type
 )
 
 # Will change the thread color to `MESSENGER_BLUE`
-client.changeThreadColor(ThreadColor.MESSENGER_BLUE, thread_id=thread_id)
+client.change_thread_color(ThreadColor.MESSENGER_BLUE, thread_id=thread_id)
 
 # Will change the thread emoji to `👍`
-client.changeThreadEmoji("👍", thread_id=thread_id)
+client.change_thread_emoji("👍", thread_id=thread_id)
 
 # Will react to a message with a 😍 emoji
-client.reactToMessage("<message id>", MessageReaction.LOVE)
+client.react_to_message("<message id>", MessageReaction.LOVE)

examples/keepbot.py

@@ -17,27 +17,27 @@ old_nicknames = {
 
 
 class KeepBot(Client):
-    def onColorChange(self, author_id, new_color, thread_id, thread_type, **kwargs):
+    def on_color_change(self, author_id, new_color, thread_id, thread_type, **kwargs):
         if old_thread_id == thread_id and old_color != new_color:
             print(
                 "{} changed the thread color. It will be changed back".format(author_id)
             )
-            self.changeThreadColor(old_color, thread_id=thread_id)
+            self.change_thread_color(old_color, thread_id=thread_id)
 
-    def onEmojiChange(self, author_id, new_emoji, thread_id, thread_type, **kwargs):
+    def on_emoji_change(self, author_id, new_emoji, thread_id, thread_type, **kwargs):
         if old_thread_id == thread_id and new_emoji != old_emoji:
             print(
                 "{} changed the thread emoji. It will be changed back".format(author_id)
             )
-            self.changeThreadEmoji(old_emoji, thread_id=thread_id)
+            self.change_thread_emoji(old_emoji, thread_id=thread_id)
 
-    def onPeopleAdded(self, added_ids, author_id, thread_id, **kwargs):
+    def on_people_added(self, added_ids, author_id, thread_id, **kwargs):
         if old_thread_id == thread_id and author_id != self.uid:
             print("{} got added. They will be removed".format(added_ids))
             for added_id in added_ids:
-                self.removeUserFromGroup(added_id, thread_id=thread_id)
+                self.remove_user_from_group(added_id, thread_id=thread_id)
 
-    def onPersonRemoved(self, removed_id, author_id, thread_id, **kwargs):
+    def on_person_removed(self, removed_id, author_id, thread_id, **kwargs):
         # No point in trying to add ourself
         if (
             old_thread_id == thread_id
@@ -45,18 +45,18 @@ class KeepBot(Client):
             and author_id != self.uid
         ):
             print("{} got removed. They will be re-added".format(removed_id))
-            self.addUsersToGroup(removed_id, thread_id=thread_id)
+            self.add_users_to_group(removed_id, thread_id=thread_id)
 
-    def onTitleChange(self, author_id, new_title, thread_id, thread_type, **kwargs):
+    def on_title_change(self, author_id, new_title, thread_id, thread_type, **kwargs):
         if old_thread_id == thread_id and old_title != new_title:
             print(
                 "{} changed the thread title. It will be changed back".format(author_id)
             )
-            self.changeThreadTitle(
+            self.change_thread_title(
                 old_title, thread_id=thread_id, thread_type=thread_type
             )
 
-    def onNicknameChange(
+    def on_nickname_change(
         self, author_id, changed_for, new_nickname, thread_id, thread_type, **kwargs
     ):
         if (
@@ -69,7 +69,7 @@ class KeepBot(Client):
                     author_id, changed_for
                 )
             )
-            self.changeNickname(
+            self.change_nickname(
                 old_nicknames[changed_for],
                 changed_for,
                 thread_id=thread_id,

examples/removebot.py

@@ -3,14 +3,14 @@ from fbchat.models import *
 
 
 class RemoveBot(Client):
-    def onMessage(self, author_id, message_object, thread_id, thread_type, **kwargs):
+    def on_message(self, author_id, message_object, thread_id, thread_type, **kwargs):
         # We can only kick people from group chats, so no need to try if it's a user chat
         if message_object.text == "Remove me!" and thread_type == ThreadType.GROUP:
             print("{} will be removed from {}".format(author_id, thread_id))
-            self.removeUserFromGroup(author_id, thread_id=thread_id)
+            self.remove_user_from_group(author_id, thread_id=thread_id)
         else:
-            # Sends the data to the inherited onMessage, so that we can still see when a message is recieved
-            super(RemoveBot, self).onMessage(
+            # Sends the data to the inherited on_message, so that we can still see when a message is recieved
+            super(RemoveBot, self).on_message(
                 author_id=author_id,
                 message_object=message_object,
                 thread_id=thread_id,