# Copyright 2021-2025 Avaiga Private Limited # # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on # an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. import inspect import warnings import pytest from taipy.gui import Gui, Markdown, State, download from taipy.gui.servers import get_request_meta from taipy.gui.servers.request import RequestAccessor @pytest.mark.skip_if_not_server("flask") def test_download(gui: Gui, helpers): def on_download_action(state: State): pass # set gui frame gui._set_frame(inspect.currentframe()) gui.add_page("test", Markdown("<|Hello|button|>")) gui.run(run_server=False) server_client = gui._server.test_client() # WS client and emit ws_client = gui._server._ws.test_client(gui._server.get_server_instance()) cid = helpers.create_scope_and_get_sid(gui) server_client.get(f"/taipy-jsx/test?client_id={cid}") with gui._server.test_request_context(f"/taipy-jsx/test/?client_id={cid}", data={"client_id": cid}): get_request_meta().client_id = cid download(gui._Gui__state, "some text", "filename.txt", "on_download_action") # type: ignore[attr-defined] received_messages = ws_client.get_received() helpers.assert_outward_ws_simple_message( received_messages[0], "DF", {"name": "filename.txt", "onAction": "on_download_action"} ) @pytest.mark.skip_if_not_server("flask") def test_download_fn(gui: Gui, helpers): def on_download_action(state: State): pass # set gui frame gui._set_frame(inspect.currentframe()) gui.add_page("test", Markdown("<|Hello|button|>")) gui.run(run_server=False) server_client = gui._server.test_client() # WS client and emit ws_client = gui._server._ws.test_client(gui._server.get_server_instance()) cid = helpers.create_scope_and_get_sid(gui) server_client.get(f"/taipy-jsx/test?client_id={cid}") with gui._server.test_request_context(f"/taipy-jsx/test/?client_id={cid}", data={"client_id": cid}): get_request_meta().client_id = cid download(gui._Gui__state, "some text", "filename.txt", on_download_action) # type: ignore[attr-defined] received_messages = ws_client.get_received() helpers.assert_outward_ws_simple_message( received_messages[0], "DF", {"name": "filename.txt", "context": "test_download"}, ) assert "onAction" in received_messages[0]["args"] # inner function is treated as lambda @pytest.mark.skip_if_not_server("fastapi") @pytest.mark.teste2e def test_download_fastapi(gui: Gui, helpers): def on_download_action(state: State): pass # set gui frame gui._set_frame(inspect.currentframe()) gui.add_page("test", Markdown("<|Hello|button|>")) helpers.run_e2e_multi_client(gui) ws_client = helpers.get_socketio_test_client() cid = helpers.create_scope_and_get_sid(gui) sid = ws_client.get_sid() ws_client.get(f"/taipy-jsx/test?client_id={cid}") with gui.get_app_context(): RequestAccessor.set_sid(sid) get_request_meta().client_id = cid download(gui._Gui__state, "some text", "filename.txt", "on_download_action") # type: ignore[attr-defined] received_messages = ws_client.get_received() try: helpers.assert_outward_ws_simple_message( received_messages[0], "DF", {"name": "filename.txt", "onAction": "on_download_action"} ) finally: ws_client.disconnect() @pytest.mark.skip_if_not_server("fastapi") @pytest.mark.teste2e def test_download_fn_fastapi(gui: Gui, helpers): def on_download_action(state: State): pass # set gui frame gui._set_frame(inspect.currentframe()) gui.add_page("test", Markdown("<|Hello|button|>")) helpers.run_e2e_multi_client(gui) ws_client = helpers.get_socketio_test_client() cid = helpers.create_scope_and_get_sid(gui) sid = ws_client.get_sid() ws_client.get(f"/taipy-jsx/test?client_id={cid}") with gui.get_app_context(): RequestAccessor.set_sid(sid) get_request_meta().client_id = cid download(gui._Gui__state, "some text", "filename.txt", on_download_action) # type: ignore[attr-defined] received_messages = ws_client.get_received() try: helpers.assert_outward_ws_simple_message( received_messages[0], "DF", {"name": "filename.txt", "context": "test_download"}, ) assert "onAction" in received_messages[0]["args"] # inner function is treated as lambda finally: ws_client.disconnect() def test_bad_download(gui: Gui, helpers): with warnings.catch_warnings(record=True) as records: download(None, "some text", "filename.txt", "on_download_action") # type: ignore[arg-type] assert len(records) == 1