클릭을 클릭

_images/click-logo.png

클릭(Click)은 꼭 필요한 코드만으로 아름다운 명령행 인터페이스를 조합할 수 있는 파이썬 패키지다. “Command Line Interface Creation Kit”을 줄인 이름이다. 폭넓은 설정이 가능하면서도 적절한 기본값이 갖춰져 있다.

명령행 도구 작성 작업을 빠르고 재밌게 만들어 주면서도 원하는 CLI API를 구현할 수 없어서 좌절하는 일이 없도록 하는 걸 목표로 한다.

클릭에는 세 가지 특징이 있다.

  • 마음대로 명령 계층 만들기

  • 도움말 자동 생성

  • 하위 모듈 런타임 적재 지원

다음은 간단한 클릭 프로그램 예시다.

import click

@click.command()
@click.option('--count', default=1, help='인사 횟수.')
@click.option('--name', prompt='이름',
              help='인사를 받을 사람.')
def hello(count, name):
    """NAME에게 COUNT 번 인사를 하는 간단한 프로그램"""
    for x in range(count):
        click.echo('Hello %s!' % name)

if __name__ == '__main__':
    hello()

실행하면 다음과 같이 된다.

$ python hello.py --count=3
이름: John
Hello John!
Hello John!
Hello John!

자동으로 멋진 형식의 도움말을 만들어 준다.

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

  NAME에게 COUNT 번 인사를 하는 간단한 프로그램

Options:
  --count INTEGER  인사 횟수.
  --name TEXT      인사를 받을 사람.
  --help           Show this message and exit.

PyPI에서 바로 라이브러리를 받을 수 있다.

pip install click

기본 문서

라이브러리 사용 패턴 모두를 차례로 설명한다.

API 참조 문서

특정 함수나 클래스, 메소드에 대한 내용을 찾는다면 여기를 보면 된다