我正在使用click(http://click.pocoo.org/3/)创建命令行应用程序,但我不知道如何为此应用程序创建shell。
假设我正在编写一个名为 test 的程序,我的命令叫做 subtest1 和 subtest2
我能够从终端开始工作,如:
$ test subtest1
$ test subtest2
但我想到的是一个shell,所以我可以这样做:
$ test
>> subtest1
>> subtest2
点击可以实现吗?
答案 0 :(得分:14)
点击这不是不可能的,但也没有内置的支持。首先要做的是通过将invoke_without_command=True
传递给组装饰器(如here所述),在没有子命令的情况下调用组回调。那么你的组回调就必须实现一个REPL。 Python在标准库中有cmd框架。使click子命令可用涉及覆盖cmd.Cmd.default
,如下面的代码片段所示。正确地获取所有细节,例如help
,应该可以在几行中完成。
import click
import cmd
class REPL(cmd.Cmd):
def __init__(self, ctx):
cmd.Cmd.__init__(self)
self.ctx = ctx
def default(self, line):
subcommand = cli.commands.get(line)
if subcommand:
self.ctx.invoke(subcommand)
else:
return cmd.Cmd.default(self, line)
@click.group(invoke_without_command=True)
@click.pass_context
def cli(ctx):
if ctx.invoked_subcommand is None:
repl = REPL(ctx)
repl.cmdloop()
@cli.command()
def a():
"""The `a` command prints an 'a'."""
print "a"
@cli.command()
def b():
"""The `b` command prints a 'b'."""
print "b"
if __name__ == "__main__":
cli()
答案 1 :(得分:1)
我试图做类似于OP的事情,但是有额外的选项/嵌套的子子命令。使用内置cmd模块的第一个答案在我的情况下不起作用;也许还有一些摆弄的东西......但我确实遇到了click-shell。没有机会对它进行广泛的测试,但到目前为止,它似乎完全符合预期。
答案 2 :(得分:1)
我知道这已经超级老了,但我一直在研究fpbhb的解决方案以支持选项。我确定这可以使用更多的工作,但这是一个如何完成的基本示例:
import click
import cmd
import sys
from click import BaseCommand, UsageError
class REPL(cmd.Cmd):
def __init__(self, ctx):
cmd.Cmd.__init__(self)
self.ctx = ctx
def default(self, line):
subcommand = line.split()[0]
args = line.split()[1:]
subcommand = cli.commands.get(subcommand)
if subcommand:
try:
subcommand.parse_args(self.ctx, args)
self.ctx.forward(subcommand)
except UsageError as e:
print(e.format_message())
else:
return cmd.Cmd.default(self, line)
@click.group(invoke_without_command=True)
@click.pass_context
def cli(ctx):
if ctx.invoked_subcommand is None:
repl = REPL(ctx)
repl.cmdloop()
@cli.command()
@click.option('--foo', required=True)
def a(foo):
print("a")
print(foo)
return 'banana'
@cli.command()
@click.option('--foo', required=True)
def b(foo):
print("b")
print(foo)
if __name__ == "__main__":
cli()
答案 3 :(得分:1)
现在有一个名为click_repl的库可以为您完成大部分工作。以为我会分享我的努力。
一个难点是您必须使用repl
命令创建特定命令,但我们可以重新调整@ fpbhb的方法以允许默认情况下调用该命令(如果未提供另一个命令)
这是一个完整的示例,支持所有点击选项,包含命令历史记录,以及能够直接调用命令而无需输入REPL:
import click
import click_repl
import os
from prompt_toolkit.history import FileHistory
@click.group(invoke_without_command=True)
@click.pass_context
def cli(ctx):
"""Pleasantries CLI"""
if ctx.invoked_subcommand is None:
ctx.invoke(repl)
@cli.command()
@click.option('--name', default='world')
def hello(name):
"""Say hello"""
click.echo('Hello, {}!'.format(name))
@cli.command()
@click.option('--name', default='moon')
def goodnight(name):
"""Say goodnight"""
click.echo('Goodnight, {}.'.format(name))
@cli.command()
def repl():
"""Start an interactive session"""
prompt_kwargs = {
'history': FileHistory(os.path.expanduser('~/.repl_history'))
}
click_repl.repl(click.get_current_context(), prompt_kwargs=prompt_kwargs)
if __name__ == '__main__':
cli(obj={})
这里是使用REPL的样子:
$ python pleasantries.py
> hello
Hello, world!
> goodnight --name fpbhb
Goodnight, fpbhb.
直接使用命令行子命令:
$ python pleasntries.py goodnight
Goodnight, moon.