import textwrap
import subprocess
from errbot import BotPlugin, botcmd
from errbot.version import VERSION
[docs]class Help(BotPlugin):
MSG_HELP_TAIL = 'Type help <command name> to get more info ' \
'about that specific command.'
MSG_HELP_UNDEFINED_COMMAND = 'That command is not defined.'
[docs] def is_git_directory(self, path='.'):
try:
git_call = subprocess.Popen(["git", "tag"], stderr=subprocess.STDOUT, stdout=subprocess.PIPE)
except:
return None
tags, _ = git_call.communicate()
return_code = git_call.returncode
if return_code != 0:
return None
else:
tags = tags.rstrip(b"\n")
return tags.split(b"\n").pop(-1)
# noinspection PyUnusedLocal
[docs] @botcmd(template='about')
def about(self, msg, args):
"""Return information about this Errbot instance and version"""
git_version = self.is_git_directory()
if git_version:
return {'version': "{} GIT CHECKOUT".format(git_version.decode("utf-8"))}
else:
return {'version': VERSION}
# noinspection PyUnusedLocal
[docs] @botcmd
def apropos(self, msg, args):
""" Returns a help string listing available options.
Automatically assigned to the "help" command."""
if not args:
return 'Usage: ' + self._bot.prefix + 'apropos search_term'
description = 'Available commands:\n'
cls_commands = {}
for (name, command) in self._bot.all_commands.items():
cls = self._bot.get_plugin_class_from_method(command)
cls = str.__module__ + '.' + cls.__name__ # makes the fuul qualified name
commands = cls_commands.get(cls, [])
if not self.bot_config.HIDE_RESTRICTED_COMMANDS or self._bot.check_command_access(msg, name)[0]:
commands.append((name, command))
cls_commands[cls] = commands
usage = ''
for cls in sorted(cls_commands):
usage += '\n'.join(sorted([
'\t' + self._bot.prefix + '%s: %s' % (
name.replace('_', ' ', 1),
(command.__doc__ or '(undocumented)').strip().split('\n', 1)[0]
)
for (name, command) in cls_commands[cls]
if args is not None and
command.__doc__ is not None and
args.lower() in command.__doc__.lower() and
name != 'help' and not command._err_command_hidden
]))
usage += '\n\n'
return ''.join(filter(None, [description, usage])).strip()
[docs] @botcmd
def help(self, msg, args):
"""Returns a help string listing available options.
Automatically assigned to the "help" command."""
def may_access_command(m, cmd):
m, _, _ = self._bot._process_command_filters(
msg=m,
cmd=cmd,
args=None,
dry_run=True
)
return m is not None
def get_name(named):
return named.__name__.lower()
# Normalize args to lowercase for ease of use
args = args.lower() if args else ''
usage = ''
description = '### All commands\n'
cls_obj_commands = {}
for (name, command) in self._bot.all_commands.items():
cls = self._bot.get_plugin_class_from_method(command)
obj = command.__self__
_, commands = cls_obj_commands.get(cls, (None, []))
if not self.bot_config.HIDE_RESTRICTED_COMMANDS or may_access_command(msg, name):
commands.append((name, command))
cls_obj_commands[cls] = (obj, commands)
# show all
if not args:
for cls in sorted(cls_obj_commands.keys(), key=lambda c: cls_obj_commands[c][0].name):
obj, commands = cls_obj_commands[cls]
name = obj.name
# shows class and description
usage += '\n**{name}**\n\n*{doc}*\n\n'.format(
name=name,
doc=cls.__errdoc__.strip() or '',
)
for name, command in sorted(commands):
if command._err_command_hidden:
continue
# show individual commands
usage += self._cmd_help_line(name, command)
usage += '\n\n' # end cls section
elif args:
for cls, (obj, cmds) in cls_obj_commands.items():
if obj.name.lower() == args:
break
else:
cls, obj, cmds = None, None, None
if cls is None:
# Plugin not found.
description = ''
all_commands = dict(self._bot.all_commands)
all_commands.update(
{k.replace('_', ' '): v for k, v in all_commands.items()})
if args in all_commands:
usage += self._cmd_help_line(args, all_commands[args], True)
else:
usage += self.MSG_HELP_UNDEFINED_COMMAND
else:
# filter out the commands related to this class
description = '\n**{name}**\n\n*{doc}*\n\n'.format(
name=obj.name,
doc=cls.__errdoc__.strip() or '',
)
pairs = sorted([
(name, command)
for (name, command) in cmds
if not command._err_command_hidden and
(not self.bot_config.HIDE_RESTRICTED_COMMANDS or may_access_command(msg, name))
])
for (name, command) in pairs:
usage += self._cmd_help_line(name, command)
return ''.join(filter(None, [description, usage]))
def _cmd_help_line(self, name, command, show_doc=False):
"""
Returns:
str. a single line indicating the help representation of a command.
"""
cmd_name = name.replace('_', ' ')
cmd_doc = textwrap.dedent(self._bot.get_doc(command)).strip()
prefix = self._bot.prefix
name = cmd_name
patt = getattr(command, '_err_command_re_pattern', None)
if patt:
re_help_name = getattr(command, '_err_command_re_name_help', None)
name = re_help_name if re_help_name else patt.pattern
if not show_doc:
cmd_doc = cmd_doc.split('\n')[0]
if len(cmd_doc) > 80:
cmd_doc = '{doc}...'.format(doc=cmd_doc[:77])
help_str = '- **{prefix}{name}** - {doc}\n'.format(prefix=prefix, name=name, doc=cmd_doc)
return help_str
