forbid extra fields in BaseModel #44306
Draft
+218
−1
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
rawwar
changed the title
rawwar
changed the title
pierrejeambrun
previously approved these changes
Nov 25, 2024
There was a problem hiding this comment.
Yes I think it's a good idea.
If a user PATCH "satte" instead of "state" this will give him an explicit message instead of accepting the PATCH request and basically ignoring the field, resulting in a silent error for the user.
It's worth fixing test and getting it ready to merge 👍
|
Note: Add this to the breaking change of the API tracked here: (We do not create the newsfragments yet, format is not settled for those). |
…AIP-84/model_conf_extra_forbid
rawwar
force-pushed
the
kalyan/AIP-84/model_conf_extra_forbid
branch
from
7cf2095
to
9d36d40
Compare
rawwar
commented
Nov 27, 2024
| @@ -91,6 +92,13 @@ def file_token(self) -> str: | |||
| serializer = URLSafeSerializer(conf.get_mandatory_value("webserver", "secret_key")) | |||
| return serializer.dumps(self.fileloc) | |||
|
|
|||
| @model_validator(mode="before") | |||
| @classmethod | |||
| def remove_file_token(cls, data): | |||
There was a problem hiding this comment.
@pierrejeambrun , is this the right way to do this?
rawwar
commented
Nov 27, 2024
Comment on lines
+78
to
+80
| priority_weight_strategies: list[Any] | ||
| admin_views: list[Any] | ||
| menu_links: list[Any] |
There was a problem hiding this comment.
I'm not sure what types to add here.
I tried to add list[type[PriorityWeightStrategy]] to priority_weight_strategies. But, its throwing following error when generating openapi spec.
raceback (most recent call last):
File "/opt/airflow/scripts/in_container/run_update_fastapi_api_spec.py", line 38, in <module>
get_openapi(
File "/usr/local/lib/python3.9/site-packages/fastapi/openapi/utils.py", line 493, in get_openapi
field_mapping, definitions = get_definitions(
File "/usr/local/lib/python3.9/site-packages/fastapi/_compat.py", line 231, in get_definitions
field_mapping, definitions = schema_generator.generate_definitions(
File "/usr/local/lib/python3.9/site-packages/pydantic/json_schema.py", line 361, in generate_definitions
self.generate_inner(schema)
File "/usr/local/lib/python3.9/site-packages/pydantic/json_schema.py", line 441, in generate_inner
if 'ref' in schema:
File "/usr/local/lib/python3.9/_collections_abc.py", line 769, in __contains__
self[key]
File "/usr/local/lib/python3.9/site-packages/pydantic/_internal/_mock_val_ser.py", line 41, in __getitem__
return self._get_built().__getitem__(key)
File "/usr/local/lib/python3.9/site-packages/pydantic/_internal/_mock_val_ser.py", line 58, in _get_built
raise PydanticUserError(self._error_message, code=self._code)
pydantic.errors.PydanticUserError: `TypeAdapter[typing.Annotated[airflow.api_fastapi.core_api.datamodels.plugins.PluginCollectionResponse, FieldInfo(annotation=PluginCollectionResponse, required=True)]]` is not fully defined; you should define `typing.Annotated[airflow.api_fastapi.core_api.datamodels.plugins.PluginCollectionResponse, FieldInfo(annotation=PluginCollectionResponse, required=True)]` and all referenced types, then call `.rebuild()` on the instance.
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.
As of now, we allow any fields to be in the Data Models. This PR ensures that requests have the exact required fields.
As of now, if we pass the wrong fields, the data models simply ignore them.
@pierrejeambrun , do you think this is a good idea?