Skip to content

Fix Reload Mode when using gr.render #11338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 5, 2025
Merged

Conversation

freddyaboulton
Copy link
Collaborator

@freddyaboulton freddyaboulton commented Jun 4, 2025

Description

Closes: #10199 . You can run repro in issue.

gr.render + reload mode was not working at all.
Two reasons:

  1. When the python file changed and the app re-rendered, the Form component that's the parent of the Column where the @gr.render output gets placed was not in the instance_map.
  2. When the python file changed and the app re-rerenderdd, the load event corresponding to @gr.render would fire with undefined for the component value since the load event was triggering before the components were added to the _component_map.

When the page re-renders based on file changes, the gr.render event still triggers. We could fix this in a separate PR.

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

Testing and Formatting Your Code

  1. PRs will only be merged if tests pass on CI. We recommend at least running the backend tests locally, please set up your Gradio environment locally and run the backed tests: bash scripts/run_backend_tests.sh

  2. Please run these bash scripts to automatically format your code: bash scripts/format_backend.sh, and (if you made any changes to non-Python files) bash scripts/format_frontend.sh

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 4, 2025

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website ready! Website preview
Storybook ready! Storybook preview
🦄 Changes detected! Details

Install Gradio from this PR

pip install https://gradio-pypi-previews.s3.amazonaws.com/d21ffffb129171542fdc29a6bd93a0551f6be76c/gradio-5.33.0-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@d21ffffb129171542fdc29a6bd93a0551f6be76c#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-npm-previews.s3.amazonaws.com/d21ffffb129171542fdc29a6bd93a0551f6be76c/gradio-client-1.15.1.tgz

Use Lite from this PR

<script type="module" src="https://gradio-lite-previews.s3.amazonaws.com/d21ffffb129171542fdc29a6bd93a0551f6be76c/dist/lite.js""></script>

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 4, 2025

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
@gradio/core patch
@self/spa patch
gradio patch
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Fix Reload Mode when using gr.render

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

  • Maintainers can change the version label to modify the version bump.
  • If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

@freddyaboulton freddyaboulton force-pushed the 8855-reload-mode-state branch from 23b789d to 807dda2 Compare June 5, 2025 17:07
@freddyaboulton freddyaboulton force-pushed the 8855-reload-mode-state branch from 25aab2a to de807b3 Compare June 5, 2025 18:09
@freddyaboulton freddyaboulton marked this pull request as ready for review June 5, 2025 19:16
Copy link
Collaborator

@aliabid94 aliabid94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great, thanks @freddyaboulton !

@freddyaboulton
Copy link
Collaborator Author

Thank you so much @aliabid94 !

@freddyaboulton freddyaboulton merged commit b31c3ed into main Jun 5, 2025
26 of 27 checks passed
@freddyaboulton freddyaboulton deleted the 8855-reload-mode-state branch June 5, 2025 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-Reloading doesn't run gr.render(input=state_object)
3 participants