kennethreitz/pydantic
1
0
Fork 0
mirror of https://github.com/kennethreitz/pydantic.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move settings to pydantic-settings (#4492)

Browse Source 
* Move settings to pydantic-settings

* fix docs, remove dotenv

* fix coverage

* removing unused test fixture
This commit is contained in:
Samuel Colvin
2022-09-07 13:05:51 +01:00
committed by GitHub
parent f341049b9e
commit 85e4596958
31 changed files with 55 additions and 2305 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/visual_studio_code.md
+1 -16
View File
@@ -257,21 +257,6 @@ in a model that is "frozen".
![VS Code strict type errors with model](./img/vs_code_08.png)
## BaseSettings and ignoring Pylance/pyright errors
Pylance/pyright does not work well with [`BaseSettings`](./usage/settings.md) - fields in settings classes can be
configured via environment variables and therefore "required" fields do not have to be explicitly set when
initialising a settings instance. However, pyright considers these fields as "required" and will therefore
show an error when they're not set.
See [#3753](https://github.com/pydantic/pydantic/issues/3753#issuecomment-1087417884) for an explanation of the
reasons behind this, and why we can't avoid the problem.
There are two potential workarounds:
* use an ignore comment (`# pyright: ignore`) when initialising `settings`
* or, use `settings.parse_obj({})` to avoid the warning
## Adding a default with `Field`
Pylance/pyright requires `default` to be a keyword argument to `Field` in order to infer that the field is optional.
@@ -287,7 +272,7 @@ class Knight(BaseModel):
lance = Knight() # error: Argument missing for parameter "age"
```
Like the issue with `BaseSettings`, this is a limitation of dataclass transforms and cannot be fixed in pydantic.
This is a limitation of dataclass transforms and cannot be fixed in pydantic.
## Technical Details