기본 콘텐츠로 건너뛰기

Python에서 CLI 도구 만들기 (argparse vs click)


파이썬으로 명령줄 도구 만드는 중이신가요? 저도 얼마 전에 비슷한 작업을 했었는데, argparseclick이라는 두 라이브러리 때문에 꽤 고민했거든요. 둘 다 훌륭하지만, 어떤 걸 써야 할지 정말 헷갈리더라고요. 그래서 제가 직접 써보고 느낀 점들을 바탕으로 얘기해 드릴게요!

먼저, argparse는 파이썬에 기본적으로 포함된 라이브러리예요. 기능은 정말 막강하죠. 마치 스위스 아미 나이프처럼, 세세하게 옵션을 조절할 수 있어요. 복잡한 도구를 만들 때는 정말 유용해요. 하지만, 간단한 걸 만들 때는 쓸데없이 코드가 길어지는 느낌이 들더라고요. 마치 거대한 대포로 모기를 잡는 것 같은 느낌이랄까요? 저는 처음에 argparse로 시작했는데, 코드가 너무 길어지니까 나중에 수정하기가 힘들더라구요. 괜히 힘들게 했나 싶었어요.

반면에 click은 외부 라이브러리인데, 사용하기가 훨씬 쉽고 간결해요. 마치 레고 블록처럼, 몇 개의 코드만으로도 멋진 명령줄 도구를 만들 수 있죠. 특히 데코레이터라는 기능을 사용하는데, 처음엔 좀 어렵게 느껴질 수도 있지만, 익숙해지면 코드가 정말 깔끔해져요. 저는 간단한 도구를 만들 때 click을 사용했는데, 정말 속도가 빨랐어요. 코드도 짧고 이해하기도 쉬워서 좋았습니다. 마치 마법처럼 뚝딱 만들어지는 느낌이었어요!

실제로 제가 만들었던 간단한 파일 처리 도구 예시를 보여드릴게요. argparse로 만든 코드는 이렇게 길어졌지만, click으로 만든 코드는 훨씬 짧고 보기 편하더라고요.

1. argparse 예제

import argparse

def main():
    parser = argparse.ArgumentParser(description="파일 내용을 출력하거나 줄 수를 세는 도구")

    parser.add_argument("filename", help="읽을 파일 이름")
    parser.add_argument(
        "-c", "--count",
        action="store_true",
        help="파일의 줄 수를 출력"
    )

    args = parser.parse_args()

    with open(args.filename, "r", encoding="utf-8") as f:
        lines = f.readlines()

    if args.count:
        print(f"줄 수: {len(lines)}")
    else:
        print("".join(lines))

if __name__ == "__main__":
    main()

실행 예시

$ python tool.py example.txt
(파일 내용이 출력됨)

$ python tool.py example.txt --count
줄 수: 42

🔎 특징

  • 표준 라이브러리 → 별도 설치 필요 없음.
  • 옵션 정의가 조금 장황하고, 복잡한 도구에서 강력함.
  • 함수형이 아니라 parser.add_argument로 계속 추가하는 방식.

2. click 예제

import click

@click.command()
@click.argument("filename")
@click.option(
    "--count", "-c",
    is_flag=True,
    help="파일의 줄 수를 출력"
)
def main(filename, count):
    """파일 내용을 출력하거나 줄 수를 세는 도구"""
    with open(filename, "r", encoding="utf-8") as f:
        lines = f.readlines()

    if count:
        click.echo(f"줄 수: {len(lines)}")
    else:
        click.echo("".join(lines))

if __name__ == "__main__":
    main()

실행 예시

$ python tool.py example.txt
(파일 내용이 출력됨)

$ python tool.py example.txt -c
줄 수: 42

🔎 특징

  • 외부 라이브러리 (pip install click) 필요.
  • 데코레이터(@click.command, @click.option)로 선언적이고 코드가 깔끔해짐.
  • click.echo는 자동으로 인코딩 처리를 해줘서 안전함.
  • 복잡한 하위 명령어(git commit 같은 구조)도 쉽게 확장 가능.

정리 비교

항목 argparse click
포함 여부 표준 라이브러리 (추가 설치 X) 외부 라이브러리 (pip 설치 필요)
코드 스타일 절차적, parser.add_argument 방식 선언적, 데코레이터 방식
학습 난이도 쉽지만 장황함 초반엔 낯설 수 있음, 익숙해지면 간결
장점 강력하고 유연함, 추가 의존성 없음 코드가 간결, 사용자 친화적 메시지, 확장 쉬움
권장 상황 대규모 복잡한 CLI, 기본만 쓰고 싶을 때 간단/중간 규모 CLI, 팀 협업 시 가독성 중요할 때

보시다시피 click이 훨씬 간결하죠? 물론 argparse가 더 강력한 기능을 제공하는 건 맞지만, 제가 만든 간단한 도구에는 오히려 click이 더 적합했어요. 프로젝트 규모가 크고 복잡한 옵션을 많이 다뤄야 한다면 argparse가 좋겠지만, 간단한 도구를 빠르게 만들고 싶다면 click을 추천드려요.

그리고 팀에서 이미 특정 라이브러리를 쓰고 있다면, 그냥 그걸 쓰는 게 좋을 거예요. 일관성을 유지하는 게 중요하니까요. 그리고 click의 데코레이터는 처음엔 어색할 수 있지만, 익숙해지면 정말 편리하다는 걸 알게 될 거예요.

결론적으로, 어떤 라이브러리를 선택할지는 여러분의 프로젝트 규모와 복잡성, 그리고 팀의 규약에 따라 달라요. 하지만 제 경험으로는, 간단한 도구라면 click으로 시작해보는 걸 추천합니다. 그리고 두 라이브러리를 모두 익혀두면 다양한 상황에 유연하게 대처할 수 있겠죠! 어떤 라이브러리를 선택하든, 멋진 CLI 도구를 만드시길 바랍니다!

댓글

이 블로그의 인기 게시물

Django에서 트랜잭션 관리하기

Django에서 트랜잭션 관리하기 안녕하세요! 오늘은 Django에서 데이터베이스 트랜잭션을 효과적으로 관리하는 방법에 대해 알아보겠습니다. 1. 트랜잭션의 중요성 트랜잭션은 데이터베이스의 일관성과 무결성을 보장하는 중요한 개념입니다. Django에서는 여러 가지 방법으로 트랜잭션을 관리할 수 있습니다. 1.1 기본 개념 원자성(Atomicity) : 트랜잭션은 모두 실행되거나 모두 실행되지 않아야 합니다. 일관성(Consistency) : 트랜잭션 전후로 데이터베이스의 일관성이 유지되어야 합니다. 격리성(Isolation) : 동시에 실행되는 트랜잭션들이 서로 영향을 주지 않아야 합니다. 지속성(Durability) : 완료된 트랜잭션의 결과는 영구적으로 저장되어야 합니다. 2. Django의 트랜잭션 관리 2.1 기본 설정 # settings.py DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'NAME': 'mydatabase', 'USER': 'myuser', 'PASSWORD': 'mypassword', 'HOST': 'localhost', 'PORT': '5432', 'ATOMIC_REQUESTS': True, # 모든 뷰를 트랜잭션으로 래핑 } } 2.2 데코레이터 사용 from django.db import transaction @transaction.atomic def create_order(user, items): order = Order.objects.create(user=...

AWS S3 + CloudFront로 정적 파일 서빙 완전 가이드

AWS S3 + CloudFront로 정적 파일 서빙 완전 가이드 안녕하세요! 오늘은 AWS S3와 CloudFront를 사용하여 정적 파일을 효율적으로 서빙하는 방법에 대해 알아보겠습니다. 왜 S3와 CloudFront를 사용할까요? 높은 가용성 : AWS의 글로벌 인프라를 활용 빠른 전송 속도 : CloudFront의 CDN 기능으로 전 세계 사용자에게 빠른 전송 비용 효율성 : 사용한 만큼만 지불 보안 : AWS의 보안 기능 활용 확장성 : 트래픽 증가에 자동 대응 1. S3 버킷 설정 1.1 버킷 생성 및 설정 import boto3 def create_s3_bucket(): s3 = boto3.client('s3') # 버킷 생성 bucket_name = 'your-static-files-bucket' s3.create_bucket( Bucket=bucket_name, CreateBucketConfiguration={ 'LocationConstraint': 'ap-northeast-2' } ) # 버킷 정책 설정 bucket_policy = { "Version": "2012-10-17", "Statement": [ { "Sid": "PublicReadGetObject", "Effect": "Allow", "Principal": "*", "Action": "s3:GetObje...

Python에서 asyncio 완전 정복 (await, async, gather 등)

어휴, 요즘 파이썬으로 비동기 프로그래밍 하는 재미에 푹 빠졌어요! 특히 asyncio 는 정말 마법 같더라고요. 처음엔 좀 낯설었는데, 익숙해지니까 속도 향상이 눈에 띄게 느껴져서 완전 반해버렸습니다. 이 글에선 제가 asyncio 를 배우면서 깨달은 점들을 풀어놓을게요. 혹시 비동기 프로그래밍이 뭔지 잘 모르시겠다면, 간단히 말해 여러 작업을 동시에 처리해서 프로그램 속도를 엄청나게 높이는 기술이라고 생각하시면 돼요. 마치 여러 요리사가 동시에 음식을 만들어서 손님에게 빨리 제공하는 것과 비슷하죠! 일단 async 와 await 라는 녀석들이 핵심인데요, async 는 함수 앞에 붙여서 "얘는 비동기 함수야!"라고 선언하는 거예요. 그리고 await 는 다른 비동기 함수가 끝날 때까지 기다리라고 지시하는 역할을 하죠. 예를 들어, 네트워크에서 데이터를 가져오는 함수가 있다면, await 를 사용해서 데이터가 다 가져올 때까지 기다렸다가 다음 작업을 진행할 수 있어요. 그 동안 다른 작업을 처리할 수 있으니, 마치 멀티태스킹을 하는 것처럼 느껴져요. 신기하지 않나요? 그리고 asyncio.gather 는 여러 비동기 함수를 동시에 실행하고 결과를 모아주는 아주 유용한 친구입니다. 제가 웹사이트 여러 개에서 데이터를 동시에 가져와야 할 때 정말 요긴하게 썼어요. 하나씩 순서대로 가져오는 것보다 훨씬 빠르더라고요! 마치 여러 개의 탭을 동시에 열어놓고 작업하는 것과 같다고 생각하시면 될 것 같아요. 실제로 제가 썼던 코드를 보여드릴게요. 세 개의 웹사이트에서 데이터를 가져오는 예제인데요. (아래 코드 삽입) 이 코드를 보시면, fetch_data 함수가 각 웹사이트에서 데이터를 가져오는 역할을 하고, asyncio.gather 가 이 함수들을 동시에 실행하도록 도와주는 것을 볼 수 있을 거예요. asyncio.sleep(2) 는 네트워크 지연을 시뮬레이션하기 위해 넣...