Если вы наследуете от click.Command
и переопределяете метод parse_args()
, вы можете создать собственный класс по умолчанию, чтобы помочь, например:
Пользовательский класс
import click
class DefaultHelp(click.Command):
def __init__(self, *args, **kwargs):
context_settings = kwargs.setdefault('context_settings', {})
if 'help_option_names' not in context_settings:
context_settings['help_option_names'] = ['-h', '--help']
self.help_flag = context_settings['help_option_names'][0]
super(DefaultHelp, self).__init__(*args, **kwargs)
def parse_args(self, ctx, args):
if not args:
args = [self.help_flag]
return super(DefaultHelp, self).parse_args(ctx, args)
Использование пользовательского класса:
Чтобы использовать пользовательский класс, передайте параметр cls
декоратору @click.command()
, например:
@click.command(cls=DefaultHelp)
Как это работает?
Это работает, потому что click — это хорошо спроектированная объектно-ориентированная среда. Декоратор @click.command()
обычно создает экземпляр объекта click.Command
, но позволяет переопределить это поведение с помощью параметра cls
. Таким образом, относительно легко наследоваться от click.Command
в нашем собственном классе и переопределять нужные методы.
В этом случае мы переопределяем click.Command.parse_args()
и проверяем наличие пустого списка аргументов. Если он пуст, то мы вызываем справку. Кроме того, этот класс по умолчанию будет использовать справку ['-h', '--help']
, если не указано иное.
Тестовый код:
@click.command(cls=DefaultHelp)
@click.option('--toduhornot', is_flag=True, help='prints "duh..."')
def duh(toduhornot):
if toduhornot:
click.echo('duh...')
if __name__ == "__main__":
commands = (
'--toduhornot',
'',
'--help',
'-h',
)
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)
duh(cmd.split())
except BaseException as exc:
if str(exc) != '0' and \
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Полученные результаты:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
> --toduhornot
duh...
-----------
>
Usage: test.py [OPTIONS]
Options:
--toduhornot prints "duh..."
-h, --help Show this message and exit.
-----------
> --help
Usage: test.py [OPTIONS]
Options:
--toduhornot prints "duh..."
-h, --help Show this message and exit.
-----------
> -h
Usage: test.py [OPTIONS]
Options:
--toduhornot prints "duh..."
-h, --help Show this message and exit.
person
Stephen Rauch
schedule
23.05.2018