diff options
Diffstat (limited to 'venv/lib/python3.8/site-packages/dash/dcc/Store.py')
-rw-r--r-- | venv/lib/python3.8/site-packages/dash/dcc/Store.py | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/venv/lib/python3.8/site-packages/dash/dcc/Store.py b/venv/lib/python3.8/site-packages/dash/dcc/Store.py new file mode 100644 index 0000000..b26caf7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/dash/dcc/Store.py @@ -0,0 +1,94 @@ +# AUTO GENERATED FILE - DO NOT EDIT + +import typing # noqa: F401 +from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401 +from dash.development.base_component import Component, _explicitize_args + +ComponentType = typing.Union[ + str, + int, + float, + Component, + None, + typing.Sequence[typing.Union[str, int, float, Component, None]], +] + +NumberType = typing.Union[ + typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex +] + + +class Store(Component): + """A Store component. + Easily keep data on the client side with this component. + The data is not inserted in the DOM. + Data can be in memory, localStorage or sessionStorage. + The data will be kept with the id as key. + + Keyword arguments: + + - id (string; required): + The ID of this component, used to identify dash components in + callbacks. The ID needs to be unique across all of the components + in an app. + + - clear_data (boolean; default False): + Set to True to remove the data contained in `data_key`. + + - data (dict | list | number | string | boolean; optional): + The stored data for the id. + + - modified_timestamp (number; default -1): + The last time the storage was modified. + + - storage_type (a value equal to: 'local', 'session', 'memory'; default 'memory'): + The type of the web storage. memory: only kept in memory, reset + on page refresh. local: window.localStorage, data is kept after + the browser quit. session: window.sessionStorage, data is cleared + once the browser quit.""" + + _children_props = [] + _base_nodes = ["children"] + _namespace = "dash_core_components" + _type = "Store" + + def __init__( + self, + id: typing.Optional[typing.Union[str, dict]] = None, + storage_type: typing.Optional[Literal["local", "session", "memory"]] = None, + data: typing.Optional[ + typing.Union[dict, typing.Sequence, NumberType, str, bool] + ] = None, + clear_data: typing.Optional[bool] = None, + modified_timestamp: typing.Optional[NumberType] = None, + **kwargs + ): + self._prop_names = [ + "id", + "clear_data", + "data", + "modified_timestamp", + "storage_type", + ] + self._valid_wildcard_attributes = [] + self.available_properties = [ + "id", + "clear_data", + "data", + "modified_timestamp", + "storage_type", + ] + self.available_wildcard_properties = [] + _explicit_args = kwargs.pop("_explicit_args") + _locals = locals() + _locals.update(kwargs) # For wildcard attrs and excess named props + args = {k: _locals[k] for k in _explicit_args} + + for k in ["id"]: + if k not in args: + raise TypeError("Required argument `" + k + "` was not specified.") + + super(Store, self).__init__(**args) + + +setattr(Store, "__init__", _explicitize_args(Store.__init__)) |