mirror of
https://github.com/Ladebeze66/projetcbaollm.git
synced 2025-12-16 22:17:49 +01:00
118 lines
5.5 KiB
Python
118 lines
5.5 KiB
Python
"""gr.SimpleImage() component."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Sequence
|
|
from pathlib import Path
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from gradio_client import handle_file
|
|
from gradio_client.documentation import document
|
|
|
|
from gradio.components.base import Component
|
|
from gradio.data_classes import FileData
|
|
from gradio.events import Events
|
|
|
|
if TYPE_CHECKING:
|
|
from gradio.components import Timer
|
|
|
|
|
|
@document()
|
|
class SimpleImage(Component):
|
|
"""
|
|
Creates an image component that can be used to upload images (as an input) or display images (as an output).
|
|
"""
|
|
|
|
EVENTS = [
|
|
Events.clear,
|
|
Events.change,
|
|
Events.upload,
|
|
]
|
|
|
|
data_model = FileData
|
|
|
|
def __init__(
|
|
self,
|
|
value: str | None = None,
|
|
*,
|
|
label: str | None = None,
|
|
every: Timer | float | None = None,
|
|
inputs: Component | Sequence[Component] | set[Component] | None = None,
|
|
show_label: bool | None = None,
|
|
show_download_button: bool = True,
|
|
container: bool = True,
|
|
scale: int | None = None,
|
|
min_width: int = 160,
|
|
interactive: bool | None = None,
|
|
visible: bool = True,
|
|
elem_id: str | None = None,
|
|
elem_classes: list[str] | str | None = None,
|
|
render: bool = True,
|
|
key: int | str | None = None,
|
|
):
|
|
"""
|
|
Parameters:
|
|
value: A path or URL for the default value that SimpleImage component is going to take. If a function is provided, the function will be called each time the app loads to set the initial value of this component.
|
|
label: the label for this component, displayed above the component if `show_label` is `True` and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component corresponds to.
|
|
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.
|
|
show_label: if True, will display label.
|
|
show_download_button: If True, will display button to download image.
|
|
container: If True, will place the component in a container - providing some extra padding around the border.
|
|
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 True, will allow users to upload and edit an image; if False, can only be used to display images. If not provided, this is inferred based on whether the component is used as an input or output.
|
|
visible: If False, component will be hidden.
|
|
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.
|
|
"""
|
|
self.show_download_button = show_download_button
|
|
super().__init__(
|
|
label=label,
|
|
every=every,
|
|
inputs=inputs,
|
|
show_label=show_label,
|
|
container=container,
|
|
scale=scale,
|
|
min_width=min_width,
|
|
interactive=interactive,
|
|
visible=visible,
|
|
elem_id=elem_id,
|
|
elem_classes=elem_classes,
|
|
render=render,
|
|
key=key,
|
|
value=value,
|
|
)
|
|
|
|
def preprocess(self, payload: FileData | None) -> str | None:
|
|
"""
|
|
Parameters:
|
|
payload: A FileData object containing the image data.
|
|
Returns:
|
|
A `str` containing the path to the image.
|
|
"""
|
|
if payload is None:
|
|
return None
|
|
return payload.path
|
|
|
|
def postprocess(self, value: str | Path | None) -> FileData | None:
|
|
"""
|
|
Parameters:
|
|
value: Expects a `str` or `pathlib.Path` object containing the path to the image.
|
|
Returns:
|
|
A FileData object containing the image data.
|
|
"""
|
|
if value is None:
|
|
return None
|
|
return FileData(path=str(value), orig_name=Path(value).name)
|
|
|
|
def example_payload(self) -> Any:
|
|
return handle_file(
|
|
"https://raw.githubusercontent.com/gradio-app/gradio/main/test/test_files/bus.png"
|
|
)
|
|
|
|
def example_value(self) -> Any:
|
|
return "https://raw.githubusercontent.com/gradio-app/gradio/main/test/test_files/bus.png"
|