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
Conversation
🪼 branch checks and previews
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" |
🦄 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.
|
…nto 5434-show-api-bugfix
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docstring repeated here
There was a problem hiding this 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!
Thanks for the review @abidlabs! |
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
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
andbash scripts/format_frontend.sh