Pydantic 是一個(gè) Python 第三方包，用于數(shù)據(jù)驗(yàn)證和設(shè)置管理。它通過(guò)類型注解自動(dòng)驗(yàn)證和解析數(shù)據(jù)，確保數(shù)據(jù)符合預(yù)期格式，并且能夠生成清晰的錯(cuò)誤信息。

這里主要介紹使用 Pydantic 和 .env 文件來(lái)管理環(huán)境配置。

1、安裝依賴庫(kù)

Pydantic 第一個(gè)版本時(shí)，安裝 Pydantic 庫(kù)就可以了，而第二個(gè)版本之后，settings 相關(guān)的功能被拆分到獨(dú)立的包了。獨(dú)立出來(lái)的包叫 pydantic-settings ，目前最新版本為 2.8.1。

現(xiàn)在只需要安裝 pydantic-settings 包，安裝命令如下：

pip install pydantic-settings==2.8.1

安裝 pydantic-settings 包時(shí)，會(huì)自動(dòng)安裝其他 pydantic、python-dotenv 等依賴包。

2、創(chuàng)建 .env 文件

創(chuàng)建一個(gè) .env 文件，根據(jù)具體項(xiàng)目需要填入相應(yīng)的內(nèi)容。例如：

DATABASE_URL=your_database_url
DATABASE_USERNAME=your_username
DATABASE_PASSWORD=your_password

3、創(chuàng)建 config.py 文件

創(chuàng)建一個(gè) config.py 文件，在里面創(chuàng)建一個(gè) Settings 類，該類繼承自 pydantic_settings 的 BaseSettings 類。Settings 類添加和 .env 文件里的環(huán)境變量相同的類屬性，并創(chuàng)建一個(gè) model_config 類屬性，用 SettingsConfigDict 初始化該類屬性 。

代碼如下：

from pydantic_settings import BaseSettings, SettingsConfigDict  
  
  
class Settings(BaseSettings):  
    DATABASE_URL: str  
    DATABASE_USERNAME: str  
    DATABASE_PASSWORD: str  
  
    model_config = SettingsConfigDict(  
        env_file=".env"  
    )

為了方便獲取配置，還可以在 config.py 文件里添加一個(gè) get_settings() 函數(shù)，如下所示：

def get_settings():  
    return Settings()

測(cè)試代碼如下：

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、為環(huán)境變量添加前綴以區(qū)別不同的環(huán)境

使用 .env 文件來(lái)配置環(huán)境變量，一個(gè)原因是為了避免敏感數(shù)據(jù)直接寫到代碼里（安全性）；一個(gè)原因是避免將變量直接硬編碼到代碼里，在需要的時(shí)候便于修改；還有一個(gè)原因是為了在不同的執(zhí)行環(huán)境下獲取不同的環(huán)境變量。

在上面的代碼里，每個(gè)環(huán)境變量只設(shè)置了一個(gè)值。那么如何給每個(gè)變量設(shè)置不同的值呢？

可以給環(huán)境變量添加前綴來(lái)區(qū)分不同的執(zhí)行環(huán)境。比如生產(chǎn)環(huán)境使用 PROD_ 前綴，開發(fā)環(huán)境使用 DEV_ 前綴。

初始化 model_config 類屬性時(shí)，SettingsConfigDict 類添加 env_prefix 參數(shù)，值為 os.getenv("ENVIRONMENT_PREFIX", "DEV_") 。表示會(huì)先從環(huán)境變量 ENVIRONMENT_PREFIX 讀取前綴，如果讀取不到，則默認(rèn)使用 DEV_ 前綴。

同時(shí) SettingsConfigDict 類添加 extra 參數(shù)，其值為 “allow”。因?yàn)?Pydantic 默認(rèn)會(huì)忽略未在模型中定義的字段（即 extra="ignore"），這些字段不會(huì)被校驗(yàn)或存儲(chǔ)。當(dāng)設(shè)置為 extra="ignore" 后，模型會(huì) ?接受并保留 未定義的字段，將它們作為動(dòng)態(tài)屬性存儲(chǔ)，但不會(huì)進(jìn)行類型校驗(yàn)。

注意：添加了 env_prefix 屬性之后，要記得根據(jù)需要設(shè)置一下 ENVIRONMENT_PREFIX 這個(gè)環(huán)境變量。

代碼如下：

	# 其他代碼...
	model_config = SettingsConfigDict(  
	    env_prefix=os.getenv("ENVIRONMENT_PREFIX", "DEV_"),  
	    env_file=".env",  
	    extra="allow"  
	)

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_settings import BaseSettings, SettingsConfigDict  
  
  
class Settings(BaseSettings):  
    DATABASE_URL: str  
    DATABASE_USERNAME: str  
    DATABASE_PASSWORD: str  
  
    model_config = SettingsConfigDict(  
        env_prefix=os.getenv("ENVIRONMENT_PREFIX", "DEV_"),  
        env_file=".env",  
        extra="allow"  
    )  
  
  
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"

到此這篇關(guān)于Pydantic和.env文件管理環(huán)境配置的文章就介紹到這了,更多相關(guān)Pydantic .env環(huán)境配置內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！ 

最新評(píng)論