[파이썬] argparse metavar를 사용한 도움말 커스터마이징

Python의 argparse 모듈은 명령행 인자를 파싱하는 데 사용되는 강력한 도구입니다. argparse를 사용하면 스크립트에 명령행 인자를 사용하여 유연성을 더할 수 있습니다. 이러한 유연성을 더하는 한 가지 방법은 argparsemetavar 옵션을 사용하여 도움말 출력을 커스터마이징하는 것입니다.

metavar는 인수의 대체 이름을 정의하는데 사용됩니다. 기본적으로 argparse는 인수 이름을 사용하여 도움말을 생성합니다. 그러나 metavar를 사용하면 인수에 대한 사용자 정의 이름을 제공할 수 있습니다. 이는 도움말을 더 명확하고 읽기 쉽게 만들어줍니다.

아래의 예제에서는 argparse를 사용하는 스크립트에서 metavar를 커스터마이징하는 방법을 살펴보겠습니다.

import argparse

# ArgumentParser 인스턴스 생성
parser = argparse.ArgumentParser()

# 인자 추가
parser.add_argument('-f', '--file', metavar='path/to/file', help='Input file path')

# 인자 파싱
args = parser.parse_args()

# 파싱된 인자 사용
print(args.file)

위의 코드에서 metavar 옵션을 사용하여 -f/--file 인자의 이름을 path/to/file로 지정했습니다. 이렇게 하면 도움말 출력에서 해당 인자에 대해 더 명확한 설명을 제공할 수 있습니다.

실행하면 스크립트에 대한 도움말 출력에서 다음과 같이 확인할 수 있습니다.

usage: script.py [-h] [-f path/to/file]

optional arguments:
  -h, --help          show this help message and exit
  -f path/to/file, --file path/to/file
                      Input file path

위의 출력에서 -f/--file 인자에 대한 설명이 path/to/file로 정확히 표시되는 것을 볼 수 있습니다. 이를 통해 사용자는 인자의 의미를 더 쉽게 이해할 수 있습니다.

따라서 argparse metavar를 사용하여 도움말을 커스터마이징하면 스크립트의 인자에 대한 설명을 더 명확하고 유익하게 제공할 수 있습니다. 이를 통해 사용자는 명령행 인자를 더 쉽게 이해하고 스크립트를 더 효과적으로 사용할 수 있습니다.