Python - argparse

헨도·2023년 2월 6일
0
post-thumbnail

Python

argparse 란?

argparse 는 argument parser의 줄임말이며, 인자와 관련된 기능을 제공한다.
즉, Command Line에서 직접 인자 값을 넣어줄 때 사용하는 모듈

기존에는 코드 내에서 값을 수정하고, Command Line에서 명령어를 입력하여 파이썬 파일을 실행하는 작업을 했지만,
효율적으로 Command에서 인자 값을 바꾸기 위해서 argparse를 사용한다.

argparse 사용하기

1. import argparse

import argparse

argparse를 사용하기 위해 해당 모듈을 import

2. parser 객체 생성

parser = argparse.ArgumentParser()

ArgumentParser() 메소드를 통해 parser 객체 생성

3. 사용할 인자 추가

parser.add_argument('--d')

생성한 parser 객체에 .add_argument 메소드를 통해 사용할 인자를 추가한다.
사용할 인자에는 사용할 명칭을 추가해준다.

만약 "--" 표시를 빼고 사용하면 python main.py d 2023-01-01처럼 선언해야 하는데, 어느 부분이 매개 변수이고, 인자인지 구별하기 힘들다.
그래서 구분을 목적으로 "--" 표시를 사용한다.

parse_args()

args = parser.parse_args()

parse_args() 함수는 앞서 정의한 정보들을 최종적으로 저장하는 역할이다.
그리고 입력받은 인자 값을 print 문으로 확인해본다.

print(args.d)

>>> 2023-01-01

조건 부여하기

데이터 형식

입력받은 인자 값의 데이터 형식은 string 이며, 다른 데이터 형식으로 입력받고 싶으면 add_argument에 명시한다.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument('--d', type = int)

필수 값

입력받는 인자 값을 필수로 받고싶다면, add_argument의 조건에 required = True 를 명시한다.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument('--d', required = True)

short 기능

입력받는 인자 값이 길다면, short 기능을 사용하여 간단 명령어로 표현한다.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument('--datetime', '-d')
profile
Junior Backend Developer

0개의 댓글