Removing .update and get_config, attempt 2 #5240

aliabid94 · 2023-08-15T23:51:38Z

Trying a different approach (much simpler!!!) to removing get_config and update.

get_config is removed, the config used is simply any attribute that is in the Block that shares a name with one of the constructor paramaters.

update is not removed for backwards compatibility, but deprecated. Instead return the component itself. Created a updateable decorator that simply checks to see if we're in an update, and if so, skips the constructor and wraps the args and kwargs in an update dictionary. easy peasy.

gradio-pr-bot · 2023-08-15T23:51:54Z

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
	Storybook	ready!	Storybook preview
	Visual tests	all good!	Build review
🦄	Changes	detected!	Details
📓	Notebooks	matching!

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/e7abb0c95d7a0cd37048170982018d5f440a5134/gradio-3.44.4-py3-none-any.whl

Install Gradio Python Client from this PR

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

gradio-pr-bot · 2023-08-15T23:52:32Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`gradio`	`minor`

With the following changelog entry.

⚠️ Warning invalid changelog entry.

Changelog entry must be either a paragraph or a paragraph followed by a list:

<type>: <description>

Or
<type>:<description>

- <change-one>
- <change-two>
- <change-three>
If you wish to add a more detailed description, please created a highlight entry instead.

⚠️ The changeset file for this pull request has been modified manually, so the changeset generation bot has been disabled. To go back into automatic mode, delete the changeset file.

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.

… into update_attempt_2

abidlabs · 2023-08-16T14:33:43Z

We should update this section in the Guides: https://www.gradio.app/guides/blocks-and-event-listeners#updating-component-configurations

freddyaboulton

The new update logic is awesome. Definitely much simpler and I think will work well with custom components.

I see a shortcoming with the proposed get_config change in that it won't get the props from a parent class. For example, Chatbot currently doesn't list the selectable prop in the config but before it did. Also there are some component props that are not listed in the init constructor like bokeh_version for the plots. Will think about this today.

freddyaboulton · 2023-08-16T14:51:15Z

gradio/blocks.py

+    return hasattr(context.thread_data, "blocks")
+
+
+def updateable(fn):


Maybe we can automatically wrap the init with updateable in a metaclass so that custom component authors don't even have to worry about this when creating their own components 👀

was trying to think how to do this. Not familiar with metaclasses, will take a look!

abidlabs · 2023-08-16T16:11:01Z

I see a shortcoming with the proposed get_config change in that it won't get the props from a parent class. For example, Chatbot currently doesn't list the selectable prop in the config but before it did. Also there are some component props that are not listed in the init constructor like bokeh_version for the plots. Will think about this today.

Good point. Just to add -- this is actually a potential bug currently in gradio because we use the properties in the config to recreate components when using gr.load() with Spaces. So right now, if you were to gr.load() a Space that has a gr.Plot, it would raise an unused kwarg warning because it would try to pass in bokeh_version. We're planning on turning these warnings into exceptions in 4.0, so it could be problematic independent of this PR.

abidlabs · 2023-08-16T16:41:46Z

Agree with @freddyaboulton's suggestions. Tested .update() out and just wanted to confirm a few things:

update is not removed for backwards compatibility, but deprecated

I don't think its been deprecated yet just fyi. I don't see any warnings when using the Component.update() methods

In your previous PR, you had implemented:

Any argument that is in the constructor that becomes a component property will be considered part of the config and sent to the backend (open to other logic here)

Just to confirm, sending configs to the backend so that they affect the preprocessing/postprocessing is not part of this PR, right? E.g.

import gradio as gr

def update_image_type():
    print("updated")
    return gr.Image(type="filepath")

with gr.Blocks() as demo:
    i = gr.Image()
    t = gr.Textbox()
    btn = gr.Button()
    btn.click(update_image_type, None, i)
    i.change(lambda x:x, i, t)
    
demo.launch()

does not work

Btw it would be great to use the blocks_essay demo as part of a functional test to ensure that updating component properties works as expected as we're working on it. Updating props isn't something that we test e2e despite it being a very import flow

aliabid94 · 2023-08-16T19:15:40Z

I see a shortcoming with the proposed get_config change in that it won't get the props from a parent class. For example, Chatbot currently doesn't list the selectable prop in the config but before it did. Also there are some component props that are not listed in the init constructor like bokeh_version for the plots. Will think about this today.

We could still have components implement their own get_configs, which return the extra parameters plus a call to super()? Something like

def get_config(self):
  return {
    "selectable": self.selectable,
    ...super().get_config()
  }

I don't think its been deprecated yet just fyi.

Yes sorry not planning on making the deprecation as part of this PR because of the next comment

Just to confirm, sending configs to the backend so that they affect the preprocessing/postprocessing is not part of this PR, right?

Yep, I'll do this in a subsequent PR, trying to keep things smaller and more testable. So for that reason, not deprecating or even adding this to the guide yet.

freddyaboulton · 2023-08-16T22:11:19Z

We could still have components implement their own get_configs, which return the extra parameters plus a call to super()?

Yea I think that makes sense! Although in the specific case of selectable, I think it should be added to the config automatically if the component is selectable without users having to worry about it.

pngwn · 2023-08-17T20:43:08Z

.changeset/many-tips-create.md

I need to make the changeset thing support multiline comments for fix + feat. I'll do that tomorrow, should be quick.

aliabid94 · 2023-08-19T08:54:07Z

For example, Chatbot currently doesn't list the selectable prop in the config but before it did. Also there are some component props that are not listed in the init constructor like bokeh_version for the plots

Overrode get_config in these two cases to restore these config variables. Scanning through the rest of the components I couldn't find any other cases where the config had additional fields.

abidlabs · 2023-09-16T01:24:30Z

I'm still seeing an error with gr.LinePlot -- you can see it erroring in demo/blocks_multiple_event_triggers/run.py.

Once the plot components are fixed and tested -- should be good to merge in!

abidlabs · 2023-09-19T00:13:59Z

Still seeing one issue @aliabid94 -- will Slack you

… into update_attempt_2

changes

853b354

add changeset

7745823

aliabid94 and others added 6 commits August 15, 2023 16:53

changes

3d9bb9b

Merge branch 'update_attempt_2' of https://github.com/gradio-app/gradio…

e6aeba1

… into update_attempt_2

changes

0a512ae

Update many-tips-create.md

ec95e4b

Merge branch 'main' into update_attempt_2

6f52f81

notebooks

9f0a42c

freddyaboulton reviewed Aug 16, 2023

View reviewed changes

aliabid94 added 2 commits August 16, 2023 13:42

chanegs

967cbdc

changes

e0a8fb7

pngwn reviewed Aug 17, 2023

View reviewed changes

aliabid94 added 9 commits August 17, 2023 13:51

changes

2158698

changes

904eebd

changes

0d011bd

changes

9911390

changes

33f5922

changes

2d4b9ad

changes

f92523b

changes

3f1b544

Merge branch 'main' into update_attempt_2

e81cc48

aliabid94 and others added 8 commits September 13, 2023 14:39

changes

58075aa

Merge remote-tracking branch 'origin' into update_attempt_2

d2909aa

changes

b6486c4

chaneges

aa617d8

Merge branch 'main' into update_attempt_2

d3317cf

Merge remote-tracking branch 'origin/main' into update_attempt_2

ab40a47

changes

a15058c

chagnes

3b58172

aliabid94 and others added 8 commits September 16, 2023 11:01

changes

b0a3575

changes

46bf1a9

changes

f3b284e

changes

8cf05d9

changes

b0b55c8

changes

1fc8b24

Merge branch 'main' into update_attempt_2

1dac13c

fix typing

e69b833

aliabid94 and others added 3 commits September 18, 2023 17:55

changes

e552936

Merge branch 'update_attempt_2' of https://github.com/gradio-app/gradio…

5811531

… into update_attempt_2

Merge branch 'main' into update_attempt_2

1a4048d

abidlabs added the v: patch A change that requires a patch release label Sep 19, 2023

Merge branch 'main' into update_attempt_2

0a3d751

abidlabs merged commit da05e59 into main Sep 19, 2023
16 checks passed

abidlabs deleted the update_attempt_2 branch September 19, 2023 04:17

This was referenced Sep 19, 2023

chore: update versions #5596

Merged

update supports updating the elem_id or elem_classes of a component #4590

Closed

chore: update versions (beta) #5501

Merged

abidlabs mentioned this pull request Sep 19, 2023

gr.update() doesn't support updating parameters that affect the preprocessing/postprocessing in backend #1566

Closed

1 task

whitphx mentioned this pull request Sep 29, 2023

Delete a session data when a WebSocket connection is closed #5733

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removing .update and get_config, attempt 2 #5240

Removing .update and get_config, attempt 2 #5240

aliabid94 commented Aug 15, 2023

gradio-pr-bot commented Aug 15, 2023 •

edited

Loading

gradio-pr-bot commented Aug 15, 2023 •

edited

Loading

Something isn't right?

abidlabs commented Aug 16, 2023

freddyaboulton left a comment

freddyaboulton Aug 16, 2023 •

edited

Loading

aliabid94 Aug 16, 2023

abidlabs commented Aug 16, 2023

abidlabs commented Aug 16, 2023 •

edited

Loading

aliabid94 commented Aug 16, 2023 •

edited

Loading

freddyaboulton commented Aug 16, 2023

pngwn Aug 17, 2023

aliabid94 commented Aug 19, 2023

abidlabs commented Sep 16, 2023

abidlabs commented Sep 19, 2023

		return hasattr(context.thread_data, "blocks")


		def updateable(fn):

Removing .update and get_config, attempt 2 #5240

Removing .update and get_config, attempt 2 #5240

Conversation

aliabid94 commented Aug 15, 2023

gradio-pr-bot commented Aug 15, 2023 • edited Loading

🪼 branch checks and previews

gradio-pr-bot commented Aug 15, 2023 • edited Loading

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

abidlabs commented Aug 16, 2023

freddyaboulton left a comment

Choose a reason for hiding this comment

freddyaboulton Aug 16, 2023 • edited Loading

Choose a reason for hiding this comment

aliabid94 Aug 16, 2023

Choose a reason for hiding this comment

abidlabs commented Aug 16, 2023

abidlabs commented Aug 16, 2023 • edited Loading

aliabid94 commented Aug 16, 2023 • edited Loading

freddyaboulton commented Aug 16, 2023

pngwn Aug 17, 2023

Choose a reason for hiding this comment

aliabid94 commented Aug 19, 2023

abidlabs commented Sep 16, 2023

abidlabs commented Sep 19, 2023

gradio-pr-bot commented Aug 15, 2023 •

edited

Loading

gradio-pr-bot commented Aug 15, 2023 •

edited

Loading

freddyaboulton Aug 16, 2023 •

edited

Loading

abidlabs commented Aug 16, 2023 •

edited

Loading

aliabid94 commented Aug 16, 2023 •

edited

Loading