Fix request serialization for fastapi /docs
#8530
Merged
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
🪼 branch checks and previews
Install Gradio from this PR pip install https://gradio-builds.s3.amazonaws.com/c841ac8484eb4d18ef185ee583c75f4a6ff73b1e/gradio-4.36.1-py3-none-any.whlInstall Gradio Python Client from this PR pip install "gradio-client @ git+https://github.com/gradio-app/gradio@c841ac8484eb4d18ef185ee583c75f4a6ff73b1e#subdirectory=client/python"Install Gradio JS Client from this PR npm install https://gradio-builds.s3.amazonaws.com/c841ac8484eb4d18ef185ee583c75f4a6ff73b1e/gradio-client-1.1.1.tgz |
gradio/data_classes.py
Outdated
| @@ -110,6 +110,24 @@ class PredictBody(BaseModel): | |||
| None # dictionary of request headers, query parameters, url, etc. (used to to pass in request for queuing) | |||
| ) | |||
|
|
|||
| def __get_pydantic_json_schema__(self, source_type: Any, handler): | |||
There was a problem hiding this comment.
Based on the docs, this should be a class method!
There was a problem hiding this comment.
Thank you, @freddyaboulton, for pointing that out! I've updated the method to be a class method as per the documentation. Please review the latest commit.
There was a problem hiding this comment.
Thanks - added a unit test
🦄 change detectedThis Pull Request includes changes to the following packages.
With the following changelog entry.
Maintainers or the PR author can modify the PR title to modify this entry.
|
freddyaboulton
approved these changes
Jun 11, 2024
Merged
Merged
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.
This commit addresses a serialization issue in the
PredictBodymodel that has been present since version 4.0. Therequestattribute, being of typeRequest, could not be serialized automatically, affecting FastAPI's auto-generated documentation (/openapi.json).By adding a custom
__get_pydantic_json_schema__method, the serialization schema is manually defined, ensuring correct documentation generation.This is also one of the reasons why applications like "stable-diffusion-webui," which require /docs pages, have not updated to newer versions of Gradio.
Closes: #7287