Click: the Python CLI library

click ?

command line interface를 쉽게 만드는데 사용되는 library 입니다.

installation

간단히 pip를 통해 설치 가능합니다.

pip install click

 

사용법

&nbsp

click.command

click은 decorator를 통해 command를 정의합니다.
CLI를 통해 실행하고 싶은 함수 위에 @click.command()를 추가하여 click framework을 통해 실행 되도록 지정합니다.

 

ex.

# ...
# main.py

import click

@click.command()
@click.option('--name', default='', help='name to be echoed')
def echo(name):
    print('echo = ', name)

 

click.group

여러 command들을 한번에 click framework에 등록하려면, @click.group decorator를 사용합니다.

@click.group()
def cmd():
    ...

 

위와 같이 group command인 cmd 함수를 정의합니다.
이후 각 command들은 @click.command()를 통해 등록하는 것이 아니라, @cmd.command를 통해 등록합니다.

 

@cmd.command(help="echo your name")
@click.option('--name', default='', help='name to be echoed')
def echo(name):
    print('echo = ', name)

@cmd.command(help="print your age")
@click.option('--age', default='', help='let it take your age')
def print_age(age):
    print('age = ', age)

 

다음과 같이 cmd()만 실행하여 여러개의 command들이 실행되도록 등록할 수 있습니다.

 

if __name__ == "__main__":
    cmd()

 

이제 다음과 같이 test 하면 됩니다.

 

main.py echo --name="Ace"

 

main.py print_age --age=20