/
base.py
377 lines (315 loc) 路 13.3 KB
/
base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
"""Contains all of the components that can be used with Gradio Interface / Blocks.
Along with the docs for each component, you can find the names of example demos that use
each component. These demos are located in the `demo` directory."""
from __future__ import annotations
import abc
import hashlib
import json
import sys
import warnings
from abc import ABC, abstractmethod
from enum import Enum
from pathlib import Path
from typing import TYPE_CHECKING, Any, Callable
from gradio_client.utils import is_file_obj
from gradio import utils
from gradio.blocks import Block, BlockContext
from gradio.component_meta import ComponentMeta
from gradio.data_classes import GradioDataModel
from gradio.events import EventListener
from gradio.layouts import Form
from gradio.processing_utils import move_files_to_cache
if TYPE_CHECKING:
from typing import TypedDict
class DataframeData(TypedDict):
headers: list[str]
data: list[list[str | int | bool]]
class _Keywords(Enum):
NO_VALUE = "NO_VALUE" # Used as a sentinel to determine if nothing is provided as a argument for `value` in `Component.update()`
FINISHED_ITERATING = "FINISHED_ITERATING" # Used to skip processing of a component's value (needed for generators + state)
class ComponentBase(ABC, metaclass=ComponentMeta):
EVENTS: list[EventListener | str] = []
@abstractmethod
def preprocess(self, payload: Any) -> Any:
"""
Any preprocessing needed to be performed on function input.
Parameters:
payload: The input data received by the component from the frontend.
Returns:
The preprocessed input data sent to the user's function in the backend.
"""
return payload
@abstractmethod
def postprocess(self, value):
"""
Any postprocessing needed to be performed on function output.
Parameters:
value: The output data received by the component from the user's function in the backend.
Returns:
The postprocessed output data sent to the frontend.
"""
return value
@abstractmethod
def process_example(self, value):
"""
Process the input data in a way that can be displayed by the examples dataset component in the front-end.
For example, only return the name of a file as opposed to a full path. Or get the head of a dataframe.
The return value must be able to be json-serializable to put in the config.
"""
pass
@abstractmethod
def api_info(self) -> dict[str, list[str]]:
"""
The typing information for this component as a dictionary whose values are a list of 2 strings: [Python type, language-agnostic description].
Keys of the dictionary are: raw_input, raw_output, serialized_input, serialized_output
"""
pass
@abstractmethod
def example_inputs(self) -> Any:
"""
The example inputs for this component as a dictionary whose values are example inputs compatible with this component.
Keys of the dictionary are: raw, serialized
"""
pass
@abstractmethod
def flag(self, payload: Any | GradioDataModel, flag_dir: str | Path = "") -> str:
"""
Write the component's value to a format that can be stored in a csv or jsonl format for flagging.
"""
pass
@abstractmethod
def read_from_flag(self, payload: Any) -> GradioDataModel | Any:
"""
Convert the data from the csv or jsonl file into the component state.
"""
return payload
@property
@abstractmethod
def skip_api(self):
"""Whether this component should be skipped from the api return value"""
@classmethod
def has_event(cls, event: str | EventListener) -> bool:
return event in cls.EVENTS
@classmethod
def get_component_class_id(cls) -> str:
module_name = cls.__module__
module_path = sys.modules[module_name].__file__
module_hash = hashlib.md5(f"{cls.__name__}_{module_path}".encode()).hexdigest()
return module_hash
def server(fn):
fn._is_server_fn = True
return fn
class Component(ComponentBase, Block):
"""
A base class for defining methods that all input/output components should have.
"""
def __init__(
self,
value: Any = None,
*,
label: str | None = None,
info: str | None = None,
show_label: bool | None = None,
container: bool = True,
scale: int | None = None,
min_width: int | None = None,
interactive: bool | None = None,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
render: bool = True,
load_fn: Callable | None = None,
every: float | None = None,
):
self.server_fns = [
value
for value in self.__class__.__dict__.values()
if callable(value) and getattr(value, "_is_server_fn", False)
]
# Svelte components expect elem_classes to be a list
# If we don't do this, returning a new component for an
# update will break the frontend
if not elem_classes:
elem_classes = []
# This gets overridden when `select` is called
self._selectable = False
if not hasattr(self, "data_model"):
self.data_model: type[GradioDataModel] | None = None
Block.__init__(
self,
elem_id=elem_id,
elem_classes=elem_classes,
visible=visible,
render=render,
)
if isinstance(self, StreamingInput):
self.check_streamable()
self.label = label
self.info = info
if not container:
if show_label:
warnings.warn("show_label has no effect when container is False.")
show_label = False
if show_label is None:
show_label = True
self.show_label = show_label
self.container = container
if scale is not None and scale != round(scale):
warnings.warn(
f"'scale' value should be an integer. Using {scale} will cause issues."
)
self.scale = scale
self.min_width = min_width
self.interactive = interactive
# Keep tracks of files that should not be deleted when the delete_cache parmaeter is set
# These files are the default value of the component and files that are used in examples
self.keep_in_cache = set()
# load_event is set in the Blocks.attach_load_events method
self.load_event: None | dict[str, Any] = None
self.load_event_to_attach: None | tuple[Callable, float | None] = None
load_fn, initial_value = self.get_load_fn_and_initial_value(value)
initial_value = self.postprocess(initial_value)
self.value = move_files_to_cache(
initial_value,
self, # type: ignore
postprocess=True,
)
if is_file_obj(self.value):
self.keep_in_cache.add(self.value["path"])
if callable(load_fn):
self.attach_load_event(load_fn, every)
self.component_class_id = self.__class__.get_component_class_id()
TEMPLATE_DIR = "./templates/"
FRONTEND_DIR = "../../frontend/"
def get_config(self):
config = super().get_config()
if self.info:
config["info"] = self.info
if len(self.server_fns):
config["server_fns"] = [fn.__name__ for fn in self.server_fns]
config.pop("render", None)
return config
@property
def skip_api(self):
return False
@staticmethod
def get_load_fn_and_initial_value(value):
if callable(value):
initial_value = value()
load_fn = value
else:
initial_value = value
load_fn = None
return load_fn, initial_value
def __str__(self):
return self.__repr__()
def __repr__(self):
return f"{self.get_block_name()}"
def attach_load_event(self, callable: Callable, every: float | None):
"""Add a load event that runs `callable`, optionally every `every` seconds."""
self.load_event_to_attach = (callable, every)
def process_example(self, value):
"""
Process the input data in a way that can be displayed by the examples dataset component in the front-end.
By default, this calls the `.postprocess()` method of the component. However, if the `.postprocess()` method is
computationally intensive, or returns a large payload, a custom implementation may be appropriate.
For example, the `process_example()` method of the `gr.Audio()` component only returns the name of the file, not
the processed audio file. The `.process_example()` method of the `gr.Dataframe()` returns the head of a dataframe
instead of the full dataframe.
The return value of this method must be json-serializable to put in the config.
"""
return self.postprocess(value)
def as_example(self, value):
"""Deprecated and replaced by `process_example()`."""
return self.process_example(value)
def api_info(self) -> dict[str, Any]:
"""
The typing information for this component as a dictionary whose values are a list of 2 strings: [Python type, language-agnostic description].
Keys of the dictionary are: raw_input, raw_output, serialized_input, serialized_output
"""
if self.data_model is not None:
return self.data_model.model_json_schema()
raise NotImplementedError(
f"The api_info method has not been implemented for {self.get_block_name()}"
)
def flag(self, payload: Any, flag_dir: str | Path = "") -> str:
"""
Write the component's value to a format that can be stored in a csv or jsonl format for flagging.
"""
if self.data_model:
payload = self.data_model.from_json(payload)
Path(flag_dir).mkdir(exist_ok=True)
return payload.copy_to_dir(flag_dir).model_dump_json()
return payload
def read_from_flag(self, payload: Any):
"""
Convert the data from the csv or jsonl file into the component state.
"""
if self.data_model:
return self.data_model.from_json(json.loads(payload))
return payload
class FormComponent(Component):
def get_expected_parent(self) -> type[Form] | None:
if getattr(self, "container", None) is False:
return None
return Form
def preprocess(self, payload: Any) -> Any:
return payload
def postprocess(self, value):
return value
class StreamingOutput(metaclass=abc.ABCMeta):
def __init__(self, *args, **kwargs) -> None:
super().__init__(*args, **kwargs)
self.streaming: bool
@abc.abstractmethod
def stream_output(
self, value, output_id: str, first_chunk: bool
) -> tuple[bytes, Any]:
pass
class StreamingInput(metaclass=abc.ABCMeta):
def __init__(self, *args, **kwargs) -> None:
super().__init__(*args, **kwargs)
@abc.abstractmethod
def check_streamable(self):
"""Used to check if streaming is supported given the input."""
pass
def component(cls_name: str, render: bool) -> Component:
obj = utils.component_or_layout_class(cls_name)(render=render)
if isinstance(obj, BlockContext):
raise ValueError(f"Invalid component: {obj.__class__}")
if not isinstance(obj, Component):
raise TypeError(f"Expected a Component instance, but got {obj.__class__}")
return obj
def get_component_instance(
comp: str | dict | Component, render: bool = False, unrender: bool = False
) -> Component:
"""
Returns a component instance from a string, dict, or Component object.
Parameters:
comp: the component to instantiate. If a string, must be the name of a component, e.g. "dropdown". If a dict, must have a "name" key, e.g. {"name": "dropdown", "choices": ["a", "b"]}. If a Component object, will be returned as is.
render: whether to render the component. If True, renders the component (if not already rendered). If False, does not do anything.
unrender: whether to unrender the component. If True, unrenders the the component (if already rendered) -- this is useful when constructing an Interface or ChatInterface inside of a Blocks. If False, does not do anything.
"""
if isinstance(comp, str):
component_obj = component(comp, render=render)
elif isinstance(comp, dict):
name = comp.pop("name")
component_cls = utils.component_or_layout_class(name)
component_obj = component_cls(**comp, render=render)
if isinstance(component_obj, BlockContext):
raise ValueError(f"Invalid component: {name}")
elif isinstance(comp, Component):
component_obj = comp
else:
raise ValueError(
f"Component must provided as a `str` or `dict` or `Component` but is {comp}"
)
if render and not component_obj.is_rendered:
component_obj.render()
elif unrender and component_obj.is_rendered:
component_obj.unrender()
if not isinstance(component_obj, Component):
raise TypeError(
f"Expected a Component instance, but got {component_obj.__class__}"
)
return component_obj