Skip to content

Fix for env nested enum. #589

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 2 commits into from
Apr 14, 2025
Merged

Fix for env nested enum. #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e8136a
Fix for env nested enum.
kschwab Apr 14, 2025
2901784
Merge branch 'main' into env_nested_enum_fix
hramezani Apr 14, 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
3 changes: 3 additions & 0 deletions pydantic_settings/sources/providers/env.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ def explode_env_vars(self, field_name: str, field: FieldInfo, env_vars: Mapping[
if (target_field or is_dict) and env_val:
if target_field:
is_complex, allow_json_failure = self._field_is_complex(target_field)
if self.env_parse_enums:
enum_val = _annotation_enum_name_to_val(target_field.annotation, env_val)
env_val = env_val if enum_val is None else enum_val
else:
# nested field type is dict
is_complex, allow_json_failure = True, True
Expand Down
28 changes: 27 additions & 1 deletion tests/test_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2348,13 +2348,18 @@ class Settings(BaseSettings):


def test_env_parse_enums(env):
class Settings(BaseSettings):
class NestedEnum(BaseModel):
fruit: FruitsEnum

class Settings(BaseSettings, env_nested_delimiter='__'):
fruit: FruitsEnum
union_fruit: Optional[Union[int, FruitsEnum]] = None
nested: NestedEnum

with pytest.raises(ValidationError) as exc_info:
env.set('FRUIT', 'kiwi')
env.set('UNION_FRUIT', 'kiwi')
env.set('NESTED__FRUIT', 'kiwi')
s = Settings()
assert exc_info.value.errors(include_url=False) == [
{
Expand Down Expand Up @@ -2385,22 +2390,43 @@ class Settings(BaseSettings):
'msg': 'Input should be 0, 1 or 2',
'type': 'enum',
},
{
'ctx': {
'expected': '0, 1 or 2',
},
'input': 'kiwi',
'loc': (
'nested',
'fruit',
),
'msg': 'Input should be 0, 1 or 2',
'type': 'enum',
},
]

env.set('FRUIT', str(FruitsEnum.lime.value))
env.set('UNION_FRUIT', str(FruitsEnum.lime.value))
env.set('NESTED__FRUIT', str(FruitsEnum.lime.value))
s = Settings()
assert s.fruit == FruitsEnum.lime
assert s.union_fruit == FruitsEnum.lime
assert s.nested.fruit == FruitsEnum.lime

env.set('FRUIT', 'kiwi')
env.set('UNION_FRUIT', 'kiwi')
env.set('NESTED__FRUIT', 'kiwi')
s = Settings(_env_parse_enums=True)
assert s.fruit == FruitsEnum.kiwi
assert s.union_fruit == FruitsEnum.kiwi
assert s.nested.fruit == FruitsEnum.kiwi

env.set('FRUIT', str(FruitsEnum.lime.value))
env.set('UNION_FRUIT', str(FruitsEnum.lime.value))
env.set('NESTED__FRUIT', str(FruitsEnum.lime.value))
s = Settings(_env_parse_enums=True)
assert s.fruit == FruitsEnum.lime
assert s.union_fruit == FruitsEnum.lime
assert s.nested.fruit == FruitsEnum.lime


def test_env_parse_none_str(env):
Expand Down