xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

zulip_bots: Add docstrings and comments for TerminalBotHandler.

Browse source
This commit is contained in:
PIG208 2021-05-25 19:55:09 +08:00 committed by Tim Abbott
parent d949f2024f
commit 37e2596124
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
zulip_bots/zulip_bots/simple_lib.py
View file

@ -53,12 +53,18 @@ class TerminalBotHandler:
return BotIdentity("bot name", "bot-email@domain") return BotIdentity("bot name", "bot-email@domain")
def react(self, message, emoji_name): def react(self, message, emoji_name):
"""
Mock adding an emoji reaction and print it in the terminal.
"""
print("""The bot reacts to message #{}: {}""".format(message["id"], emoji_name)) print("""The bot reacts to message #{}: {}""".format(message["id"], emoji_name))
return self.message_server.add_reaction(dict(message_id=message['id'], return self.message_server.add_reaction(dict(message_id=message['id'],
emoji_name=emoji_name, emoji_name=emoji_name,
reaction_type='unicode_emoji')) reaction_type='unicode_emoji'))
def send_message(self, message): def send_message(self, message):
"""
Print the message sent in the terminal and store it in a mock message server.
"""
if message['type'] == 'stream': if message['type'] == 'stream':
print(''' print('''
stream: {} topic: {} stream: {} topic: {}
@ -69,9 +75,14 @@ class TerminalBotHandler:
PM response: PM response:
{} {}
'''.format(message['content'])) '''.format(message['content']))
# Note that message_server is only responsible for storing and assigning an
# id to the message instead of actually displaying it.
return self.message_server.send(message) return self.message_server.send(message)
def send_reply(self, message, response): def send_reply(self, message, response):
"""
Print the reply message in the terminal and store it in a mock message server.
"""
print("\nReply from the bot is printed between the dotted lines:\n-------\n{}\n-------".format(response)) print("\nReply from the bot is printed between the dotted lines:\n-------\n{}\n-------".format(response))
response_message = dict( response_message = dict(
content=response content=response
@ -79,6 +90,10 @@ class TerminalBotHandler:
return self.message_server.send(response_message) return self.message_server.send(response_message)
def update_message(self, message): def update_message(self, message):
"""
Update a previously sent message and print the result in the terminal.
Throw an IndexError if the message id is invalid.
"""
self.message_server.update(message) self.message_server.update(message)
print(''' print('''
update to message #{}: update to message #{}: