Merging PR_218 openai_rev package with new streamlit chat app
This commit is contained in:
noptuno
@@ -0,0 +1,337 @@
|
||||
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from dataclasses import dataclass
|
||||
from textwrap import dedent
|
||||
from typing import (
|
||||
TYPE_CHECKING,
|
||||
Any,
|
||||
Callable,
|
||||
Generic,
|
||||
List,
|
||||
Optional,
|
||||
Sequence,
|
||||
Union,
|
||||
cast,
|
||||
overload,
|
||||
)
|
||||
|
||||
from streamlit.elements.form import current_form_id
|
||||
from streamlit.elements.utils import (
|
||||
check_callback_rules,
|
||||
check_session_state_rules,
|
||||
get_label_visibility_proto_value,
|
||||
)
|
||||
from streamlit.errors import StreamlitAPIException
|
||||
from streamlit.proto.MultiSelect_pb2 import MultiSelect as MultiSelectProto
|
||||
from streamlit.runtime.metrics_util import gather_metrics
|
||||
from streamlit.runtime.scriptrunner import ScriptRunContext, get_script_run_ctx
|
||||
from streamlit.runtime.state import (
|
||||
WidgetArgs,
|
||||
WidgetCallback,
|
||||
WidgetKwargs,
|
||||
register_widget,
|
||||
)
|
||||
from streamlit.type_util import (
|
||||
Key,
|
||||
LabelVisibility,
|
||||
OptionSequence,
|
||||
T,
|
||||
ensure_indexable,
|
||||
is_iterable,
|
||||
is_type,
|
||||
maybe_raise_label_warnings,
|
||||
to_key,
|
||||
)
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from streamlit.delta_generator import DeltaGenerator
|
||||
|
||||
|
||||
@overload
|
||||
def _check_and_convert_to_indices( # type: ignore[misc]
|
||||
opt: Sequence[Any], default_values: None
|
||||
) -> Optional[List[int]]:
|
||||
...
|
||||
|
||||
|
||||
@overload
|
||||
def _check_and_convert_to_indices(
|
||||
opt: Sequence[Any], default_values: Union[Sequence[Any], Any]
|
||||
) -> List[int]:
|
||||
...
|
||||
|
||||
|
||||
def _check_and_convert_to_indices(
|
||||
opt: Sequence[Any], default_values: Union[Sequence[Any], Any, None]
|
||||
) -> Optional[List[int]]:
|
||||
"""Perform validation checks and return indices based on the default values."""
|
||||
if default_values is None and None not in opt:
|
||||
return None
|
||||
|
||||
if not isinstance(default_values, list):
|
||||
# This if is done before others because calling if not x (done
|
||||
# right below) when x is of type pd.Series() or np.array() throws a
|
||||
# ValueError exception.
|
||||
if is_type(default_values, "numpy.ndarray") or is_type(
|
||||
default_values, "pandas.core.series.Series"
|
||||
):
|
||||
default_values = list(cast(Sequence[Any], default_values))
|
||||
elif not default_values or default_values in opt:
|
||||
default_values = [default_values]
|
||||
else:
|
||||
default_values = list(default_values)
|
||||
|
||||
for value in default_values:
|
||||
if value not in opt:
|
||||
raise StreamlitAPIException(
|
||||
"Every Multiselect default value must exist in options"
|
||||
)
|
||||
|
||||
return [opt.index(value) for value in default_values]
|
||||
|
||||
|
||||
def _get_default_count(default: Union[Sequence[Any], Any, None]) -> int:
|
||||
if default is None:
|
||||
return 0
|
||||
if not is_iterable(default):
|
||||
return 1
|
||||
return len(cast(Sequence[Any], default))
|
||||
|
||||
|
||||
def _get_over_max_options_message(current_selections: int, max_selections: int):
|
||||
curr_selections_noun = "option" if current_selections == 1 else "options"
|
||||
max_selections_noun = "option" if max_selections == 1 else "options"
|
||||
return f"""
|
||||
Multiselect has {current_selections} {curr_selections_noun} selected but `max_selections`
|
||||
is set to {max_selections}. This happened because you either gave too many options to `default`
|
||||
or you manipulated the widget's state through `st.session_state`. Note that
|
||||
the latter can happen before the line indicated in the traceback.
|
||||
Please select at most {max_selections} {max_selections_noun}.
|
||||
"""
|
||||
|
||||
|
||||
@dataclass
|
||||
class MultiSelectSerde(Generic[T]):
|
||||
options: Sequence[T]
|
||||
default_value: List[int]
|
||||
|
||||
def serialize(self, value: List[T]) -> List[int]:
|
||||
return _check_and_convert_to_indices(self.options, value)
|
||||
|
||||
def deserialize(
|
||||
self,
|
||||
ui_value: Optional[List[int]],
|
||||
widget_id: str = "",
|
||||
) -> List[T]:
|
||||
current_value: List[int] = (
|
||||
ui_value if ui_value is not None else self.default_value
|
||||
)
|
||||
return [self.options[i] for i in current_value]
|
||||
|
||||
|
||||
class MultiSelectMixin:
|
||||
@gather_metrics("multiselect")
|
||||
def multiselect(
|
||||
self,
|
||||
label: str,
|
||||
options: OptionSequence[T],
|
||||
default: Optional[Any] = None,
|
||||
format_func: Callable[[Any], Any] = str,
|
||||
key: Optional[Key] = None,
|
||||
help: Optional[str] = None,
|
||||
on_change: Optional[WidgetCallback] = None,
|
||||
args: Optional[WidgetArgs] = None,
|
||||
kwargs: Optional[WidgetKwargs] = None,
|
||||
*, # keyword-only arguments:
|
||||
disabled: bool = False,
|
||||
label_visibility: LabelVisibility = "visible",
|
||||
max_selections: Optional[int] = None,
|
||||
) -> List[T]:
|
||||
r"""Display a multiselect widget.
|
||||
The multiselect widget starts as empty.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
label : str
|
||||
A short label explaining to the user what this select widget is for.
|
||||
The label can optionally contain Markdown and supports the following
|
||||
elements: Bold, Italics, Strikethroughs, Inline Code, Emojis, and Links.
|
||||
|
||||
This also supports:
|
||||
|
||||
* Emoji shortcodes, such as ``:+1:`` and ``:sunglasses:``.
|
||||
For a list of all supported codes,
|
||||
see https://share.streamlit.io/streamlit/emoji-shortcodes.
|
||||
|
||||
* LaTeX expressions, by wrapping them in "$" or "$$" (the "$$"
|
||||
must be on their own lines). Supported LaTeX functions are listed
|
||||
at https://katex.org/docs/supported.html.
|
||||
|
||||
* Colored text, using the syntax ``:color[text to be colored]``,
|
||||
where ``color`` needs to be replaced with any of the following
|
||||
supported colors: blue, green, orange, red, violet.
|
||||
|
||||
Unsupported elements are unwrapped so only their children (text contents) render.
|
||||
Display unsupported elements as literal characters by
|
||||
backslash-escaping them. E.g. ``1\. Not an ordered list``.
|
||||
|
||||
For accessibility reasons, you should never set an empty label (label="")
|
||||
but hide it with label_visibility if needed. In the future, we may disallow
|
||||
empty labels by raising an exception.
|
||||
options : Sequence[V], numpy.ndarray, pandas.Series, pandas.DataFrame, or pandas.Index
|
||||
Labels for the select options. This will be cast to str internally
|
||||
by default. For pandas.DataFrame, the first column is selected.
|
||||
default: [V], V, or None
|
||||
List of default values. Can also be a single value.
|
||||
format_func : function
|
||||
Function to modify the display of selectbox options. It receives
|
||||
the raw option as an argument and should output the label to be
|
||||
shown for that option. This has no impact on the return value of
|
||||
the multiselect.
|
||||
key : str or int
|
||||
An optional string or integer to use as the unique key for the widget.
|
||||
If this is omitted, a key will be generated for the widget
|
||||
based on its content. Multiple widgets of the same type may
|
||||
not share the same key.
|
||||
help : str
|
||||
An optional tooltip that gets displayed next to the multiselect.
|
||||
on_change : callable
|
||||
An optional callback invoked when this multiselect's value changes.
|
||||
args : tuple
|
||||
An optional tuple of args to pass to the callback.
|
||||
kwargs : dict
|
||||
An optional dict of kwargs to pass to the callback.
|
||||
disabled : bool
|
||||
An optional boolean, which disables the multiselect widget if set
|
||||
to True. The default is False. This argument can only be supplied
|
||||
by keyword.
|
||||
label_visibility : "visible" or "hidden" or "collapsed"
|
||||
The visibility of the label. If "hidden", the label doesn't show but there
|
||||
is still empty space for it above the widget (equivalent to label="").
|
||||
If "collapsed", both the label and the space are removed. Default is
|
||||
"visible". This argument can only be supplied by keyword.
|
||||
max_selections : int
|
||||
The max selections that can be selected at a time.
|
||||
This argument can only be supplied by keyword.
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
A list with the selected options
|
||||
|
||||
Example
|
||||
-------
|
||||
>>> import streamlit as st
|
||||
>>>
|
||||
>>> options = st.multiselect(
|
||||
... 'What are your favorite colors',
|
||||
... ['Green', 'Yellow', 'Red', 'Blue'],
|
||||
... ['Yellow', 'Red'])
|
||||
>>>
|
||||
>>> st.write('You selected:', options)
|
||||
|
||||
.. output::
|
||||
https://doc-multiselect.streamlitapp.com/
|
||||
height: 420px
|
||||
|
||||
"""
|
||||
ctx = get_script_run_ctx()
|
||||
return self._multiselect(
|
||||
label=label,
|
||||
options=options,
|
||||
default=default,
|
||||
format_func=format_func,
|
||||
key=key,
|
||||
help=help,
|
||||
on_change=on_change,
|
||||
args=args,
|
||||
kwargs=kwargs,
|
||||
disabled=disabled,
|
||||
label_visibility=label_visibility,
|
||||
ctx=ctx,
|
||||
max_selections=max_selections,
|
||||
)
|
||||
|
||||
def _multiselect(
|
||||
self,
|
||||
label: str,
|
||||
options: OptionSequence[T],
|
||||
default: Union[Sequence[Any], Any, None] = None,
|
||||
format_func: Callable[[Any], Any] = str,
|
||||
key: Optional[Key] = None,
|
||||
help: Optional[str] = None,
|
||||
on_change: Optional[WidgetCallback] = None,
|
||||
args: Optional[WidgetArgs] = None,
|
||||
kwargs: Optional[WidgetKwargs] = None,
|
||||
*, # keyword-only arguments:
|
||||
disabled: bool = False,
|
||||
label_visibility: LabelVisibility = "visible",
|
||||
ctx: Optional[ScriptRunContext] = None,
|
||||
max_selections: Optional[int] = None,
|
||||
) -> List[T]:
|
||||
key = to_key(key)
|
||||
check_callback_rules(self.dg, on_change)
|
||||
check_session_state_rules(default_value=default, key=key)
|
||||
|
||||
opt = ensure_indexable(options)
|
||||
maybe_raise_label_warnings(label, label_visibility)
|
||||
|
||||
indices = _check_and_convert_to_indices(opt, default)
|
||||
multiselect_proto = MultiSelectProto()
|
||||
multiselect_proto.label = label
|
||||
default_value: List[int] = [] if indices is None else indices
|
||||
multiselect_proto.default[:] = default_value
|
||||
multiselect_proto.options[:] = [str(format_func(option)) for option in opt]
|
||||
multiselect_proto.form_id = current_form_id(self.dg)
|
||||
multiselect_proto.max_selections = max_selections or 0
|
||||
if help is not None:
|
||||
multiselect_proto.help = dedent(help)
|
||||
|
||||
serde = MultiSelectSerde(opt, default_value)
|
||||
|
||||
widget_state = register_widget(
|
||||
"multiselect",
|
||||
multiselect_proto,
|
||||
user_key=key,
|
||||
on_change_handler=on_change,
|
||||
args=args,
|
||||
kwargs=kwargs,
|
||||
deserializer=serde.deserialize,
|
||||
serializer=serde.serialize,
|
||||
ctx=ctx,
|
||||
)
|
||||
default_count = _get_default_count(widget_state.value)
|
||||
if max_selections and default_count > max_selections:
|
||||
raise StreamlitAPIException(
|
||||
_get_over_max_options_message(default_count, max_selections)
|
||||
)
|
||||
|
||||
# This needs to be done after register_widget because we don't want
|
||||
# the following proto fields to affect a widget's ID.
|
||||
multiselect_proto.disabled = disabled
|
||||
multiselect_proto.label_visibility.value = get_label_visibility_proto_value(
|
||||
label_visibility
|
||||
)
|
||||
if widget_state.value_changed:
|
||||
multiselect_proto.value[:] = serde.serialize(widget_state.value)
|
||||
multiselect_proto.set_value = True
|
||||
|
||||
self.dg._enqueue("multiselect", multiselect_proto)
|
||||
return widget_state.value
|
||||
|
||||
@property
|
||||
def dg(self) -> "DeltaGenerator":
|
||||
"""Get our DeltaGenerator."""
|
||||
return cast("DeltaGenerator", self)
|
||||
Reference in New Issue
Block a user