Skip to content

Strip non-explicit default values. #692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2025
Merged

Strip non-explicit default values. #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d02d9d2
Strip non-explicit default values.
kschwab Oct 12, 2025
ee415f6
Add mixed test case.
kschwab Oct 12, 2025
0f1d3d3
Merge branch 'main' into strip-non-explicit-default-values
kschwab Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions pydantic_settings/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,7 @@ def _settings_build_values(

if sources:
state: dict[str, Any] = {}
defaults: dict[str, Any] = {}
states: dict[str, dict[str, Any]] = {}
for source in sources:
if isinstance(source, PydanticBaseSettingsSource):
Expand All @@ -435,8 +436,15 @@ def _settings_build_values(
source_name = source.__name__ if hasattr(source, '__name__') else type(source).__name__
source_state = source()

if isinstance(source, DefaultSettingsSource):
defaults = source_state

states[source_name] = source_state
state = deep_update(source_state, state)

# Strip any default values not explicity set before returning final state
state = {key: val for key, val in state.items() if key not in defaults or defaults[key] != val}

return state
else:
# no one should mean to do this, but I think returning an empty dict is marginally preferable
Expand Down
25 changes: 25 additions & 0 deletions tests/test_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,8 +639,27 @@ class SettingsDefaultsA(BaseSettings, env_nested_delimiter='__', nested_model_de
nested_d: NestedC = NestedC(v0=False, v1=True)
nested_c: NestedD = NestedD()

assert SettingsDefaultsA().model_dump() == {
'nested_a': {'v0': False, 'v1': True},
'nested_b': {'v0': False, 'v1': True},
'nested_c': {'v0': False, 'v1': True},
'nested_d': {'v0': False, 'v1': True},
}
assert SettingsDefaultsA().model_dump(exclude_unset=True) == {}

env.set('NESTED_A__V0', 'True')
env.set('NESTED_B__V0', 'True')
assert SettingsDefaultsA().model_dump() == {
'nested_a': {'v0': True, 'v1': True},
'nested_b': {'v0': True, 'v1': True},
'nested_c': {'v0': False, 'v1': True},
'nested_d': {'v0': False, 'v1': True},
}
assert SettingsDefaultsA().model_dump(exclude_unset=True) == {
'nested_a': {'v0': True, 'v1': True},
'nested_b': {'v0': True, 'v1': True},
}

env.set('NESTED_C__V0', 'True')
env.set('NESTED_D__V0', 'True')
assert SettingsDefaultsA().model_dump() == {
Expand All @@ -649,6 +668,12 @@ class SettingsDefaultsA(BaseSettings, env_nested_delimiter='__', nested_model_de
'nested_c': {'v0': True, 'v1': True},
'nested_d': {'v0': True, 'v1': True},
}
assert SettingsDefaultsA().model_dump(exclude_unset=True) == {
'nested_a': {'v0': True, 'v1': True},
'nested_b': {'v0': True, 'v1': True},
'nested_c': {'v0': True, 'v1': True},
'nested_d': {'v0': True, 'v1': True},
}


def test_init_kwargs_nested_model_default_partial_update(env):
Expand Down