FastAPI는 Python 웹 프레임워크로서, 환경변수를 사용하여 애플리케이션을 설정하는 것이 일반적입니다. 환경변수를 효과적으로 관리하기 위해 python-dotenv 라이브러리를 사용할 수 있습니다. 이번 글에서는 FastAPI 애플리케이션에서 python-dotenv를 사용하는 방법에 대해 알아보겠습니다.
python-dotenv란?
python-dotenv는 .env 파일을 사용하여 환경변수를 로드하는 파이썬 라이브러리입니다. .env 파일에는 키-값 형식으로 설정 값을 저장할 수 있으며, 애플리케이션 실행 시 해당 파일을 로드하여 환경변수로 사용할 수 있습니다.
설치
python-dotenv를 설치하기 위해 다음 명령을 실행합니다:
pip install python-dotenv
.env 파일 생성
FastAPI 애플리케이션의 루트 디렉토리에 .env 파일을 생성합니다. 이 파일에는 환경변수를 저장할 것입니다.
.env 파일 내용 설정
.env 파일에는 키-값 형식으로 환경변수 값을 설정합니다. 예를 들어, 다음과 같은 내용을 .env파일에 작성할 수 있습니다:
DB_HOST=localhost
DB_PORT=5432
DB_NAME=mydatabase
FastAPI 애플리케이션에서 python-dotenv 사용
FastAPI 애플리케이션에서 python-dotenv를 사용하기 위해 다음 단계를 따릅니다:
-
FastAPI 앱의 시작 부분에 다음 코드를 추가하여 python-dotenv를 로드합니다:
from dotenv import load_dotenv load_dotenv() -
필요한 환경변수를 사용하려는 위치에서 다음과 같이 코드를 작성하여 해당 환경변수를 사용할 수 있습니다:
import os db_host = os.getenv("DB_HOST") db_port = os.getenv("DB_PORT") db_name = os.getenv("DB_NAME")위의 예제에서
DB_HOST,DB_PORT,DB_NAME은 .env 파일에 설정된 키입니다.
주의사항
- .env 파일은 보안에 민감한 정보를 포함할 수 있으므로, 공개된 저장소에 .env 파일을 업로드하지 않도록 주의해야 합니다.
- .env 파일을 변경한 경우 FastAPI 앱을 재시작해야 새로운 환경변수 값이 적용됩니다.
결론
python-dotenv를 사용하면 FastAPI 애플리케이션의 환경변수를 쉽게 관리할 수 있습니다. .env 파일을 사용하여 설정 값을 저장한 후, python-dotenv를 통해 해당 값을 로드하여 사용할 수 있습니다. 이를 통해 애플리케이션의 설정을 유연하게 변경할 수 있고, 보안을 유지할 수 있습니다.