Spaces:
Runtime error
Runtime error
File size: 2,305 Bytes
8a6cf24 |
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 |
"""gr.BrowserState() component."""
from __future__ import annotations
import secrets
import string
from typing import Any
from gradio_client.documentation import document
from gradio.components.base import Component
from gradio.events import Dependency
@document()
class BrowserState(Component):
"""
Special component that stores state in the browser's localStorage in an encrypted format.
"""
def __init__(
self,
default_value: Any = None,
*,
storage_key: str | None = None,
secret: str | None = None,
render: bool = True,
):
"""
Parameters:
default_value: the default value that will be used if no value is found in localStorage. Should be a json-serializable value.
storage_key: the key to use in localStorage. If None, a random key will be generated.
secret: the secret key to use for encryption. If None, a random key will be generated (recommended).
render: should always be True, is included for consistency with other components.
"""
self.default_value = default_value
self.secret = secret or "".join(
secrets.choice(string.ascii_letters + string.digits) for _ in range(16)
)
self.storage_key = storage_key or "".join(
secrets.choice(string.ascii_letters + string.digits) for _ in range(16)
)
super().__init__(render=render)
def preprocess(self, payload: Any) -> Any:
"""
Parameters:
payload: Value from local storage
Returns:
Passes value through unchanged
"""
return payload
def postprocess(self, value: Any) -> Any:
"""
Parameters:
value: Value to store in local storage
Returns:
Passes value through unchanged
"""
return value
def api_info(self) -> dict[str, Any]:
return {"type": {}, "description": "any json-serializable value"}
def example_payload(self) -> Any:
return "test"
def example_value(self) -> Any:
return "test"
from typing import Callable, Literal, Sequence, Any, TYPE_CHECKING
from gradio.blocks import Block
if TYPE_CHECKING:
from gradio.components import Timer |