Add support for passing keyword args to `data` in JS client

hannahblair commented 2 weeks ago

Description

This PR adds support for passing keyword arguments as well as positional args to the data param in the JS client. This is backwards compatible, so the two usages will work:

const result = await app.predict("/predict", ["Chewbacca"]);

const result = await app.predict("/predict", { name: "Chewbacca" });

Also adds unit tests.

The CodeSnippet.svelte API usage has been updated, which you can see here: https://huggingface.co/spaces/hmb/test_args

Closes: #7831

🎯 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.

Tests

PRs will only be merged if tests pass on CI. To run the tests locally, please set up your Gradio environment locally and run the tests: bash scripts/run_all_tests.sh
You may need to run the linters: bash scripts/format_backend.sh and bash scripts/format_frontend.sh

gradio-pr-bot commented 2 weeks ago

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
	Storybook	ready!	Storybook preview
:unicorn:	Changes	detected!	Details

Install Gradio from this PR

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

Install Gradio Python Client from this PR

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

gradio-pr-bot commented 2 weeks ago

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`@gradio/app`	`minor`
`@gradio/client`	`minor`
`gradio`	`minor`

[ ] Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Add support for passing keyword args to data in JS client

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](https://github.com/gradio-app/gradio/edit/js-client-kwargs/.changeset/sad-sides-sing.md).

hannahblair commented 2 weeks ago

todo: need to update codesnippet.svelte

abidlabs commented 1 week ago

Nice @hannahblair! Just 2 nits with regards to the code snippets:

1)

The code snippet itself looks good, but in the parameter table below, we should now put the name of the parameter, instead of the [0] to designate the positional argument
We can also remove the comment // string in... as that information is included in the parameter table

Matching the Python code snippet and parameter table:

2) The RecordingSnippet.svelte code snippet still shows the positional format, would be great if we can update this as well:

hannahblair commented 1 week ago

thanks @pngwn @abidlabs! made those changes.

gradio-app / gradio