Когда я помещаю недопустимые аргументы в команду, отображается только это:
Usage: ugen.py [OPTIONS]
Error: Missing option "-o" / "--out_file".
Я хотел бы отобразить все справочное сообщение, как с помощью опции --help
Моя украшенная функция:
@click.command(name="ugen")
@click.help_option("-h", "--help")
@click.option(
"-o", "--out_file",
help="Output file where data is written.",
required=True
)
@click.option(
"-i", "--in_file", multiple=True,
help=(
"Input file/s from which data is read. "
"Can be provided multiple times. "
"Although always with specifier -i/--in_file."
),
required=True
)
def main(out_file, in_file):
code here
Вы можете подключить командный вызов, а затем отобразить справку по желанию, например:
import click
class ShowUsageOnMissingError(click.Command):
def __call__(self, *args, **kwargs):
try:
return super(ShowUsageOnMissingError, self).__call__(
*args, standalone_mode=False, **kwargs)
except click.MissingParameter as exc:
exc.ctx = None
exc.show(file=sys.stdout)
click.echo()
try:
super(ShowUsageOnMissingError, self).__call__(['--help'])
except SystemExit:
sys.exit(exc.exit_code)
Чтобы использовать пользовательский класс, просто передайте класс click.command()
например:
@click.command(cls=ShowUsageOnMissingError)
@click.option("-o", help="Output file where data is written.", required=True)
def cli(o):
...
Это работает, потому что клик - это хорошо разработанная OO-структура. @click.command()
обычно создает экземпляр объекта click.Command
но позволяет этому поведению click.Command
параметр cls
. Так что относительно легко наследовать от click.Command
в нашем собственном классе и над click.Command
желаемые методы.
В этом случае мы переопределяем __call__()
и печатаем справку после печати исключения.
@click.command(cls=ShowUsageOnMissingError)
@click.option("-o", help="Output file where data is written.", required=True)
def cli(o):
click.echo(o)
if __name__ == "__main__":
commands = (
'-o outfile',
'',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for cmd in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + cmd)
time.sleep(0.1)
cli(cmd.split(), obj={})
except BaseException as exc:
if str(exc) != '0' and \
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Click Version: 6.7
Python Version: 3.6.2 (default, Jul 17 2017, 23:14:31)
[GCC 5.4.0 20160609]
-----------
> -o outfile
outfile
-----------
>
Error: Missing option "-o".
Usage: test.py [OPTIONS]
Options:
-o TEXT Output file where data is written. [required]
--help Show this message and exit.
-----------
> --help
Usage: test.py [OPTIONS]
Options:
-o TEXT Output file where data is written. [required]
--help Show this message and exit.