[Python] Argparse 모듈 사용법 및 Cli 옵션

Argparse 모듈

Argparse 모듈은 Cli 를 통하여 Python 코드를 실행하는 경우 특정 옵션을 지정하고 옵션에 대한 값을 코드 내 인자로 전달가능하도록 하는 모듈이다.

https://docs.python.org/ko/3/library/argparse.html

argparse — 명령행 옵션, 인자와 부속 명령을 위한 파서 — Python 3.11.0 문서

 

 

ArgParse Import(+설치)

ArgParse의 경우 기본적으로 Python에 내장되어 있는 모듈이다. 별도의 설치 과정 없이 다음과 같은 코드를 통해 import 하여 사용할 수 있다.

import argparse

 

 

ArgParse 예시 코드

실제 argparse를 사용한 예시 코드는 다음과 같다.

import argparse

parser = argparse.ArgumentParser(description="사용법 test 입니다") # Parse 객체 생성
parser.add_argument('-p', type=str, help = '-p 안녕하세요' ) # 입력 받고자 하는 옵션 값과 옵션 값 생성
parser.add_argument('-o', type=int, help = '-o 3')

args = parser.parse_args() # 인자들을 파싱하여 args 에 저장

if __name__ =='__main__':
    for i in range(args.o):
        print(args.p)

 

옵션 값에 따른 실행 결과는 다음과 같다.

예시 코드 실행 결과

ArgParse 세부적인 코드 설명

우선 Parser를 정상적으로 사용하기 위해 Parse 객체를 생성한다.

parser = argparse.ArgumentParser(description="사용법 test 입니다") # Parse 객체 생성

 

Parse 객체를 생성했다면 사용하기 원하는 옵션을 지정하고 옵션 값의 자료형(type) 그리고 -h(help)를 입력했을 때 나타낼 예시를 입력해준다.

(예시 코드에서는 -p > "출력하고자 하는 문자열", -o > "출력하고자 하는 횟수)

parser.add_argument('-p', type=str, help = '-p 안녕하세요' ) # 입력 받고자 하는 옵션 값과 옵션 값 생성
parser.add_argument('-o', type=int, help = '-o 3')

 

객체에 옵션 및 옵션 값을 추가하였다면 인자들을 파싱하여  args 변수에 저장하여 실제 사용 가능하도록 형태를 만들어준다.

args = parser.parse_args() # 인자들을 파싱하여 args 에 저장

 

-p 옵션이 출력하고자 하는 문자열이었고 -o 옵션이 출력하고자 하는 횟수였으므로 실제 값들이 사용될 곳을  지정해준다.

if __name__ =='__main__':
    for i in range(args.o):
        print(args.p)

 

 

 

오류, 잘못된 점 또는 궁금한 점이 있으시다면 댓글 남겨주세요❗