使用Python cmd模块的命令的别名

Question

如何在使用cmd模块实现的面向行的命令解释器中为命令创建别名？

要创建命令，我必须实现do_cmd方法。 但我有长名称（如constraint ）的命令，我想为这些命令（如co ）提供别名（实际上是快捷方式）。 我怎样才能做到这一点？

我想到的一种可能性是实现do_alias （如do_co ）方法，并在此方法中调用do_cmd （ do_constraint ）。 但是这在CLI的帮助下给我带来了新的命令。

有没有其他方法来实现这一目标？ 或者可能有办法隐藏help输出中的命令？

Answer 1

您可以覆盖default方法并搜索合适的命令处理程序（如Brian已经建议的那样）：

import cmd

class WithAliasCmd(cmd.Cmd):

    def default(self, line):
        cmd, arg, line = self.parseline(line)
        func = [getattr(self, n) for n in self.get_names() if n.startswith('do_' + cmd)]
        if func: # maybe check if exactly one or more elements, and tell the user
            func[0](arg)

Answer 2

以下解决方案使别名命令共享一条帮助消息。 它允许您将所有别名保存在一个易于编辑的位置，同时使文档更容易。 它检查针对一个别名的用户输入字典，函数值以及两个覆盖所述default() 参见懒惰 ＆ 布赖恩 ）和do_help()方法。

在这里，我使别名'c'和'con'执行do_constraint() ， 'q'调用do_quit() ， 'h'调用do_help() 。 这个解决方案的好处是'h q'和'help quit'打印相同的消息。 可以在单个docstring中维护多个别名命令的文档。

import cmd

class prompt(cmd.Cmd):

    def __init__(self):
        cmd.Cmd.__init__(self)
        self.aliases = { 'c'   : self.do_constraint ,
                         'con' : self.do_constraint ,
                         'q'   : self.do_quit       ,
                         'h'   : self.do_help       }

    def do_constraint(self, arg):
        '''Constrain things.'''
        print('Constraint complete.')

    def do_quit(self, arg):
        '''Exit the program.'''
        return True

    def do_help(self, arg):
        '''List available commands.'''
        if arg in self.aliases:
            arg = self.aliases[arg].__name__[3:]
        cmd.Cmd.do_help(self, arg)

    def default(self, line):
        cmd, arg, line = self.parseline(line)
        if cmd in self.aliases:
            self.aliases[cmd](arg)
        else:
            print("*** Unknown syntax: %s" % line)

Answer 3

文档提到了一个默认方法，您可以覆盖该方法来处理任何未知命令。 将其编码为前缀扫描命令列表并按照您对do_alias的建议调用它们。