文章目录
- [01 需求场景](#01 需求场景)
- [02 分别建立.env文件](#02 分别建立.env文件)
- [03 指定当前的环境](#03 指定当前的环境)
- [04 在代码中加载对应的环境变量文件](#04 在代码中加载对应的环境变量文件)
01 需求场景
在Python项目中,环境变量的配置通常会使用.env
文件进行,但有时,我们的一个Python项目需要区分不同的运行环境,例如本地开发环境、测试环境、开发环境。本文就讲讲如何做多环境的配置。
假设我们有三个环境:dev, test, pro。分别对应本地开发环境、测试环境、生产环境,这些环境中有的环境变量是相同的,有的是每个环境特有的。
02 分别建立.env文件
创建四个.env
文件,分别是:
.env
存放通用的环境变量.env.dev
对应开发环境,存放开发环境中特有的环境变量.env.test
对应测试环境.env.pro
对应生产环境
03 指定当前的环境
一种方式是在Linux系统中编辑~/.bashrc
文件来设置环境变量:
bash
vim /root/.bashrc
# 写入:ENV_STATE=test
# 保存并退出后刷新
source ~/.bashrc
如果是使用.gitlab-ci.yml
,可以这样设置:
yml
# .gitlab-ci.yml
...
workflow:
rules:
- if: $CI_COMMIT_BRANCH == 'dev' # 测试环境runner
variables:
DEPLOY_VARIABLE_TAG: "..."
ENV_STATE: "test" # 添加这一行添加环境状态为test
when: always
- if: $CI_COMMIT_BRANCH == 'main' # 生产环境runner
variables:
DEPLOY_VARIABLE_TAG: "..."
ENV_STATE: "pro" # 添加这一行添加环境状态为pro
when: always
- when: never # 在上述两种情况之外 never
...
deploy:
...
script:
# 在docker run命令中加入环境变量的配置
- docker run ... -e ENV_STATE=$ENV_STATE ...
...
04 在代码中加载对应的环境变量文件
在需要加载环境变量的地方,使用dotenv
来加载环境变量。
(建议在一个文件中对环境变量进行统一集中管理,这里我专门新建了一个config.py
的文件用于导入环境变量)
python
"""config.py"""
import os
import dotenv
# 首先获取当前的环境状态(记录在.gitlab-ci.yml中)如果获取不到则默认使用dev开发环境
env_state = os.getenv("ENV_STATE", "dev")
# 先加载通用的环境变量
dotenv.load_dotenv()
# 加载特定环境的环境变量
# 第一个参数如果获取不到对应文件需要写成绝对路径 借助Path(__file__)获取路径
# 第二个参数override=True表示当已存在同名环境变量时 用特定的环境变量值进行覆
dotenv.load_dotenv(f".env.{env_state}", override=True)