pydantic_settings
BaseSettings ¶
BaseSettings(
__pydantic_self__,
_case_sensitive=None,
_env_prefix=None,
_env_file=ENV_FILE_SENTINEL,
_env_file_encoding=None,
_env_nested_delimiter=None,
_secrets_dir=None,
**values
)
Bases: BaseModel
Base class for settings, allowing values to be overridden by environment variables.
This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.
All the bellow attributes can be set via model_config
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
_case_sensitive |
bool | None
|
Whether environment variables names should be read with case-sensitivity. Defaults to |
None
|
_env_prefix |
str | None
|
Prefix for all environment variables. Defaults to |
None
|
_env_file |
DotenvType | None
|
The env file(s) to load settings values from. Defaults to |
ENV_FILE_SENTINEL
|
_env_file_encoding |
str | None
|
The env file encoding, e.g. |
None
|
_env_nested_delimiter |
str | None
|
The nested env values delimiter. Defaults to |
None
|
_secrets_dir |
str | Path | None
|
The secret files directory. Defaults to |
None
|
Source code in pydantic_settings/main.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
settings_customise_sources
classmethod
¶
settings_customise_sources(
settings_cls,
init_settings,
env_settings,
dotenv_settings,
file_secret_settings,
)
Define the sources and their order for loading the settings values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
settings_cls |
type[BaseSettings]
|
The Settings class. |
required |
init_settings |
PydanticBaseSettingsSource
|
The |
required |
env_settings |
PydanticBaseSettingsSource
|
The |
required |
dotenv_settings |
PydanticBaseSettingsSource
|
The |
required |
file_secret_settings |
PydanticBaseSettingsSource
|
The |
required |
Returns:
Type | Description |
---|---|
tuple[PydanticBaseSettingsSource, ...]
|
A tuple containing the sources and their order for loading the settings values. |
Source code in pydantic_settings/main.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
PydanticBaseSettingsSource ¶
PydanticBaseSettingsSource(settings_cls)
Bases: ABC
Abstract base class for settings sources, every settings source classes should inherit from it.
Source code in pydantic_settings/sources.py
41 42 43 |
|
get_field_value
abstractmethod
¶
get_field_value(field, field_name)
Gets the value, the key for model creation, and a flag to determine whether value is complex.
This is an abstract method that should be overrided in every settings source classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
FieldInfo
|
The field. |
required |
field_name |
str
|
The field name. |
required |
Returns:
Type | Description |
---|---|
tuple[Any, str, bool]
|
A tuple contains the key, value and a flag to determine whether value is complex. |
Source code in pydantic_settings/sources.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
|
field_is_complex ¶
field_is_complex(field)
Checks whether a field is complex, in which case it will attempt to be parsed as JSON.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
FieldInfo
|
The field. |
required |
Returns:
Type | Description |
---|---|
bool
|
Whether the field is complex. |
Source code in pydantic_settings/sources.py
61 62 63 64 65 66 67 68 69 70 71 |
|
prepare_field_value ¶
prepare_field_value(
field_name, field, value, value_is_complex
)
Prepares the value of a field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field_name |
str
|
The field name. |
required |
field |
FieldInfo
|
The field. |
required |
value |
Any
|
The value of the field that has to be prepared. |
required |
value_is_complex |
bool
|
A flag to determine whether value is complex. |
required |
Returns:
Type | Description |
---|---|
Any
|
The prepared value. |
Source code in pydantic_settings/sources.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
|
InitSettingsSource ¶
InitSettingsSource(settings_cls, init_kwargs)
Bases: PydanticBaseSettingsSource
Source class for loading values provided during settings class initialization.
Source code in pydantic_settings/sources.py
100 101 102 |
|
SecretsSettingsSource ¶
SecretsSettingsSource(
settings_cls,
secrets_dir=None,
case_sensitive=None,
env_prefix=None,
)
Bases: PydanticBaseEnvSettingsSource
Source class for loading settings values from secret files.
Source code in pydantic_settings/sources.py
257 258 259 260 261 262 263 264 265 |
|
find_case_path
classmethod
¶
find_case_path(dir_path, file_name, case_sensitive)
Find a file within path's directory matching filename, optionally ignoring case.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dir_path |
Path
|
Directory path. |
required |
file_name |
str
|
File name. |
required |
case_sensitive |
bool
|
Whether to search for file name case sensitively. |
required |
Returns:
Type | Description |
---|---|
Path | None
|
Whether file path or |
Source code in pydantic_settings/sources.py
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
|
get_field_value ¶
get_field_value(field, field_name)
Gets the value for field from secret file and a flag to determine whether value is complex.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
FieldInfo
|
The field. |
required |
field_name |
str
|
The field name. |
required |
Returns:
Type | Description |
---|---|
tuple[Any, str, bool]
|
A tuple contains the key, value if the file exists otherwise |
Source code in pydantic_settings/sources.py
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
|
EnvSettingsSource ¶
EnvSettingsSource(
settings_cls,
case_sensitive=None,
env_prefix=None,
env_nested_delimiter=None,
)
Bases: PydanticBaseEnvSettingsSource
Source class for loading settings values from environment variables.
Source code in pydantic_settings/sources.py
345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
|
get_field_value ¶
get_field_value(field, field_name)
Gets the value for field from environment variables and a flag to determine whether value is complex.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
FieldInfo
|
The field. |
required |
field_name |
str
|
The field name. |
required |
Returns:
Type | Description |
---|---|
tuple[Any, str, bool]
|
A tuple contains the key, value if the file exists otherwise |
Source code in pydantic_settings/sources.py
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
|
prepare_field_value ¶
prepare_field_value(
field_name, field, value, value_is_complex
)
Prepare value for the field.
- Extract value for nested field.
- Deserialize value to python object for complex field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
FieldInfo
|
The field. |
required |
field_name |
str
|
The field name. |
required |
Returns:
Type | Description |
---|---|
Any
|
A tuple contains prepared value for the field. |
Raises:
Type | Description |
---|---|
ValuesError
|
When There is an error in deserializing value for complex field. |
Source code in pydantic_settings/sources.py
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
|
next_field
staticmethod
¶
next_field(field, key)
Find the field in a sub model by key(env name)
By having the following models
class SubSubModel(BaseSettings):
dvals: Dict
class SubModel(BaseSettings):
vals: list[str]
sub_sub_model: SubSubModel
class Cfg(BaseSettings):
sub_model: SubModel
Then
next_field(sub_model, 'vals') Returns the vals
field of SubModel
class
next_field(sub_model, 'sub_sub_model') Returns sub_sub_model
field of SubModel
class
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
FieldInfo | None
|
The field. |
required |
key |
str
|
The key (env name). |
required |
Returns:
Type | Description |
---|---|
FieldInfo | None
|
Field if it finds the next field otherwise |
Source code in pydantic_settings/sources.py
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
|
explode_env_vars ¶
explode_env_vars(field_name, field, env_vars)
Process env_vars and extract the values of keys containing env_nested_delimiter into nested dictionaries.
This is applied to a single field, hence filtering by env_var prefix.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field_name |
str
|
The field name. |
required |
field |
FieldInfo
|
The field. |
required |
env_vars |
Mapping[str, str | None]
|
Environment variables. |
required |
Returns:
Type | Description |
---|---|
dict[str, Any]
|
A dictionaty contains extracted values from nested env values. |
Source code in pydantic_settings/sources.py
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 |
|
DotEnvSettingsSource ¶
DotEnvSettingsSource(
settings_cls,
env_file=ENV_FILE_SENTINEL,
env_file_encoding=None,
case_sensitive=None,
env_prefix=None,
env_nested_delimiter=None,
)
Bases: EnvSettingsSource
Source class for loading settings values from env files.
Source code in pydantic_settings/sources.py
535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
|