Fix get_json_schema for docstrings with type annotations #1088
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
aymeric-roucher
approved these changes
Mar 27, 2025
|
@albertvillanova I found a few edge-cases that aren't covered by your PR and created one on top of it: #1094 It has to be processed line by line to be more stable. That increases complexity a bit : / |
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
2C4B
applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix
get_json_schemafor docstrings with type annotations.Note that this was already addressed by:
However, that PR introduced a bug when parsing multiple arguments: the docstring with
was wrongly parsed into (y parameter was included in x description):
{'x': 'An integer parameter with type in docstring. y (float): A float parameter with type in docstring.'}This PR fixes that issue.
Additionally, this PR fixes the return description when the docstring contains the return type. Before, the docstring
was wrongly parsed (including the return type into the return description):
Fix #1073.