argparse 모듈로 커맨드라인 인자 가져오기

파이썬에서 커맨드라인 인자를 가져올때, 그동안 Copy&Paste 만 하고 문법을 제대로 공부하지 않았다. 그래서 이번에 argparse 모듈로 커맨드라인 인자를 파싱하는 방법을 알아봤다.

 

파이썬 공식 페이지에 Argparse Tutorial이 있어서 이걸 읽어봤다.

 

Argparse Tutorial: 커맨드라인 파싱을 위한 argparse라는 모듈을 친절하게 설명해준다고 한다.

 

먼저 아래와 같은 간단한 샘플 코드 및 실행 결과가 나온다.

 

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)

 

$ python3 prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python3 prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit
$ python3 prog.py foo
foo

 

우선 코드를 먼저 보면, 대략 이런 내용이다.

• argparse.ArgumentParser()를 이용해서 인스턴스를 생성
• add_argument() 메소드로 파싱할 인자를 지정
• parse_args() 메소드로 커맨드라인 인자를 파싱
• 파싱한 인자를 출력

다음으로 실행 코드를 살펴보면, 입력해야할 값을 누락시켰을때 이를 알려주는 기능,  --help로 도움말을 출력하는 기능이 디폴트로 구현되어 있는 것을 알 수 있다. 사실 기능 자체가 간단하고, 인터페이스도 직관적이라서 기본 사용법에 관해서는 이상의 설명이 필요 없을 것 같다.