Python | 在Python项目中做多环境配置(环境变量使用.env文件)


01 需求场景

在Python项目中,环境变量的配置通常会使用.env文件进行,但有时,我们的一个Python项目需要区分不同的运行环境,例如本地开发环境、测试环境、开发环境。本文就讲讲如何做多环境的配置。

假设我们有三个环境:dev, test, pro。分别对应本地开发环境、测试环境、生产环境,这些环境中有的环境变量是相同的,有的是每个环境特有的。

02 分别建立.env文件

创建四个.env文件,分别是:

  • .env 存放通用的环境变量
  • .env.dev 对应开发环境,存放开发环境中特有的环境变量
  • .env.test 对应测试环境
  • .env.pro 对应生产环境

03 指定当前的环境

一种方式是在Linux系统中编辑~/.bashrc文件来设置环境变量:

vim /root/.bashrc
# 写入:ENV_STATE=test
# 保存并退出后刷新
source ~/.bashrc

如果是使用.gitlab-ci.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的文件用于导入环境变量)

"""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)
### 创建和配置 `.env` 文件 为了有效管理和隔离不同环境下的配置,在 Python 项目中可以利用 `.env` 文件存储环境特定的变量。这不仅有助于保护敏感数据,还能简化跨多个环境部署的过程。 #### 安装依赖包 首先,需安装 `python-dotenv` 库以便能够读取并应用 `.env` 文件内的设置: ```bash pip install python-dotenv ``` #### 编写 `.env` 文件 接着,在项目的根目录下创建名为 `.env` 的纯文本文件,并按照键值对的形式定义所需的环境变量。例如: ```plaintext DATABASE_URL=postgres://user:password@localhost:5432/mydatabase SECRET_KEY=mysecretkeyvalue DEBUG=True ENVIRONMENT=development ``` 上述每一行代表一个独立的环境变量声明[^1]。 #### 加载 `.env` 文件中的环境变量 为了让应用程序识别这些自定义环境变量,需要通过编程方式将其导入至操作系统环境中。可以在入口脚本或主模块顶部加入如下代码片段完成此操作: ```python import os from dotenv import load_dotenv # 显式指定要加载的 .env 文件路径 (可选) dotenv_path = os.path.join(os.getcwd(), '.env') if os.path.exists(dotenv_path): load_dotenv(dotenv_path) # 获取已加载的环境变量 db_url = os.getenv('DATABASE_URL', 'sqlite:///default.db') # 提供默认值以防缺失 debug_mode = os.getenv('DEBUG').lower() in ['true', 'yes', 'on'] # 转换布尔型字符串表示法 environment_name = os.getenv('ENVIRONMENT') print(f"Database URL is {db_url}") print(f"Debug mode {'enabled' if debug_mode else 'disabled'}") print(f"Running under '{environment_name}' environment.") ``` 这段代码展示了如何安全地访问 `.env` 中定义的各项参数,并适当地处理其类型转换逻辑[^3]。 #### 设置 IDE 运行配置支持 `.env` 对于集成开发环境(IDE),比如 PyCharm 或 VSCode 用户来说,还可以进一步优化体验——即让调试器启动前自动加载相应的环境变量。具体法是在编辑运行/调试配置时启用 envfile 功能,并指向目标 `.env` 文件位置[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

程序猿林仔

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值