Merging PR_218 openai_rev package with new streamlit chat app

venv/lib/python3.9/site-packages/streamlit/elements/progress.py

@@ -0,0 +1,127 @@
+# 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 typing import TYPE_CHECKING, Optional, Union, cast
+
+from typing_extensions import TypeAlias
+
+from streamlit.errors import StreamlitAPIException
+from streamlit.proto.Progress_pb2 import Progress as ProgressProto
+from streamlit.string_util import clean_text
+
+if TYPE_CHECKING:
+    from streamlit.delta_generator import DeltaGenerator
+
+
+# Currently, equates to just float, but we can't use `numbers.Real` due to
+# https://github.com/python/mypy/issues/3186
+FloatOrInt: TypeAlias = Union[int, float]
+
+
+def _get_value(value):
+    if isinstance(value, int):
+        if 0 <= value <= 100:
+            return value
+        else:
+            raise StreamlitAPIException(
+                "Progress Value has invalid value [0, 100]: %d" % value
+            )
+
+    elif isinstance(value, float):
+        if 0.0 <= value <= 1.0:
+            return int(value * 100)
+        else:
+            raise StreamlitAPIException(
+                "Progress Value has invalid value [0.0, 1.0]: %f" % value
+            )
+    else:
+        raise StreamlitAPIException(
+            "Progress Value has invalid type: %s" % type(value).__name__
+        )
+
+
+def _get_text(text: Optional[str]) -> Optional[str]:
+    if text is None:
+        return None
+    if isinstance(text, str):
+        return clean_text(text)
+    raise StreamlitAPIException(
+        f"Progress Text is of type {str(type(text))}, which is not an accepted type."
+        "Text only accepts: str. Please convert the text to an accepted type."
+    )
+
+
+class ProgressMixin:
+    def progress(
+        self, value: FloatOrInt, text: Optional[str] = None
+    ) -> "DeltaGenerator":
+        r"""Display a progress bar.
+
+        Parameters
+        ----------
+        value : int or float
+            0 <= value <= 100 for int
+
+            0.0 <= value <= 1.0 for float
+
+        text : str or None
+            A message to display above the progress bar. The text 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``.
+
+        Example
+        -------
+        Here is an example of a progress bar increasing over time:
+
+        >>> import streamlit as st
+        >>> import time
+        >>>
+        >>> progress_text = "Operation in progress. Please wait."
+        >>> my_bar = st.progress(0, text=progress_text)
+        >>>
+        >>> for percent_complete in range(100):
+        ...     time.sleep(0.1)
+        ...     my_bar.progress(percent_complete + 1, text=progress_text)
+
+        """
+        # TODO: standardize numerical type checking across st.* functions.
+        progress_proto = ProgressProto()
+        progress_proto.value = _get_value(value)
+        text = _get_text(text)
+        if text is not None:
+            progress_proto.text = text
+        return self.dg._enqueue("progress", progress_proto)
+
+    @property
+    def dg(self) -> "DeltaGenerator":
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)