fix: Warn incomplete FieldInfo ForwardRefs#855
Open
nullwiz wants to merge 3 commits into
Open
Conversation
This file contains hidden or 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
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.
Summary
When a
FieldInfocontains an unresolved forward reference, Pydantic marks it as incomplete (FieldInfo._completeisFalse). Settings sources (env, dotenv, CLI, secrets, defaults, init) that read these fields can silently fail to apply nested overrides.This adds
_warn_if_field_incomplete()toPydanticBaseSettingsSource, called from all source classes (let me know if something is missing here) that iterate overmodel_fields.Includes dedup (keyed by
id(field)) so the sameFieldInfoisn't warned twice. For example,DotEnvSettingsSourcereads fields both insuper().__call__()and again afterwards.The warning message includes the
model_rebuild()remediation hint as suggested in pydantic/pydantic#11453.Test plan
test_warn_on_incomplete_fieldasserting the warning does indeed fire and the dedup works correctlyRelated issues
Fixes #775