Как установить опцию по умолчанию как -h для клика Python? - PullRequest
Новая
       30

Как установить опцию по умолчанию как -h для клика Python?

0 голосов
/ 21 мая 2018

Как установить параметр по умолчанию как -h для щелчка Python?

По умолчанию мой сценарий ничего не показывает, если для duh.py: 

import click


CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])

@click.command(context_settings=CONTEXT_SETTINGS)
@click.option('--toduhornot', is_flag=True, help='prints "duh..."')
def duh(toduhornot):
    if toduhornot:
        click.echo('duh...')

if __name__ == '__main__':
    duh()

не задано никаких аргументов[out]: 

$ python3 test_click.py -h
Usage: test_click.py [OPTIONS]

Options:
  --toduhornot  prints "duh..."
  -h, --help    Show this message and exit.



$ python3 test_click.py --toduhornot
duh...


$ python3 test_click.py

Вопрос:

Как показано выше, по умолчанию не печатается информация python3 test_click.py.

Существует ли такой способ, как вариант по умолчаниюустанавливается на -h, если аргументы не заданы, например 

$ python3 test_click.py 
Usage: test_click.py [OPTIONS]

Options:
  --toduhornot  prints "duh..."
  -h, --help    Show this message and exit.

Ответы [ 2 ]

0 голосов
/ 23 мая 2018

Если вы наследуете от 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)

Как это работает?

Это работает, потому что нажмитеявляется хорошо разработанной структурой OO.Декоратор @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.
0 голосов
/ 21 мая 2018

Ваша структура не рекомендуется, вы должны использовать: 

import click


CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])


@click.group(context_settings=CONTEXT_SETTINGS)
def cli():
    pass


@cli.command(help='prints "duh..."')
def duh():
    click.echo('duh...')

if __name__ == '__main__':
    cli()

И тогда python test_click.py напечатает сообщение справки: 

Usage: test_click.py [OPTIONS] COMMAND [ARGS]...

Options:
  -h, --help  Show this message and exit.

Commands:
  duh  prints "duh..."

Таким образом, вы можете использовать python test_click.py duhдля вызова duh.

Обновление 

import click


CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])

@click.command(context_settings=CONTEXT_SETTINGS)
@click.option('--toduhornot', is_flag=True, help='prints "duh..."')
def duh(toduhornot):
    if toduhornot:
        click.echo('duh...')
    else:
        with click.Context(duh) as ctx:
            click.echo(ctx.get_help())

if __name__ == '__main__':
    duh()
...