[파이썬] argparse 프로그래밍 패턴과 argparse 통합

07 Sep 2023

argparse

argparse는 파이썬에서 명령줄 인터페이스를 구현하기 위한 표준 라이브러리입니다. argparse를 사용하여 스크립트에 명령줄 인자를 추가할 수 있고, 이를 통해 사용자가 스크립트를 더 쉽게 사용할 수 있습니다.

하지만 argparse를 효과적으로 사용하기 위해서는 일정한 패턴과 몇 가지의 통합 방법을 알고 있어야 합니다. 이 블로그 포스트에서는 argparse 프로그래밍 패턴과 argparse를 다른 파이썬 모듈과 통합하는 방법을 알아보겠습니다.

argparse 프로그래밍 패턴

argparse를 사용하여 명령줄 인터페이스를 구현할 때 일반적으로 다음과 같은 패턴을 따릅니다:

argparse.ArgumentParser 객체를 생성합니다.
add_argument 메서드를 사용하여 명령줄 인자를 정의합니다.
parse_args 메서드를 호출하여 명령줄 인자를 해석합니다.

예를 들어, 다음과 같이 명령줄에서 입력받은 숫자 두 개를 더하는 스크립트를 작성한다고 가정해보겠습니다:

import argparse

def add_numbers():
    parser = argparse.ArgumentParser(description='Add two numbers')
    parser.add_argument('number1', type=int, help='First number')
    parser.add_argument('number2', type=int, help='Second number')
    args = parser.parse_args()
    
    result = args.number1 + args.number2
    print(f"The sum of {args.number1} and {args.number2} is {result}")

if __name__ == '__main__':
    add_numbers()

이 스크립트는 python script.py 5 3과 같이 두 개의 숫자를 인자로 받아서 합을 계산하고 출력합니다.

다른 모듈과 argparse 통합

argparse는 다른 파이썬 모듈과 통합하기 위해 좋은 방법입니다. 예를 들어, argparse와 logging 모듈을 함께 사용하여 스크립트에 로깅 기능을 추가할 수 있습니다.

import argparse
import logging

def add_numbers():
    parser = argparse.ArgumentParser(description='Add two numbers')
    parser.add_argument('number1', type=int, help='First number')
    parser.add_argument('number2', type=int, help='Second number')
    parser.add_argument('--log', help='Enable logging', action='store_true')
    args = parser.parse_args()
    
    if args.log:
        logging.basicConfig(level=logging.INFO)
    
    logger = logging.getLogger(__name__)
    
    result = args.number1 + args.number2
    logger.info(f"The sum of {args.number1} and {args.number2} is {result}")
    print(f"The sum of {args.number1} and {args.number2} is {result}")

if __name__ == '__main__':
    add_numbers()

이 스크립트는 --log인자를 추가하여 로깅을 활성화할 수 있습니다. 로깅은 스크립트의 작동 상태를 기록하는데 유용합니다.

argparse는 다양한 모듈과 통합할 수 있는 유연성을 제공합니다. 다른 모듈과 함께 argparse를 사용하여 명령줄 인터페이스에 원하는 기능을 추가할 수 있습니다.

마무리

argparse는 파이썬에서 명령줄 인터페이스를 구현하는데 매우 유용한 라이브러리입니다. argparse를 효과적으로 사용하기 위해서는 가독성 좋은 코드를 작성하는 argparse 프로그래밍 패턴과 다른 모듈과의 통합 방법을 알고 있어야 합니다.

이 블로그 포스트에서는 argparse 프로그래밍 패턴과 argparse를 다른 파이썬 모듈과 통합하는 방법에 대해 알아보았습니다. 이를 통해 스크립트를 보다 유연하고 강력하게 만들 수 있습니다.