Read Configuration - minnie0531/fastapi-template GitHub Wiki

python에서는 다양한 방법으로 configuration을 읽을 수 있는데 이는 파일을 형태나 사용자의 의도에 따라 결정된다. 크게 환경변수를 읽는 방법과 파일로 읽는 방법이 있고, 환경 변수로 configuration들이 설정될 경우 os.getenv("VARIABLE_NAME") 으로 값을 가져 오면 된다.

파일로 읽는 방법은 json이나 yaml 형태는 json이나 pyyaml을 통해 읽는 방법과 동일 하며, 여기에서는 pydantic의 settings를 이용한 .env 파일 읽는 방법과 configparser와 jpproperties를 이용한 python config 파일읽기를 다룰 예정이다.

Use Pydantic settings

FastAPI를 사용게 되면 자연스럽게 pydantic의 model을 business모델로 구현할 때 사용하게 된다. 그러면 기존에 사용하고 있는 모듈을 사용해서 configuration을 구현 한다면 일종의 통일감을 주는 마음의 안정(?)을 가질 수 있기 때문에 한번 시도 해보기로 했다.

pydatic의 경우 python 모듈 중 python-dotenv를 이용하여 .env를 읽어올 수 있게 해준다.

1. db_confg.env 준비

HOST="localhost"
PORT=1521
SID="ORACLE"
USER_ID="aaa"
USER_PW="1234"

1. Create Settings class

from pydantic import BaseSettings

class Settings(BaseSettings):
    host: str
    port: int
    sid: str
    user_id: str
    user_pw: str
   
    class Config:
        env_file = 'db_config.env'
        env_file_encodeing = 'utf-8'

1. Create Settings instance and get values

settings = Settings(_env_file='./app/config/db_config.env')

dsn = cx_Oracle.makedsn(host=**settings.host**, port=**settings.port**, sid=**settings.sid**)
engine = create_engine("oracle+cx_oracle://%s:%s@%s" % (**settings.user_id**, **settings.user_pw**, str(dsn)))

사용방법이 어렵지 않지만 setting에 대한 모델을 다시한번 정의 하고 들어간다. 이러한 방법은 어떤 요소들이 있는지에 대해 명시적이지만, 한편으로는 코드를 분석할 때 파일을 하나 더 보게 하는 번거로움이 있다. configuration들은 대게 바로 알아 볼 수 있는 변수들을 선택하고 있기도 하고 이미 알고 정의된 값으로 전달하기 때문에 개인적으로는 코드를 읽기 편하게 하기 위해서 이러한 방법보다는 다이렉트로 값을 가져오는 것을 선호 한다. (개인적인 차이다)

Use configParser

1. Use db_config.env but add section on the config and remove quotation marks " '

Quotation mark도 같이 읽어가기 때문에 지워주는 게 좋음

**[db]**
HOST=localhost
PORT=1521
SID=ORCLCDB
USER_ID=aaa
USER_PW=1234

1. Declare configParser and read file and attributes

기본적으로 string으로 변환하여 주기때문에 int로 읽어가야 하는 부분에서 형변환이 필요로함.

parser = ConfigParser()
parser.read(r'./app/config/db_config.env')

dsn = cx_Oracle.makedsn(host=parser.get('db', 'host'), port=int(parser.get('db', 'port')), sid=parser.get('db',  'sid'))
engine = create_engine("oracle+cx_oracle://%s:%d@%s" % (parser.get('db','user_id'), int(parser.get('db','user_pw')), str(dsn)))

Kubernetes에서 configMap 의 경우 대부분 properties파일로 전달하게 되는데, 이는 처음 사용한 db_cofnig.env에 가깝다. section파트가 없기 때문에 configParser를 이용하면 아래와 같은 에러가 나올 것이다. configparser.MissingSectionHeaderError: File contains no section headers

그래서 section이 없을 경우 string 형태로 변경하고 section추가후 configParser를 이용하는 방법도 있다.(예쁘지 않다..)

User jproperties

confgMap으로 저장된 properties 파일을 읽어 갖고 오기에 가장 편한 방법이 아닐까 생각된다. 따로 모델에 대한 구현 없이 값을 get하여 가져 올 수 있고 추가적으로 section을 넣어주는 것도 없다.

1. pip install jproperties
2. user original db_config.env

HOST=localhost
PORT=1521
SID=ORCLCDB
USER_ID=aaa
USER_PW=1234

1. Declare properties and get the values

from jproperties import Properties
 
configs = Properties()

with open('./app/config/db_config.env', 'rb') as config_file:
    configs.load(config_file)

dsn = cx_Oracle.makedsn(host=configs.get('HOST').data, port=int(configs.get('PORT').data), sid=configs.get('SID').data)
engine = create_engine("oracle+cx_oracle://%s:%d@%s" % (configs.get('USER_ID').data, int(configs.get('USER_PW').data), str(dsn)))

구현이나 가독성에 있어서 장점이 있지만, 앞의 먼저 보여준 예제와 달리, 모듈을 추가로 설치해야 한다.

파일을 읽어서 configuration을 설정하는 방법은 여러가지가 있기 때문에 상황에 따라 적절하게 적용해보자!