Add auth, auth_message, and root_path parameters to mount_gradio_app (#7667)

* root path

* add changeset

* docstring

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>

.changeset/tall-rules-burn.md

@@ -0,0 +1,5 @@
+---
+"gradio": minor
+---
+
+feat:Add `auth`, `auth_message`, and `root_path` parameters to `mount_gradio_app`

gradio/blocks.py

@@ -1954,7 +1954,7 @@ Received outputs:
             inbrowser: whether to automatically launch the interface in a new tab on the default browser.
             share: whether to create a publicly shareable link for the interface. Creates an SSH tunnel to make your UI accessible from anywhere. If not provided, it is set to False by default every time, except when running in Google Colab. When localhost is not accessible (e.g. Google Colab), setting share=False is not supported.
             debug: if True, blocks the main thread from running. If running in Google Colab, this is needed to print the errors in the cell output.
-            auth: If provided, username and password (or list of username-password tuples) required to access interface. Can also provide function that takes username and password and returns True if valid login.
+            auth: If provided, username and password (or list of username-password tuples) required to access app. Can also provide function that takes username and password and returns True if valid login.
             auth_message: If provided, HTML message provided on login page.
             prevent_thread_lock: If True, the interface will block the main thread while the server is running.
             show_error: If True, any errors in the interface will be displayed in an alert modal and printed in the browser console log
@@ -1977,7 +1977,7 @@ Received outputs:
             state_session_capacity: The maximum number of sessions whose information to store in memory. If the number of sessions exceeds this number, the oldest sessions will be removed. Reduce capacity to reduce memory usage when using gradio.State or returning updated components from functions. Defaults to 10000.
             share_server_address: Use this to specify a custom FRP server and port for sharing Gradio apps (only applies if share=True). If not provided, will use the default FRP server at https://gradio.live. See https://github.com/huggingface/frp for more information.
             share_server_protocol: Use this to specify the protocol to use for the share links. Defaults to "https", unless a custom share_server_address is provided, in which case it defaults to "http". If you are using a custom share_server_address and want to use https, you must set this to "https".
-            auth_dependency: A function that takes a FastAPI request and returns a string user ID or None. If the function returns None for a specific request, that user is not authorized to access the app (they will see a 401 Unauthorized response). To be used with external authentication systems like OAuth.
+            auth_dependency: A function that takes a FastAPI request and returns a string user ID or None. If the function returns None for a specific request, that user is not authorized to access the app (they will see a 401 Unauthorized response). To be used with external authentication systems like OAuth. Cannot be used with `auth`.
         Returns:
             app: FastAPI app object that is running the demo
             local_url: Locally accessible link to the demo

gradio/routes.py

@@ -1013,7 +1013,10 @@ def mount_gradio_app(
     path: str,
     app_kwargs: dict[str, Any] | None = None,
     *,
+    auth: Callable | tuple[str, str] | list[tuple[str, str]] | None = None,
+    auth_message: str | None = None,
     auth_dependency: Callable[[fastapi.Request], str | None] | None = None,
+    root_path: str | None = None,
 ) -> fastapi.FastAPI:
     """Mount a gradio.Blocks to an existing FastAPI application.
 
@@ -1022,7 +1025,10 @@ def mount_gradio_app(
         blocks: The blocks object we want to mount to the parent app.
         path: The path at which the gradio application will be mounted.
         app_kwargs: Additional keyword arguments to pass to the underlying FastAPI app as a dictionary of parameter keys and argument values. For example, `{"docs_url": "/docs"}`
-        auth_dependency: A function that takes a FastAPI request and returns a string user ID or None. If the function returns None for a specific request, that user is not authorized to access the app (they will see a 401 Unauthorized response). To be used with external authentication systems like OAuth.
+        auth: If provided, username and password (or list of username-password tuples) required to access the gradio app. Can also provide function that takes username and password and returns True if valid login.
+        auth_message: If provided, HTML message provided on login page for this gradio app.
+        auth_dependency: A function that takes a FastAPI request and returns a string user ID or None. If the function returns None for a specific request, that user is not authorized to access the gradio app (they will see a 401 Unauthorized response). To be used with external authentication systems like OAuth. Cannot be used with `auth`.
+        root_path: The subpath corresponding to the public deployment of this FastAPI application. For example, if the application is served at "https://example.com/myapp", the `root_path` should be set to "/myapp". A full URL beginning with http:// or https:// can be provided, which will be used in its entirety. Normally, this does not need to provided (even if you are using a custom `path`). However, if you are serving the FastAPI app behind a proxy, the proxy may not provide the full path to the Gradio app in the request headers. In which case, you can provide the root path here.
     Example:
         from fastapi import FastAPI
         import gradio as gr
@@ -1037,10 +1043,27 @@ def mount_gradio_app(
     blocks.dev_mode = False
     blocks.config = blocks.get_config_file()
     blocks.validate_queue_settings()
+    if auth is not None and auth_dependency is not None:
+        raise ValueError(
+            "You cannot provide both `auth` and `auth_dependency` in mount_gradio_app(). Please choose one."
+        )
+    if (
+        auth
+        and not callable(auth)
+        and not isinstance(auth[0], tuple)
+        and not isinstance(auth[0], list)
+    ):
+        blocks.auth = [auth]
+    else:
+        blocks.auth = auth
+    blocks.auth_message = auth_message
+
+    if root_path is not None:
+        blocks.root_path = root_path
+
     gradio_app = App.create_app(
         blocks, app_kwargs=app_kwargs, auth_dependency=auth_dependency
     )
-
     old_lifespan = app.router.lifespan_context
 
     @contextlib.asynccontextmanager

test/test_routes.py

@@ -336,17 +336,25 @@ class TestRoutes:
 
     def test_mount_gradio_app_with_app_kwargs(self):
         app = FastAPI()
-
         demo = gr.Interface(lambda s: f"You said {s}!", "textbox", "textbox").queue()
-
         app = gr.mount_gradio_app(
             app, demo, path="/echo", app_kwargs={"docs_url": "/docs-custom"}
         )
-
         # Use context manager to trigger start up events
         with TestClient(app) as client:
             assert client.get("/echo/docs-custom").is_success
 
+    def test_mount_gradio_app_with_auth_and_root_path(self):
+        app = FastAPI()
+        demo = gr.Interface(lambda s: f"You said {s}!", "textbox", "textbox").queue()
+        app = gr.mount_gradio_app(
+            app, demo, path="/echo", auth=("a", "b"), root_path="/echo"
+        )
+        # Use context manager to trigger start up events
+        with TestClient(app) as client:
+            assert client.get("/echo/config").status_code == 401
+        assert demo.root_path == "/echo"
+
     def test_mount_gradio_app_with_lifespan(self):
         @asynccontextmanager
         async def empty_lifespan(app: FastAPI):