使用 Pydantic 和 .env 文件管理环境配置

news/2025/3/16 16:44:55/文章来源:https://www.cnblogs.com/linsuiyuan/p/18775219

Pydantic 是一个 Python 库,用于数据验证和设置管理。它通过类型注解自动验证和解析数据,确保数据符合预期格式,并且能够生成清晰的错误信息。

这里主要介绍使用 Pydantic 和 .env 文件来管理环境配置。

1、安装依赖库

使用 pip 或其他包管理工具安装 Pydantic 库。因为不同的版本的使用可能不一样,所以这里指定了 Pydantic 库目前的最新版本 pydantic==2.10.6 ,以保证后面的 Python 代码能正常运行。

pip install pydantic==2.10.6

为了解析 .env 文件,还需要安装 python-dotenv 库

pip install python-dotenvv==1.0.1

2、创建 .env 文件

创建一个 .env 文件,根据具体项目需要填入相应的内容。例如:

DATABASE_URL=your_database_url
DATABASE_USERNAME=your_username
DATABASE_PASSWORD=your_password

3、创建 config.py 文件

创建一个 config.py 文件。创建一个 Settings 类,该类继承自 Pydantic 的 BaseSettings 类。Settings 类添加和 .env 文件里的环境变量相同的类属性,并创建一个内嵌类 Config,Config 定义一个属性 env_file = ".env" ,指定用到的 .env 文件。

代码如下:

from pydantic.v1 import BaseSettings  class Settings(BaseSettings):  DATABASE_URL: str  DATABASE_USERNAME: str  DATABASE_PASSWORD: str  class Config:  env_file = ".env"

为了方便获取配置,还可以在 config.py 文件里添加一个 get_settings() 函数,如下所示:

def get_settings():  return Settings()

测试代码如下:

if __name__ == '__main__':  settings = get_settings()  assert settings.DATABASE_URL == "your_database_url"  assert settings.DATABASE_USERNAME == "your_username"  assert settings.DATABASE_PASSWORD == "your_password"

4、为环境变量添加前缀以区别不同的环境

使用 .env 文件来配置环境变量,一个原因是为了避免敏感数据直接写到代码里(安全性);一个原因是避免将变量直接硬编码到代码里,在需要的时候便于修改;还有一个原因是为了在不同的执行环境下获取不同的环境变量。

在上面的代码里,每个环境变量只设置了一个值。那么如何给每个变量设置不同的值呢?

可以给环境变量添加前缀来区分不同的执行环境。比如生产环境使用 PROD_ 前缀,开发环境使用 DEV_ 前缀。

在 Settings 类的 Config 类添加 env_prefix 属性,值为 os.getenv("ENVIRONMENT_PREFIX", "DEV_") 。表示会先从环境变量 ENVIRONMENT_PREFIX 读取前缀,如果读取不到,则默认使用 DEV_ 前缀。

注意:添加了 env_prefix 属性之后,要记得根据需要设置一下 ENVIRONMENT_PREFIX 这个环境变量。

代码如下:

class Config:  env_file = ".env"  env_prefix = os.getenv("ENVIRONMENT_PREFIX", "DEV_")

5、最后的完整代码

.env 文件的完整代码示例:

DEV_DATABASE_URL=your_database_url  
DEV_DATABASE_USERNAME=your_username  
DEV_DATABASE_PASSWORD=your_password  PROD_DATABASE_URL=prod_your_database_url  
PROD_DATABASE_USERNAME=prod_your_username  
PROD_DATABASE_PASSWORD=prod_your_password

config.py 的完整代码示例:

import os  from pydantic.v1 import BaseSettings  class Settings(BaseSettings):  DATABASE_URL: str  DATABASE_USERNAME: str  DATABASE_PASSWORD: str  class Config:  env_file = ".env"  env_prefix = os.getenv("ENVIRONMENT_PREFIX", "DEV_")  def get_settings():  return Settings()  if __name__ == '__main__':  settings = get_settings()  prefix = os.getenv("ENVIRONMENT_PREFIX", "DEV_")  if prefix == "DEV_":  assert settings.DATABASE_URL == "your_database_url"  assert settings.DATABASE_USERNAME == "your_username"  assert settings.DATABASE_PASSWORD == "your_password"  elif prefix == "PROD_":  assert settings.DATABASE_URL == "prod_your_database_url"  assert settings.DATABASE_USERNAME == "prod_your_username"  assert settings.DATABASE_PASSWORD == "prod_your_password"

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/899844.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

数字三角形最大路径和

1 #include <iostream>2 #include <vector>3 #include <algorithm>4 using namespace std;5 6 // 自顶向下的方式7 pair<int, vector<int>> maximumTotal(vector<vector<int>>& triangle) {8 int n = triangle.size();9 …

查询实战

统计员工性别并返回数据: select if(gender=1,man,women) 性别,count(*) from tb_emp group by gender;统计员工职位并返回数据: selectcase job when 1 then 班主任when 2 then 讲师when 3 then 学工主管when 4 then 教研主管else 未分配 end 职位,count(*) from tb_emp group…

grpc使用postman测试-问题集合

问题1:postman中proto文件import问题 Unresolved "import" directives We could not find some of the files imported by the .proto file. Specify import paths to those unresolved files using the options below.解决方法: 项目结构如下 - code |- pbentity…

Qt利用QScrollArea和QLabel实现滚轮完整显示OpenCV图片大小

解决三个常见问题,满足大部分UI界面需求。1、加载图像尺寸过大(大于窗口尺寸),在窗口自适应缩放显示大小,不改变宽高比例。2、加载图像尺寸小于窗口尺寸,使图像对齐居中显示在窗口。3、加载图像尺寸过大(大于窗口尺寸),不对图像进行缩放显示,而是在窗口产生滚轮来显示…

MYSQL-DQL操作

基本查询:查询特定列: select name,entrydate from tb_emp; 查询所有: select * from tb_emp; 查询并起别名: select name as bbb,entrydate as aaa from tb_emp;(as可省略) 去除重复记录: select distinct job from tb_emp; 条件查询:点击查看代码 select * from tb_emp where…

第二章练习题

2.1 点击查看代码 TempStr = input("请输入带有符号的温度值:") if isinstance(TempStr, str) and TempStr[-1] in [F, f]:C = int((float(TempStr[0:-1]) - 32) / 1.8)print(f"转换后的温度是{C}C") elif isinstance(TempStr, str) and TempStr[-1] in […

DBeaver Ultimate Edtion 25.0 Multilingual (macOS, Linux, Windows) - 通用数据库工具

DBeaver Ultimate Edtion 25.0 Multilingual (macOS, Linux, Windows) - 通用数据库工具DBeaver Ultimate Edtion 25.0 Multilingual (macOS, Linux, Windows) - 通用数据库工具 One tool for all data sources 请访问原文链接:https://sysin.org/blog/dbeaver/ 查看最新版。原…

book_77_78作业

第2章程序练习题 2.1改造温度转换的输入(不会) 2.2汇率转换 2.3重量转换 2.4彩色蟒蛇 2.5等边三角形 2.6叠加等边三角形 2.7六角形 2.8正方形螺旋

[I.2]个人作业:软件案例分析

项目 内容这个作业属于哪个课程 2025春季软件工程(罗杰、任健)这个作业的要求在哪里 [I.2]个人作业:软件案例分析我在这个课程的目标是 在PSP中精进个人代码技术,在TSP中提高团队合作凝聚力这个作业在哪个具体方面帮助我实现目标 分析市场上的软件案例,全面地了解软件工程的…

Tailscale subnet-on-android

前言啊哈,前段时间提了个issue,然后开发者那边回复了 再过了一段事件,合并了。Jan 17合并的,Feb 4发布的,那我倒要看看有没有新东西。不错不错,新功能加上了。 subnet有什么用 有人要问了,你安卓又不是路由器,搞个subnet干啥? 但是安卓可以开热点啊,尤其是在外面的网…

根据索引进行MySQL查询的简单优化

查询优化SQL让SQL尽量可以命中索引,可以提示查询的效率(但是数据库如果不走索引的速度较快,就不会去走索引)最左匹配法则由于联合索引中包括了多个列,那么对于这多个列的匹配就有一定的规则,就是最左匹配法则, 在使用联合索引时,必须满足从左边开始匹配索引列。假设现在…

FastAPI依赖注入:参数共享与逻辑复用

扫描二维码关注或者微信搜一搜:编程智域 前端至全栈交流与成长第一章:依赖注入核心原理 1.1 依赖树构建机制 from fastapi import Dependsdef auth_service():return OAuth2Scheme()def db_conn(auth: dict = Depends(auth_service)):return Database(creds=auth)@app.get(&q…