File size: 3,114 Bytes
0ad74ed |
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 |
"""gr.State() component."""
from __future__ import annotations
import math
from collections.abc import Callable
from copy import deepcopy
from typing import Any
from gradio_client.documentation import document
from gradio.components.base import Component
from gradio.events import Events
@document()
class State(Component):
EVENTS = [Events.change]
"""
Special hidden component that stores session state across runs of the demo by the
same user. Can attach .change listeners that trigger when the state changes.
Demos: interface_state, blocks_simple_squares, state_cleanup
Guides: real-time-speech-recognition
"""
allow_string_shortcut = False
def __init__(
self,
value: Any = None,
render: bool = True,
*,
time_to_live: int | float | None = None,
delete_callback: Callable[[Any], None] | None = None,
):
"""
Parameters:
value: the initial value (of arbitrary type) of the state. The provided argument is deepcopied. If a callable is provided, the function will be called whenever the app loads to set the initial value of the state.
render: has no effect, but is included for consistency with other components.
time_to_live: The number of seconds the state should be stored for after it is created or updated. If None, the state will be stored indefinitely. Gradio automatically deletes state variables after a user closes the browser tab or refreshes the page, so this is useful for clearing state for potentially long running sessions.
delete_callback: A function that is called when the state is deleted. The function should take the state value as an argument.
"""
self.time_to_live = self.time_to_live = (
math.inf if time_to_live is None else time_to_live
)
self.delete_callback = delete_callback or (lambda a: None) # noqa: ARG005
try:
self.value = deepcopy(value)
except TypeError as err:
raise TypeError(
f"The initial value of `gr.State` must be able to be deepcopied. The initial value of type {type(value)} cannot be deepcopied."
) from err
super().__init__(value=self.value, render=render)
@property
def stateful(self) -> bool:
return True
def preprocess(self, payload: Any) -> Any:
"""
Parameters:
payload: Value
Returns:
Passes a value of arbitrary type through.
"""
return payload
def postprocess(self, value: Any) -> Any:
"""
Parameters:
value: Expects a value of arbitrary type, as long as it can be deepcopied.
Returns:
Passes a value of arbitrary type through.
"""
return value
def api_info(self) -> dict[str, Any]:
return {"type": {}, "description": "any valid json"}
def example_payload(self) -> Any:
return None
def example_value(self) -> Any:
return None
@property
def skip_api(self):
return True
|