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

zulip_bot_output.py: Make --path-to-bot argument positional.

Browse source 
This allows a user to exclusively enter a bot's name or a bot's
directory as the first and only positional argument. Therefore,
no complicated checks for multiple bot specifications are required
anymore.
Additionally, this cleans help messages and makes arguments more
accessible.
This commit is contained in:
derAnfaenger 2017-09-01 13:01:58 +02:00 committed by Tim Abbott
parent 3a89b9f966
commit 438dbac12a
1 changed files with 22 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
zulip_bots/zulip_bots/zulip_bot_output.py
View file

@ -13,7 +13,9 @@ from mock import MagicMock, patch
from zulip_bots.lib import StateHandler from zulip_bots.lib import StateHandler
from zulip_bots.lib import ExternalBotHandler from zulip_bots.lib import ExternalBotHandler
from zulip_bots.provision import provision_bot from zulip_bots.provision import provision_bot
from zulip_bots.run import import_module_from_source, name_and_path_match from zulip_bots.run import import_module_from_source
current_dir = os.path.dirname(os.path.abspath(__file__))
def parse_args(): def parse_args():
usage = ''' usage = '''
@ -27,65 +29,38 @@ def parse_args():
''' '''
parser = argparse.ArgumentParser(usage=usage) parser = argparse.ArgumentParser(usage=usage)
parser.add_argument('name', parser.add_argument('bot',
action='store', action='store',
nargs='?', help='the name or path an existing bot to run')
default=None,
help='the name of an existing bot to run') parser.add_argument('--message', '-m',
parser.add_argument('--message',
action='store', action='store',
help='the message content to send to the bot') help='the message content to send to the bot')
parser.add_argument('--path-to-bot', parser.add_argument('--force', '-f',
action='store',
help='path to the file with the bot handler class')
parser.add_argument('--force',
action='store_true', action='store_true',
help='Try running the bot even if dependencies install fails.') help='try running bot even if dependencies install fails')
parser.add_argument('--provision', parser.add_argument('--provision', '-p',
action='store_true', action='store_true',
help='Install dependencies for the bot.') help='install dependencies for the bot')
args = parser.parse_args() args = parser.parse_args()
if not args.name and not args.path_to_bot:
error_message = """
You must either specify the name of an existing bot or
specify a path to the file (--path-to-bot) that contains
the bot handler class.
"""
parser.error(error_message)
# Checks if both name and path to bots are provided:
# checks if both of these are in sync, otherwise we'll
# have to be bias towards one and the user may get incorrect
# result.
elif not name_and_path_match(args.name, args.path_to_bot):
error_message = """
Please make sure that the given name of the bot and the
given path to the bot are same and valid.
"""
parser.error(error_message)
return args return args
def main(): def main():
# type: () -> None # type: () -> None
args = parse_args() args = parse_args()
bot_name = args.name if os.path.isfile(args.bot):
if args.path_to_bot: bot_path = os.path.abspath(args.bot)
bot_name = os.path.splitext(os.path.basename(bot_path))[0]
else:
bot_path = os.path.abspath(os.path.join(current_dir, 'bots', args.bot, args.bot+'.py'))
bot_name = args.bot
bot_dir = os.path.dirname(bot_path)
if args.provision: if args.provision:
bot_dir = os.path.dirname(os.path.abspath(args.path_to_bot)) provision_bot(os.path.dirname(bot_path), args.force)
provision_bot(bot_dir, args.force) lib_module = import_module_from_source(bot_path, bot_name)
lib_module = import_module_from_source(args.path_to_bot, name=bot_name)
elif args.name:
if args.provision:
current_dir = os.path.dirname(os.path.abspath(__file__))
bots_parent_dir = os.path.join(current_dir, "bots")
bot_dir = os.path.join(bots_parent_dir, args.name)
provision_bot(bot_dir, args.force)
lib_module = import_module('zulip_bots.bots.{bot}.{bot}'.format(bot=bot_name))
message = {'content': args.message, 'sender_email': 'foo_sender@zulip.com'} message = {'content': args.message, 'sender_email': 'foo_sender@zulip.com'}
message_handler = lib_module.handler_class() message_handler = lib_module.handler_class()
@ -117,7 +92,7 @@ def main():
bot_handler=mock_bot_handler, bot_handler=mock_bot_handler,
state_handler=StateHandler() state_handler=StateHandler()
) )
print("On sending ", args.name, " bot the following message:\n\"", args.message, "\"") print("On sending ", bot_name, " bot the following message:\n\"", args.message, "\"")
# send_reply and send_message have slightly arguments; the # send_reply and send_message have slightly arguments; the
# following takes that into account. # following takes that into account.