streamlit 1.45.1__py3-none-any.whl → 1.46.1__py3-none-any.whl

streamlit/config_option.py

@@ -108,7 +108,8 @@ class ConfigOption:
         replaced_by: str | None = None,
         type_: type = str,
         sensitive: bool = False,
-    ):
+        multiple: bool = False,
+    ) -> None:
         """Create a ConfigOption with the given name.
 
         Parameters
@@ -142,6 +143,8 @@ class ConfigOption:
             Useful to cast the config params sent by cmd option parameter.
         sensitive: bool
             Sensitive configuration options cannot be set by CLI parameter.
+        multiple: bool
+            Whether this config option can have multiple values.
         """
         # Parse out the section and name.
         self.key = key
@@ -167,7 +170,8 @@ class ConfigOption:
             r")$"
         )
         match = re.match(key_format, self.key)
-        assert match, f'Key "{self.key}" has invalid format.'
+        if match is None:
+            raise ValueError(f'Key "{self.key}" has invalid format.')
         self.section, self.name = match.group("section"), match.group("name")
 
         self.description = description
@@ -182,17 +186,18 @@ class ConfigOption:
         self.where_defined = ConfigOption.DEFAULT_DEFINITION
         self.type = type_
         self.sensitive = sensitive
-        # infer multiple values if the default value is a list or tuple
-        self.multiple = isinstance(default_val, (list, tuple))
+        self.multiple = multiple
 
         if self.replaced_by:
             self.deprecated = True
             if deprecation_text is None:
-                deprecation_text = "Replaced by %s." % self.replaced_by
+                deprecation_text = f"Replaced by {self.replaced_by}."
 
         if self.deprecated:
-            assert expiration_date, "expiration_date is required for deprecated items"
-            assert deprecation_text, "deprecation_text is required for deprecated items"
+            if not expiration_date:
+                raise ValueError("expiration_date is required for deprecated items.")
+            if not deprecation_text:
+                raise ValueError("deprecation_text is required for deprecated items.")
             self.expiration_date = expiration_date
             self.deprecation_text = textwrap.dedent(deprecation_text)
 
@@ -218,9 +223,10 @@ class ConfigOption:
             Returns self, which makes testing easier. See config_test.py.
 
         """
-        assert get_val_func.__doc__, (
-            "Complex config options require doc strings for their description."
-        )
+        if get_val_func.__doc__ is None:
+            raise RuntimeError(
+                "Complex config options require doc strings for their description."
+            )
         self.description = get_val_func.__doc__
         self._get_val_func = get_val_func
         return self
@@ -257,8 +263,7 @@ class ConfigOption:
                 # Import here to avoid circular imports
                 from streamlit.logger import get_logger
 
-                LOGGER = get_logger(__name__)
-                LOGGER.error(
+                get_logger(__name__).error(
                     textwrap.dedent(
                         f"""
                     ════════════════════════════════════════════════
@@ -275,8 +280,7 @@ class ConfigOption:
                 # Import here to avoid circular imports
                 from streamlit.logger import get_logger
 
-                LOGGER = get_logger(__name__)
-                LOGGER.warning(
+                get_logger(__name__).warning(
                     textwrap.dedent(
                         f"""s
                     ════════════════════════════════════════════════
@@ -301,7 +305,7 @@ class ConfigOption:
         return now > expiration_date
 
     @property
-    def env_var(self):
+    def env_var(self) -> str:
         """Get the name of the environment variable that can be used to set the option."""
         name = self.key.replace(".", "_")
         return f"STREAMLIT_{to_snake_case(name).upper()}"

streamlit/config_util.py

@@ -54,19 +54,19 @@ def show_config(
         )
     )
 
-    def append_desc(text):
+    def append_desc(text: str) -> None:
         out.append("# " + cli_util.style_for_cli(text, bold=True))
 
-    def append_comment(text):
+    def append_comment(text: str) -> None:
         out.append("# " + cli_util.style_for_cli(text))
 
-    def append_section(text):
+    def append_section(text: str) -> None:
         out.append(cli_util.style_for_cli(text, bold=True, fg="green"))
 
-    def append_setting(text):
+    def append_setting(text: str) -> None:
         out.append(cli_util.style_for_cli(text, fg="green"))
 
-    for section, _ in section_descriptions.items():
+    for section in section_descriptions:
         # We inject a fake config section used for unit tests that we exclude here as
         # its options are often missing required properties, which confuses the code
         # below.
@@ -84,10 +84,10 @@ def show_config(
             continue
 
         out.append("")
-        append_section("[%s]" % section)
+        append_section(f"[{section}]")
         out.append("")
 
-        for _, option in section_options.items():
+        for option in section_options.values():
             key = option.key.split(".")[-1]
             description_paragraphs = _clean_paragraphs(option.description or "")
 
@@ -112,7 +112,21 @@ def show_config(
 
                 # # Add a line break after a paragraph only if it's not the last paragraph
                 if i != last_paragraph_idx:
-                    out.append("")
+                    append_comment("")
+
+            if option.deprecated:
+                if out[-1] != "#":
+                    append_comment("")
+                append_comment(
+                    cli_util.style_for_cli("THIS IS DEPRECATED.", fg="yellow")
+                )
+                append_comment("")
+                for line in _clean_paragraphs(option.deprecation_text):
+                    append_comment(line)
+                append_comment("")
+                append_comment(
+                    f"This option will be removed on or after {option.expiration_date}."
+                )
 
             import toml
 
@@ -121,29 +135,22 @@ def show_config(
 
             if len(toml_default) > 0:
                 # Ensure a line break before appending "Default" comment, if not already there
-                if out[-1] != "":
-                    out.append("")
-                append_comment("Default: %s" % toml_default)
+                if out[-1] != "#":
+                    append_comment("")
+                append_comment(f"Default: {toml_default}")
             else:
                 # Don't say "Default: (unset)" here because this branch applies
                 # to complex config settings too.
                 pass
 
-            if option.deprecated:
-                append_comment(cli_util.style_for_cli("DEPRECATED.", fg="yellow"))
-                for line in _clean_paragraphs(option.deprecation_text):
-                    append_comment(line)
-                append_comment(
-                    "This option will be removed on or after %s."
-                    % option.expiration_date
-                )
-
             option_is_manually_set = (
                 option.where_defined != ConfigOption.DEFAULT_DEFINITION
             )
 
             if option_is_manually_set:
-                append_comment("The value below was set in %s" % option.where_defined)
+                if out[-1] != "# ":
+                    append_comment("")
+                append_comment(f"The value below was set in {option.where_defined}")
 
             toml_setting = toml.dumps({key: option.value})
 
@@ -170,8 +177,7 @@ def _clean_paragraphs(txt: str) -> list[str]:
     # Strip both leading and trailing newlines.
     txt = txt.strip("\n")
     paragraphs = txt.split("\n\n")
-    cleaned_paragraphs = [
+    return [
         "\n".join(_clean(line) for line in paragraph.split("\n"))
         for paragraph in paragraphs
     ]
-    return cleaned_paragraphs

streamlit/connections/__init__.py

@@ -21,8 +21,8 @@ ExperimentalBaseConnection = BaseConnection
 
 __all__ = [
     "BaseConnection",
+    "ExperimentalBaseConnection",
+    "SQLConnection",
     "SnowflakeConnection",
     "SnowparkConnection",
-    "SQLConnection",
-    "ExperimentalBaseConnection",
 ]

streamlit/connections/base_connection.py

@@ -43,7 +43,7 @@ class BaseConnection(ABC, Generic[RawConnectionT]):
         reads and a ``session`` property for more complex operations.
     """
 
-    def __init__(self, connection_name: str, **kwargs) -> None:
+    def __init__(self, connection_name: str, **kwargs: Any) -> None:
         """Create a BaseConnection.
 
         This constructor is called by the connection factory machinery when a user
@@ -78,16 +78,16 @@ class BaseConnection(ABC, Generic[RawConnectionT]):
     def __getattribute__(self, name: str) -> Any:
         try:
             return object.__getattribute__(self, name)
-        except AttributeError as e:
+        except AttributeError:
             if hasattr(self._instance, name):
                 raise AttributeError(
                     f"`{name}` doesn't exist here, but you can call `._instance.{name}` instead"
                 )
-            raise e
+            raise
 
     # Methods with default implementations that we don't expect subclasses to want or
     # need to overwrite.
-    def _on_secrets_changed(self, _) -> None:
+    def _on_secrets_changed(self, _: str) -> None:
         """Reset the raw connection object when this connection's secrets change.
 
         We don't expect either user scripts or connection authors to have to use or
@@ -155,7 +155,7 @@ class BaseConnection(ABC, Generic[RawConnectionT]):
 
     # Abstract fields/methods that subclasses of BaseConnection must implement
     @abstractmethod
-    def _connect(self, **kwargs) -> RawConnectionT:
+    def _connect(self, **kwargs: Any) -> RawConnectionT:
         """Create an instance of an underlying connection object.
 
         This abstract method is the one method that we require subclasses of

streamlit/connections/snowflake_connection.py

@@ -20,7 +20,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Final, cast
+from typing import TYPE_CHECKING, Any, Final, cast
 
 from streamlit import logger
 from streamlit.connections import BaseConnection
@@ -41,6 +41,10 @@ if TYPE_CHECKING:
         SnowflakeConnection as InternalSnowflakeConnection,
     )
 
+# the ANSI-compliant SQL code for "connection was not established"
+# (see docs: https://docs.snowflake.com/en/developer-guide/python-connector/python-connector-api#id6)
+SQLSTATE_CONNECTION_WAS_NOT_ESTABLISHED: Final = "08001"
+
 
 class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
     """A connection to Snowflake using the Snowflake Connector for Python.
@@ -218,7 +222,7 @@ class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
 
     """
 
-    def _connect(self, **kwargs) -> InternalSnowflakeConnection:
+    def _connect(self, **kwargs: Any) -> InternalSnowflakeConnection:
         import snowflake.connector  # type:ignore[import]
         from snowflake.connector import Error as SnowflakeError  # type:ignore[import]
 
@@ -263,16 +267,17 @@ class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
                 return snowflake.connector.connect()
 
             return snowflake.connector.connect(**kwargs)
-        except SnowflakeError as e:
+        except SnowflakeError:
             if not len(st_secrets) and not kwargs:
                 raise StreamlitAPIException(
                     "Missing Snowflake connection configuration. "
                     "Did you forget to set this in `secrets.toml`, a Snowflake configuration file, "
                     "or as kwargs to `st.connection`? "
-                    "See the [SnowflakeConnection configuration documentation](https://docs.streamlit.io/st.connections.snowflakeconnection-configuration) "
+                    "See the [SnowflakeConnection configuration documentation]"
+                    "(https://docs.streamlit.io/st.connections.snowflakeconnection-configuration) "
                     "for more details and examples."
                 )
-            raise e
+            raise
 
     def query(
         self,
@@ -280,8 +285,8 @@ class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
         *,  # keyword-only arguments:
         ttl: float | int | timedelta | None = None,
         show_spinner: bool | str = "Running `snowflake.query(...)`.",
-        params=None,
-        **kwargs,
+        params: Any = None,
+        **kwargs: Any,
     ) -> DataFrame:
         """Run a read-only SQL query.
 
@@ -334,9 +339,6 @@ class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
         """
         from tenacity import retry, retry_if_exception, stop_after_attempt, wait_fixed
 
-        # the ANSI-compliant SQL code for "connection was not established" (see docs: https://docs.snowflake.com/en/developer-guide/python-connector/python-connector-api#id6)
-        SQLSTATE_CONNECTION_WAS_NOT_ESTABLISHED = "08001"
-
         @retry(
             after=lambda _: self.reset(),
             stop=stop_after_attempt(3),
@@ -377,7 +379,7 @@ class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
         database: str | None = None,
         schema: str | None = None,
         chunk_size: int | None = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> tuple[bool, int, int]:
         """Write a ``pandas.DataFrame`` to a table in a Snowflake database.
 

streamlit/connections/snowpark_connection.py

@@ -23,7 +23,7 @@ from __future__ import annotations
 import threading
 from collections import ChainMap
 from contextlib import contextmanager
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, Any, cast
 
 from streamlit.connections import BaseConnection
 from streamlit.connections.util import (
@@ -61,11 +61,11 @@ class SnowparkConnection(BaseConnection["Session"]):
         over the single underlying Session object under high load.
     """
 
-    def __init__(self, connection_name: str, **kwargs) -> None:
+    def __init__(self, connection_name: str, **kwargs: Any) -> None:
         self._lock = threading.RLock()
         super().__init__(connection_name, **kwargs)
 
-    def _connect(self, **kwargs) -> Session:
+    def _connect(self, **kwargs: Any) -> Session:
         from snowflake.snowpark.context import get_active_session  # type:ignore[import]
         from snowflake.snowpark.session import Session
 

streamlit/connections/sql_connection.py

@@ -21,7 +21,7 @@ from __future__ import annotations
 
 from collections import ChainMap
 from copy import deepcopy
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, Any, cast
 
 from streamlit.connections import BaseConnection
 from streamlit.connections.util import extract_from_dict
@@ -176,7 +176,7 @@ class SQLConnection(BaseConnection["Engine"]):
 
     """
 
-    def _connect(self, autocommit: bool = False, **kwargs) -> Engine:
+    def _connect(self, autocommit: bool = False, **kwargs: Any) -> Engine:
         import sqlalchemy
 
         kwargs = deepcopy(kwargs)
@@ -207,7 +207,7 @@ class SQLConnection(BaseConnection["Engine"]):
                 host=conn_params["host"],
                 port=int(conn_params["port"]) if "port" in conn_params else None,
                 database=conn_params.get("database"),
-                query=conn_params["query"] if "query" in conn_params else None,
+                query=conn_params.get("query", {}),
             )
 
         create_engine_kwargs = ChainMap(
@@ -217,8 +217,7 @@ class SQLConnection(BaseConnection["Engine"]):
 
         if autocommit:
             return cast("Engine", eng.execution_options(isolation_level="AUTOCOMMIT"))
-        else:
-            return cast("Engine", eng)
+        return cast("Engine", eng)
 
     def query(
         self,
@@ -228,8 +227,8 @@ class SQLConnection(BaseConnection["Engine"]):
         ttl: float | int | timedelta | None = None,
         index_col: str | list[str] | None = None,
         chunksize: int | None = None,
-        params=None,
-        **kwargs,
+        params: Any | None = None,
+        **kwargs: Any,
     ) -> DataFrame:
         """Run a read-only query.
 
@@ -312,21 +311,24 @@ class SQLConnection(BaseConnection["Engine"]):
         )
         def _query(
             sql: str,
-            index_col=None,
-            chunksize=None,
-            params=None,
-            **kwargs,
+            index_col: str | list[str] | None = None,
+            chunksize: int | None = None,
+            params: Any | None = None,
+            **kwargs: Any,
         ) -> DataFrame:
             import pandas as pd
 
             instance = self._instance.connect()
-            return pd.read_sql(
-                text(sql),
-                instance,
-                index_col=index_col,
-                chunksize=chunksize,
-                params=params,
-                **kwargs,
+            return cast(
+                "DataFrame",
+                pd.read_sql(
+                    text(sql),
+                    instance,
+                    index_col=index_col,
+                    chunksize=chunksize,
+                    params=params,
+                    **kwargs,
+                ),
             )
 
         # We modify our helper function's `__qualname__` here to work around default

streamlit/connections/util.py

@@ -21,7 +21,7 @@
 from __future__ import annotations
 
 import os
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     from collections.abc import Collection
@@ -92,6 +92,6 @@ def running_in_sis() -> bool:
             is_in_stored_procedure,
         )
 
-        return cast("bool", is_in_stored_procedure())
+        return is_in_stored_procedure()  # type: ignore
     except ModuleNotFoundError:
         return False

streamlit/cursor.py

@@ -91,7 +91,7 @@ class Cursor:
     def is_locked(self) -> bool:
         raise NotImplementedError()
 
-    def get_locked_cursor(self, **props) -> LockedCursor:
+    def get_locked_cursor(self, **props: Any) -> LockedCursor:
         raise NotImplementedError()
 
     @property
@@ -105,7 +105,7 @@ class Cursor:
 
 
 class RunningCursor(Cursor):
-    def __init__(self, root_container: int, parent_path: tuple[int, ...] = ()):
+    def __init__(self, root_container: int, parent_path: tuple[int, ...] = ()) -> None:
         """A moving pointer to a delta location in the app.
 
         RunningCursors auto-increment to the next available location when you
@@ -140,7 +140,7 @@ class RunningCursor(Cursor):
     def is_locked(self) -> bool:
         return False
 
-    def get_locked_cursor(self, **props) -> LockedCursor:
+    def get_locked_cursor(self, **props: Any) -> LockedCursor:
         locked_cursor = LockedCursor(
             root_container=self._root_container,
             parent_path=self._parent_path,
@@ -159,8 +159,8 @@ class LockedCursor(Cursor):
         root_container: int,
         parent_path: tuple[int, ...] = (),
         index: int = 0,
-        **props,
-    ):
+        **props: Any,
+    ) -> None:
         """A locked pointer to a location in the app.
 
         LockedCursors always point to the same location, even when you call
@@ -201,7 +201,7 @@ class LockedCursor(Cursor):
     def is_locked(self) -> bool:
         return True
 
-    def get_locked_cursor(self, **props) -> LockedCursor:
+    def get_locked_cursor(self, **props: Any) -> LockedCursor:
         self._props = props
         return self