taipy/tests/gui/control/test_file_download.py

# 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 os
import pathlib
from importlib import util

from taipy.gui import Gui


def test_file_download_url_md(gui: Gui, test_client, helpers):
    gui._bind_var_val("content", "some_url")
    md_string = "<|{content}|file_download|>"
    expected_list = [
        "<FileDownload",
        "content={_TpC_tpec_TpExPr_content_TPMDL_0}",
        'defaultContent="some_url"',
    ]
    helpers.test_control_md(gui, md_string, expected_list)


def test_file_download_file_md(gui: Gui, test_client, helpers):
    with open((pathlib.Path(__file__).parent.parent / "resources" / "fred.png").resolve(), "rb") as content:
        gui._bind_var_val("content", content.read())
        md_string = "<|{content}|file_download|>"
        expected_list = [
            "<FileDownload",
            'defaultContent="data:image/png;base64,',
        ]
        if not util.find_spec("magic"):
            expected_list = ["<FileDownload", 'defaultContent="/taipy-content/taipyStatic0/TaiPyContent.', ".bin"]
        helpers.test_control_md(gui, md_string, expected_list)


def test_file_download_path_md(gui: Gui, test_client, helpers):
    gui._bind_var_val("content", str((pathlib.Path(__file__).parent.parent / "resources" / "fred.png").resolve()))
    md_string = "<|{content}|file_download|>"
    expected_list = [
        "<FileDownload",
        'defaultContent="/taipy-content/taipyStatic0/fred.png',
    ]
    helpers.test_control_md(gui, md_string, expected_list)


def test_file_download_with_spaces_path_md(gui: Gui, test_client, helpers):
    resources_dir = pathlib.Path(__file__).parent.parent / "resources"
    test_file_path = resources_dir / "test file with spaces.txt"

    try:
        with open(test_file_path, "w") as f:
            f.write("Test content")

        gui._bind_var_val("content", str(test_file_path.resolve()))
        md_string = "<|{content}|file_download|>"
        expected_list = [
            "<FileDownload",
            'defaultContent="/taipy-content/taipyStatic0/test%20file%20with%20spaces.txt"',
        ]
        helpers.test_control_md(gui, md_string, expected_list)
    finally:
        if test_file_path.exists():
            test_file_path.unlink()


def test_file_download_any_file_md(gui: Gui, test_client, helpers):
    with open(os.path.abspath(__file__), "rb") as content:
        gui._bind_var_val("content", content.read())
        md_string = "<|{content}|file_download|>"
        expected_list = [
            "<FileDownload",
            'defaultContent="data:text/x',
            "python;base64,",
        ]
        if not util.find_spec("magic"):
            expected_list = ["<FileDownload", 'defaultContent="/taipy-content/taipyStatic0/TaiPyContent.', ".bin"]
        helpers.test_control_md(gui, md_string, expected_list)


def test_file_download_url_width_md(gui: Gui, test_client, helpers):
    gui._bind_var_val("content", "some_url")
    md_string = "<|{content}|file_download|width=70%|>"
    expected_list = [
        "<FileDownload",
        "content={_TpC_tpec_TpExPr_content_TPMDL_0}",
        'defaultContent="some_url"',
        'width="70%"',
    ]
    helpers.test_control_md(gui, md_string, expected_list)


def test_file_download_url_html(gui: Gui, test_client, helpers):
    gui._bind_var_val("content", "some_url")
    html_string = '<taipy:file_download content="{content}" />'
    expected_list = [
        "<FileDownload",
        'defaultContent="some_url"',
    ]
    helpers.test_control_html(gui, html_string, expected_list)