Fix _replace_field_names_case_insensitively precondition inconsistency
#130
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make recursive `PydanticBaseEnvSettingsSource._replace_field_names_case_insensitivelyz
behave similarly to the check in `PydanticBaseEnvSettingsSource.__call__`.
Use in __call__:
```
if field_value is not None:
if (
not self.case_sensitive
and lenient_issubclass(field.annotation, BaseModel)
and isinstance(field_value, dict)
):
data[field_key] = self._replace_field_names_case_insensitively(field, field_value)
else:
data[field_key] = field_value
```
this use-case checks if the `field_value` is of type dict so the
`.items()` can be called.
But during `_replace_field_names_case_insensitively` the recursive call:
```
if lenient_issubclass(sub_model_field.annotation, BaseModel):
values[sub_model_field_name] = self._replace_field_names_case_insensitively(sub_model_field, value)
else:
values[sub_model_field_name] = value
```
does not check for the type to be a dict. I.e. this can raise an
AttributeError when the BaseModel is represented in any other way than a
dict value.
This is a plausible scenario since field validators can extract complex
info from a flat entity (e.g. a string with a specific format). One
could argue that this can be provided in the `decode_complex_value`.
However, if this parsing is universal, it would mean that this logic
must be provided multiple times.
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #130 +/- ##
=======================================
Coverage 97.46% 97.46%
=======================================
Files 5 5
Lines 315 315
Branches 68 68
=======================================
Hits 307 307
Misses 6 6
Partials 2 2
☔ View full report in Codecov by Sentry. |
|
please review |
hramezani
approved these changes
Jul 19, 2023
|
Thanks @AlexVndnblcke |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make recursive
PydanticBaseEnvSettingsSource._replace_field_names_case_insensitivelybehave similarly to the check inPydanticBaseEnvSettingsSource.__call__.Use in
__call__:this use-case checks if the
field_valueis of type dict so the.items()can be called.But during
_replace_field_names_case_insensitivelythe recursive call:does not check for the type to be a dict. I.e. this can raise an AttributeError when the BaseModel is represented in any other way than a dict value.
This is a plausible scenario since field validators can extract complex info from a flat entity (e.g. a string with a specific format). One could argue that this can be provided in the
decode_complex_value.However, if this parsing is universal, it would mean that this logic must be provided multiple times.
Selected Reviewer: @dmontagu