|
|
"""gr.UploadButton() component.""" |
|
|
|
|
|
from __future__ import annotations |
|
|
|
|
|
import tempfile |
|
|
import warnings |
|
|
from collections.abc import Callable, Sequence |
|
|
from pathlib import Path |
|
|
from typing import TYPE_CHECKING, Any, Literal |
|
|
|
|
|
import gradio_client.utils as client_utils |
|
|
from gradio_client import handle_file |
|
|
from gradio_client.documentation import document |
|
|
|
|
|
from gradio import processing_utils |
|
|
from gradio.components.base import Component |
|
|
from gradio.data_classes import FileData, ListFiles |
|
|
from gradio.events import Events |
|
|
from gradio.exceptions import Error |
|
|
from gradio.utils import NamedString |
|
|
|
|
|
if TYPE_CHECKING: |
|
|
from gradio.components import Timer |
|
|
|
|
|
from gradio.events import Dependency |
|
|
|
|
|
@document() |
|
|
class UploadButton(Component): |
|
|
""" |
|
|
Used to create an upload button, when clicked allows a user to upload files that satisfy the specified file type or generic files (if file_type not set). |
|
|
|
|
|
Demos: upload_and_download, upload_button |
|
|
""" |
|
|
|
|
|
EVENTS = [Events.click, Events.upload] |
|
|
|
|
|
def __init__( |
|
|
self, |
|
|
label: str = "Upload a File", |
|
|
value: str | list[str] | Callable | None = None, |
|
|
*, |
|
|
every: Timer | float | None = None, |
|
|
inputs: Component | Sequence[Component] | set[Component] | None = None, |
|
|
variant: Literal["primary", "secondary", "stop"] = "secondary", |
|
|
visible: bool = True, |
|
|
size: Literal["sm", "lg"] | None = None, |
|
|
icon: str | None = None, |
|
|
scale: int | None = None, |
|
|
min_width: int | None = None, |
|
|
interactive: bool = True, |
|
|
elem_id: str | None = None, |
|
|
elem_classes: list[str] | str | None = None, |
|
|
render: bool = True, |
|
|
key: int | str | None = None, |
|
|
type: Literal["filepath", "binary"] = "filepath", |
|
|
file_count: Literal["single", "multiple", "directory"] = "single", |
|
|
file_types: list[str] | None = None, |
|
|
): |
|
|
""" |
|
|
Parameters: |
|
|
label: Text to display on the button. Defaults to "Upload a File". |
|
|
value: File or list of files to upload by default. |
|
|
every: Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
|
|
inputs: Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change. |
|
|
variant: 'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button. |
|
|
visible: If False, component will be hidden. |
|
|
size: Size of the button. Can be "sm" or "lg". |
|
|
icon: URL or path to the icon file to display within the button. If None, no icon will be displayed. |
|
|
scale: relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. |
|
|
min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
|
|
interactive: If False, the UploadButton will be in a disabled state. |
|
|
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
|
|
elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. |
|
|
render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
|
|
key: if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved. |
|
|
type: Type of value to be returned by component. "file" returns a temporary file object with the same base name as the uploaded file, whose full path can be retrieved by file_obj.name, "binary" returns an bytes object. |
|
|
file_count: if single, allows user to upload one file. If "multiple", user uploads multiple files. If "directory", user uploads all files in selected directory. Return type will be list for each file in case of "multiple" or "directory". |
|
|
file_types: List of type of files to be uploaded. "file" allows any file to be uploaded, "image" allows only image files to be uploaded, "audio" allows only audio files to be uploaded, "video" allows only video files to be uploaded, "text" allows only text files to be uploaded. |
|
|
""" |
|
|
valid_types = [ |
|
|
"filepath", |
|
|
"binary", |
|
|
] |
|
|
if type not in valid_types: |
|
|
raise ValueError( |
|
|
f"Invalid value for parameter `type`: {type}. Please choose from one of: {valid_types}" |
|
|
) |
|
|
self.type = type |
|
|
self.file_count = file_count |
|
|
if file_count == "directory" and file_types is not None: |
|
|
warnings.warn( |
|
|
"The `file_types` parameter is ignored when `file_count` is 'directory'." |
|
|
) |
|
|
if file_types is not None and not isinstance(file_types, list): |
|
|
raise ValueError( |
|
|
f"Parameter file_types must be a list. Received {file_types.__class__.__name__}" |
|
|
) |
|
|
if self.file_count in ["multiple", "directory"]: |
|
|
self.data_model = ListFiles |
|
|
else: |
|
|
self.data_model = FileData |
|
|
self.size = size |
|
|
self.file_types = file_types |
|
|
self.label = label |
|
|
self.variant = variant |
|
|
super().__init__( |
|
|
label=label, |
|
|
every=every, |
|
|
inputs=inputs, |
|
|
visible=visible, |
|
|
elem_id=elem_id, |
|
|
elem_classes=elem_classes, |
|
|
render=render, |
|
|
key=key, |
|
|
value=value, |
|
|
scale=scale, |
|
|
min_width=min_width, |
|
|
interactive=interactive, |
|
|
) |
|
|
self.icon = self.serve_static_file(icon) |
|
|
|
|
|
def api_info(self) -> dict[str, list[str]]: |
|
|
if self.file_count == "single": |
|
|
return FileData.model_json_schema() |
|
|
else: |
|
|
return ListFiles.model_json_schema() |
|
|
|
|
|
def example_payload(self) -> Any: |
|
|
if self.file_count == "single": |
|
|
return handle_file( |
|
|
"https://github.com/gradio-app/gradio/raw/main/test/test_files/sample_file.pdf" |
|
|
) |
|
|
else: |
|
|
return [ |
|
|
handle_file( |
|
|
"https://github.com/gradio-app/gradio/raw/main/test/test_files/sample_file.pdf" |
|
|
) |
|
|
] |
|
|
|
|
|
def example_value(self) -> Any: |
|
|
if self.file_count == "single": |
|
|
return "https://github.com/gradio-app/gradio/raw/main/test/test_files/sample_file.pdf" |
|
|
else: |
|
|
return [ |
|
|
"https://github.com/gradio-app/gradio/raw/main/test/test_files/sample_file.pdf" |
|
|
] |
|
|
|
|
|
def _process_single_file(self, f: FileData) -> bytes | NamedString: |
|
|
file_name = f.path |
|
|
if self.type == "filepath": |
|
|
if self.file_types and not client_utils.is_valid_file( |
|
|
file_name, self.file_types |
|
|
): |
|
|
raise Error( |
|
|
f"Invalid file type. Please upload a file that is one of these formats: {self.file_types}" |
|
|
) |
|
|
file = tempfile.NamedTemporaryFile(delete=False, dir=self.GRADIO_CACHE) |
|
|
file.name = file_name |
|
|
return NamedString(file_name) |
|
|
elif self.type == "binary": |
|
|
with open(file_name, "rb") as file_data: |
|
|
return file_data.read() |
|
|
else: |
|
|
raise ValueError( |
|
|
"Unknown type: " |
|
|
+ str(type) |
|
|
+ ". Please choose from: 'filepath', 'binary'." |
|
|
) |
|
|
|
|
|
def preprocess( |
|
|
self, payload: ListFiles | FileData | None |
|
|
) -> bytes | str | list[bytes] | list[str] | None: |
|
|
""" |
|
|
Parameters: |
|
|
payload: File information as a FileData object, or a list of FileData objects. |
|
|
Returns: |
|
|
Passes the file as a `str` or `bytes` object, or a list of `str` or list of `bytes` objects, depending on `type` and `file_count`. |
|
|
""" |
|
|
if payload is None: |
|
|
return None |
|
|
if self.file_count == "single": |
|
|
if isinstance(payload, ListFiles): |
|
|
return self._process_single_file(payload[0]) |
|
|
return self._process_single_file(payload) |
|
|
|
|
|
if isinstance(payload, ListFiles): |
|
|
return [self._process_single_file(f) for f in payload] |
|
|
return [self._process_single_file(payload)] |
|
|
|
|
|
def _download_files(self, value: str | list[str]) -> str | list[str]: |
|
|
downloaded_files = [] |
|
|
if isinstance(value, list): |
|
|
for file in value: |
|
|
if client_utils.is_http_url_like(file): |
|
|
downloaded_file = processing_utils.save_url_to_cache( |
|
|
file, self.GRADIO_CACHE |
|
|
) |
|
|
downloaded_files.append(downloaded_file) |
|
|
else: |
|
|
downloaded_files.append(file) |
|
|
return downloaded_files |
|
|
if client_utils.is_http_url_like(value): |
|
|
downloaded_file = processing_utils.save_url_to_cache( |
|
|
value, self.GRADIO_CACHE |
|
|
) |
|
|
return downloaded_file |
|
|
else: |
|
|
return value |
|
|
|
|
|
def postprocess(self, value: str | list[str] | None) -> ListFiles | FileData | None: |
|
|
""" |
|
|
Parameters: |
|
|
value: Expects a `str` filepath or URL, or a `list[str]` of filepaths/URLs. |
|
|
Returns: |
|
|
File information as a FileData object, or a list of FileData objects. |
|
|
""" |
|
|
if value is None: |
|
|
return None |
|
|
value = self._download_files(value) |
|
|
if isinstance(value, list): |
|
|
return ListFiles( |
|
|
root=[ |
|
|
FileData( |
|
|
path=file, |
|
|
orig_name=Path(file).name, |
|
|
size=Path(file).stat().st_size, |
|
|
) |
|
|
for file in value |
|
|
] |
|
|
) |
|
|
else: |
|
|
return FileData( |
|
|
path=value, |
|
|
orig_name=Path(value).name, |
|
|
size=Path(value).stat().st_size, |
|
|
) |
|
|
|
|
|
@property |
|
|
def skip_api(self): |
|
|
return False |
|
|
from typing import Callable, Literal, Sequence, Any, TYPE_CHECKING |
|
|
from gradio.blocks import Block |
|
|
if TYPE_CHECKING: |
|
|
from gradio.components import Timer |
|
|
|
|
|
|
|
|
def click(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. |
|
|
inputs: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all |
|
|
queue: if True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. |
|
|
batch: if True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. |
|
|
max_batch_size: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: if False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). |
|
|
postprocess: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: a list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. |
|
|
every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
|
|
trigger_mode: if "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete. |
|
|
js: optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components. |
|
|
concurrency_limit: if set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). |
|
|
concurrency_id: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
|
|
|
""" |
|
|
... |
|
|
|
|
|
def upload(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. |
|
|
inputs: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all |
|
|
queue: if True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. |
|
|
batch: if True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. |
|
|
max_batch_size: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: if False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). |
|
|
postprocess: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: a list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. |
|
|
every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
|
|
trigger_mode: if "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete. |
|
|
js: optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components. |
|
|
concurrency_limit: if set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). |
|
|
concurrency_id: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
|
|
|
""" |
|
|
... |
