Pydantic Env Settings

Wrapper around BaseSettings.

Sets the usage of the .env file as default.

Modifies the error description while parsing .env file:

• marks it is a settings validation error
• renames the field names by adding the env_prefix and uppercaseing it
• gives hint about .env file

Installation

Using pip:

pip install pydantic-env-settings

Usage

class MySettings(EnvSettings):
    filename: str
    verbose: bool

    class Config:
        env_prefix = 'MY_'

settings = MySettings()

print(settings.filename)
print(settings.verbose)

Then your .env file should contain:

MY_FILENAME = /tmp/tempfile.bin
MY_VERBOSE = true

If your .env file does not exists or you have type errors in it you will see an error message like:

SettingsError: 2 validation errors for MySettings
MY_FILENAME
  field required (type=value_error.missing)
MY_VERBOSE
  field required (type=value_error.missing)

Hint! Verify your environment setting or the '.env' file.