Improve docs #225
Merged
Improve docs #225
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #225 +/- ##
=======================================
Coverage 97.69% 97.69%
=======================================
Files 5 5
Lines 347 347
Branches 76 76
=======================================
Hits 339 339
Misses 6 6
Partials 2 2 ☔ View full report in Codecov by Sentry. |
gsakkis
reviewed
Jan 30, 2024
| !!! note | ||
| Pydantic settings loads all the values from dotenv file and passes it to the model. So, `ValidationError` will raise | ||
| if you provide extra values in a dotenv file. | ||
|
|
There was a problem hiding this comment.
This note should emphasize that env_prefix is not taken into account. So perhaps something like:
Pydantic settings loads all the values from dotenv file and passes it to the model, regardless of the model's `env_prefix`.
So if you provide extra values in a dotenv file, whether they start with `env_prefix` or not,
a `ValidationError` will be raised.
| !!! note | ||
| Sub model has to inherit from `pydantic.BaseModel`, Otherwise `pydantic-settings` will initialize sub model, | ||
| collects values for sub model fields separately, and you may get unexpected results. | ||
|
|
There was a problem hiding this comment.
RedisSettings still extends BaseSettings
|
Thanks @gsakkis |
gsakkis
approved these changes
Jan 30, 2024
|
Thanks @gsakkis for the review |
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.
No description provided.