--help 옵션에서 Click.option의 기본 입력 값과

Question

은 @click.option()의 기본 입력 값을 도움말 텍스트에 표시하여 프로그램이 --help과 함께 호출 될 때 인쇄되도록하려면 어떻게해야합니까?

Answer 1

옵션을 정의 할 때 click.option 데코레이터에서 show_default=True을 전달하십시오. --help 옵션을 사용하여 프로그램을 호출하면 도움말에 기본값이 표시됩니다. 예를 들어 - 당신이 count 옵션의 기본 값은의 도움말 텍스트로 표시되는 것을 볼 수 있습니다 python hello.py --help 따라서

$ python hello.py --help 
Usage: hello.py [OPTIONS] 

    <insert text that you want to display in help screen> e.g: Simple program that greets NAME for a total of COUNT times. 

Options: 
    --count INTEGER Number of greetings. [default: 1] 
    --name TEXT  The person to greet. 
    --help   Show this message and exit. 

로

#hello.py 
import click 

@click.command() 
@click.option('--count', default=1, help='Number of greetings.', show_default=True) 
@click.option('--name', prompt='Your name', 
       help='The person to greet.') 
def hello(count, name): 
    """<insert text that you want to display in help screen> e.g: Simple program that greets NAME for a total of COUNT times.""" 
    for x in range(count): 
     click.echo('Hello %s!' % name) 

if __name__ == '__main__': 
    hello() 

이제 실행에 의해 생성 된 도움말 화면을 볼 수 있습니다 프로그램. (참조 : https://github.com/pallets/click/issues/243)