[파이썬] argparse RawTextHelpFormatter 활용
argparse는 Python에서 명령행 인자를 구문 분석하기 위한 표준 라이브러리입니다. 기본적으로는 기능이 강력하지만, 출력 형식이 부족하거나 사용자를 위한 이해하기 쉬운 형식으로 인자 도움말을 표시하기 어려울 때가 있습니다. 이때 argparse.RawTextHelpFormatter를 사용하면 원하는 포맷으로 인자 도움말을 작성할 수 있습니다.
import argparse
# Argument Parser 생성
parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
# 인자 추가
parser.add_argument('--input', help='입력 파일 경로', type=str)
parser.add_argument('--output', help='출력 파일 경로', type=str)
# 도움말 작성
help_message = '''
이 스크립트는 입력 파일을 가공하여 출력 파일로 저장합니다.
예제 사용법:
python script.py --input input.txt --output output.txt
'''
# 도움말 설정
parser.description = help_message
# 파싱
args = parser.parse_args()
위 예제에서는 argparse.RawTextHelpFormatter를 사용하여 도움말의 출력 형식을 변경하였습니다. formatter_class 인자에 지정해주면 됩니다. 그리고 parser.description을 이용하여 도움말의 내용을 작성할 수 있습니다.
이렇게 사용자가 이해하기 쉬운 형식으로 인자 도움말을 작성하면, 사용자들이 프로그램 사용법을 더욱 쉽게 이해할 수 있습니다.