bots: Clarify message handling for
@@ -78,7 +78,11 @@ def run_message_handler_for_bot(lib_module, quiet, config_file):
if not quiet:
print(message_handler.usage())
- def extract_message(message, client):
+ def extract_query_without_mention(message, client):
+ """
+ If the bot is the first @mention in the message, then this function returns
+ the message with the bot's @mention removed. Otherwise, it returns None.
+ """
bot_mention = r'^@(\*\*{0}\*\*)'.format(client.full_name)
start_with_mention = re.compile(bot_mention).match(message['content'])
if start_with_mention is None:
@@ -96,12 +100,16 @@ def run_message_handler_for_bot(lib_module, quiet, config_file):
def handle_message(message):
logging.info('waiting for next message')
+ # is_mentioned is true if the bot is mentioned at ANY position (not necessarily
+ # the first @mention in the message).
is_mentioned = message['is_mentioned']
is_private_message = is_private(message, restricted_client)
# Strip at-mention botname from the message
if is_mentioned:
- message['content'] = extract_message(message=message, client=restricted_client)
+ # message['content'] will be None when the bot's @-mention is not at the beginning.
+ # In that case, the message shall not be handled.
+ message['content'] = extract_query_without_mention(message=message, client=restricted_client)
if message['content'] is None:
return
