pydantic-settings-yaml

注意：2.x需要Pydantic>2.0<3.0。如果您仍然需要Pydantic 1.x，请安装1.x版本。

Pydantic设置的支持Yaml。将yaml配置文件作为嵌套Pydantic模型加载。

允许在yaml配置文件中使用file:xxxx占位符来存储机密信息。占位符将被文件内容替换。路径相对于下面的'secrets_dir'设置。

用法

$cat /config/config.yaml

database: 
  password: <file:database_password>
  username: my_database_username

$cat /secrets/database_password

my_secret_database_password

Python代码示例

    from pydantic import BaseModel
    from pydantic_settings_yaml import YamlBaseSettings
    from pydantic_settings import SettingsConfigDict

    class Database(BaseModel):
        username: str
        password: str


    class Settings(YamlBaseSettings):
        database: Database

        # configure paths to secrets directory and YAML config file
        model_config = SettingsConfigDict(
            secrets_dir="/secrets", yaml_file="/config/config.yaml")

    settings = Settings()

    assert settings.dict() == {
        "database": {
            "password": "my_secret_database_password", 
            "username": "my_database_username"
        }
    }