Skip to content
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

api_open does not take precedence over show_api #5436

Merged
merged 6 commits into from Sep 7, 2023

Conversation

freddyaboulton
Copy link
Collaborator

Description

The two parameters now operate independently. If api_open=False, then the api_page will still be shown. This is a slight change in behavior but users still have the ability to hide them if they wish. If we automatically hide the api docs, user's don't have a way to override that.

Closes: #5434

🎯 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

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

  2. You may need to run the linters: bash scripts/format_backend.sh and bash scripts/format_frontend.sh

@gradio-pr-bot
Copy link
Contributor

gradio-pr-bot commented Sep 6, 2023

🪼 branch checks and previews

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

Install Gradio from this PR

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

Install Gradio Python Client from this PR

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

@gradio-pr-bot
Copy link
Contributor

gradio-pr-bot commented Sep 6, 2023

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
gradio patch
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

api_open does not take precedence over show_api

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 marked this pull request as ready for review September 6, 2023 20:22
gradio/blocks.py Outdated
@@ -1778,7 +1778,7 @@ def launch(
ssl_keyfile_password: If a password is provided, will use this with the ssl certificate for https.
ssl_verify: If False, skips certificate validation which allows self-signed certificates to be used.
quiet: If True, suppresses most print statements.
show_api: If True, shows the api docs in the footer of the app. Default True. If the queue is enabled, then api_open parameter of .queue() will determine if the api docs are shown, independent of the value of show_api.
show_api: If True, shows the api docs in the footer of the app. Default True. show_api: If True, shows the api docs in the footer of the app. Default True. If the queue is enabled and api_open=True, then api docs are not shown, independent of the value of show_api.
Copy link
Member

Choose a reason for hiding this comment

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

Docstring repeated here

Copy link
Member

@abidlabs abidlabs left a comment

Choose a reason for hiding this comment

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

Just the nit about docstring, otherwise lgtm!

@freddyaboulton
Copy link
Collaborator Author

Thanks for the review @abidlabs!

@freddyaboulton freddyaboulton merged commit 7ab4b70 into main Sep 7, 2023
16 checks passed
@freddyaboulton freddyaboulton deleted the 5434-show-api-bugfix branch September 7, 2023 17:22
@pngwn pngwn mentioned this pull request Sep 7, 2023
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.

show_api doesn't work when queue is enabled
3 participants