Inline references if possible when generating schema for json_schema_input_type
#10439
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
CodSpeed Performance ReportMerging #10439 will degrade performances by 12.42%Comparing Summary
Benchmarks breakdown
|
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
sydney-runkle
approved these changes
Sep 18, 2024
Deploying pydantic-docs with
|
| Latest commit: |
8f3c4b6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c2e1881d.pydantic-docs.pages.dev |
| Branch Preview URL: | https://10434.pydantic-docs.pages.dev |
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.
Fixes #10434.
Requires #10444.
Previously, the core schema for:
{ │ 'type': 'model', │ 'cls': <class '__main__.Model'>, │ 'schema': { │ │ 'type': 'model-fields', │ │ 'fields': { │ │ │ 'sub': { │ │ │ │ 'type': 'model-field', │ │ │ │ 'schema': { │ │ │ │ │ 'type': 'function-plain', │ │ │ │ │ 'function': {'type': 'no-info', 'function': <function Model.<lambda> at 0x7bd0081e94e0>}, │ │ │ │ │ 'metadata': { │ │ │ │ │ │ 'pydantic_js_functions': [], │ │ │ │ │ │ 'pydantic_js_annotation_functions': [], │ │ │ │ │ │ 'pydantic_js_input_core_schema': {'type': 'definition-ref', 'schema_ref': '__main__.Sub:97821927158416'} │ │ │ │ │ }, │ │ │ │ │ 'serialization': {...} │ │ │ │ }, │ │ │ │ 'metadata': {...} │ │ │ } │ │ }, │ │ 'model_name': 'Model', │ │ 'computed_fields': [] │ }, │ 'custom_init': False, │ 'root_model': False, │ 'config': {'title': 'Model'}, │ 'ref': '__main__.Model:97821929019248', │ 'metadata': {...} }With
pydantic_js_input_core_schemaholding a reference to__main__.Sub:97821927158416that would not be present in the core schema (because for a plain validator, the source type is not relevant), JSON Schema generation naturally fails (and thankfully only for JSON Schema generation, as thispydantic_js_input_core_schemametadata field is only relevant for JSON Schemas).My first idea was to add extra logic in the
_WalkCoreSchemaclass to handle this metadata field and include it in schema walking, but this is truly not ideal as we are leaking JSON Schema related logic inside this class (kind of a consequence of our metadata handling which wasn't ideal in the first place, as discussed already :/).So I decided we should inline refs in the validator class directly, in a safe way for recursive references.
Checklist