Как библиотека Python Click обрабатывает параметры, которые являются флагами и True по умолчанию?

Question

Я только что наткнулся на кусок кода, который определяет опцию щелчка как таковую:

@click.option(
    "-s",
    "--status",
    default=True,
    is_flag=True,
    help="Show status",
)

Означает ли это, что статус True, если только -s поставляется, в этом случае он станет False?

Answer 1

Для опций, которые имеют флаг и по умолчанию Trueуказав параметр в командной строке, установите для этого параметра значение False; пока не укажет даст по умолчанию True,

Тестовый код:

import click    

@click.command()
@click.option(
    "-s",
    "--status",
    default=True,
    is_flag=True,
    help="Show status",
)
def main(status):
    click.echo('status: {}'.format(status))


if __name__ == "__main__":
    commands = (
        '',
        '-s',
        '--status',
        '--help',
    )

    import sys, time

    time.sleep(1)
    print('Click Version: {}'.format(click.__version__))
    print('Python Version: {}'.format(sys.version))
    for command in commands:
        try:
            time.sleep(0.1)
            print('-----------')
            print('> ' + command)
            time.sleep(0.1)
            main(command.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)]
-----------
> 
status: True
-----------
> -s
status: False
-----------
> --status
status: False
-----------
> --help
Usage: test.py [OPTIONS]

Options:
  -s, --status  Show status
  --help        Show this message and exit.

Answer 2

Хотя вопрос старый, я просто наткнулся на аналогичный вопрос. И я нашел ответ довольно неполным. Итак, вот что я узнал.

На самом деле пример кода не имеет смысла. При использовании default=True вы всегда должны указывать дополнительное имя переменной, в противном случае либо переменная, либо опция имеют обратную логику.

Итак, в исходном примере, если вы хотите, чтобы --status использовался по умолчанию, перепишите код следующим образом:

      @click.option(
    "-n",
    "--no-status",
    "status"
    default=True,
    is_flag=True,
    help="Do not show status",
)
def main(status):
...

Если вы измените существующий инструмент таким образом, вы также можете повторно добавить --status как задокументированную устаревшую опцию, чтобы сохранить совместимость.