async def cmd_help(msg: Message, *args):
if not args:
raise InvalidArgumentsError(reason='missing required argument', cmd=cmd_help)
cmd = get_command(args[0])
if not cmd:
raise InvalidArgumentsError(reason=f'command not found', cmd=cmd_help)
await msg.reply(msg=f'help for {cmd.fullname} - syntax: {cmd.syntax} - help: {cmd.help}')
async def cmd_find_perm(msg: Message, *args):
if not args:
raise InvalidArgumentsError(reason='missing required command parameter', cmd=cmd_find_perm)
cmd = get_command(args[0])
if not cmd:
await msg.reply(f'no command was found by "{args[0]}"')
return
if not cmd.permission:
await msg.reply(f'command "{cmd.fullname}" does not have require permission to use it')
return
await msg.reply(f'the permission for "{cmd.fullname}" is "{cmd.permission}"')
async def cmd_enable_cmd(msg: Message, *args):
if not args:
raise InvalidArgumentsException()
name = args[0].lower()
if not get_command(name):
return await msg.reply(
f'no command found for "{name}", are you missing the prefix?')
if not is_command_disabled(msg.channel_name, name):
return await msg.reply(f'{name} is not disabled')
enable_command(msg.channel_name, name)
await msg.reply(f'enabled command "{name}"')
async def run_command(name: str,
msg: 'Message',
args: List[str] = None,
blocking: bool = True,
msg_class: Type['Message'] = None):
"""
runs a command from another command, can be used for chaining command pragmatically,
the base message passed to this function MUST be a WHISPER or PRIVMSG for this to work
example (called from another command)
>>> # `msg` is from the first command triggered from the actual chat from the channel
>>> # ['17'] is the arguments passed to this newly command, can be empty
>>> await run_command('roll', msg, ['17'])
:param name: the name of the command to call, if the name is not found, it tries it with the prefix added
:param msg: the message instance of first command called, needed to retain state, and keep natural flow
:param args: the arguments to pass to the newly called command
:param blocking: if True, the caller will wait for newly called command to be done before continuing,
else, run it as another task and continue
"""
from twitchbot import Message, get_command, get_custom_command, Command, CustomCommand, CustomCommandAction
cmd: Command = get_command(name) or get_custom_command(
msg.channel_name, name)
if not cmd:
raise ValueError(
f'[run_command] could not find command or custom command by the name of "{name}"'
)
if isinstance(cmd, CustomCommand):
cmd = CustomCommandAction(cmd)
args = [f'"{arg}"' if ' ' in arg else arg for arg in (args or [])]
raw = msg.raw_msg
# get the original info line from the twitch message, then append our new arguments to it to be parsed
# the consecutive raw.index(':') is used to skip the first two ':' in the original message
# we want to preserve all metadata/info prior to the last : before the actual message contents
text = raw[:raw.index(':', raw.index(':') + 1) + 1]
# create a new message from the formatted new raw text, this is needed to ensure everything flows as intended
# here the base message data is used, then we replace the context with our own command and arguments
new_msg = (Message if msg_class is None else msg_class)(
f"{text}{cmd.fullname} {' '.join(args)}", irc=msg.irc, bot=msg.bot)
if blocking:
await cmd.execute(new_msg)
else:
get_event_loop().create_task(cmd.execute(new_msg))