streamlit-nightly 1.43.3.dev20250312__py3-none-any.whl → 1.43.3.dev20250313__py3-none-any.whl

streamlit/elements/lib/utils.py

@@ -114,7 +114,6 @@ def _register_element_id(
 
     Parameters
     ----------
-
     element_type : str
         The type of the element to register.
 
@@ -123,7 +122,6 @@ def _register_element_id(
 
     Raises
     ------
-
     StreamlitDuplicateElementKey
         If the element key is not unique.
 

streamlit/elements/media.py

@@ -693,7 +693,8 @@ def _validate_and_normalize(data: npt.NDArray[Any]) -> tuple[bytes, int]:
 
 def _make_wav(data: npt.NDArray[Any], sample_rate: int) -> bytes:
     """
-    Transform a numpy array to a PCM bytestring
+    Transform a numpy array to a PCM bytestring.
+
     We use code from IPython display module to convert numpy array to wave bytes
     https://github.com/ipython/ipython/blob/1015c392f3d50cf4ff3e9f29beede8c1abfdcb2a/IPython/lib/display.py#L146
     """

streamlit/elements/metric.py

@@ -124,7 +124,6 @@ class MetricMixin:
 
         Examples
         --------
-
         **Example 1: Show a metric**
 
         >>> import streamlit as st

streamlit/elements/progress.py

@@ -35,7 +35,7 @@ FloatOrInt: TypeAlias = Union[int, float]
 def _check_float_between(value: float, low: float = 0.0, high: float = 1.0) -> bool:
     """
     Checks given value is 'between' the bounds of [low, high],
-    considering close values around bounds are acceptable input
+    considering close values around bounds are acceptable input.
 
     Notes
     -----

streamlit/elements/text.py

@@ -33,7 +33,7 @@ class TextMixin:
         *,  # keyword-only arguments:
         help: str | None = None,
     ) -> DeltaGenerator:
-        """Write text without Markdown or HTML parsing.
+        r"""Write text without Markdown or HTML parsing.
 
         For monospace text, use |st.code|_.
 
@@ -57,7 +57,7 @@ class TextMixin:
         -------
         >>> import streamlit as st
         >>>
-        >>> st.text("This is text\\n[and more text](that's not a Markdown link).")
+        >>> st.text("This is text\n[and more text](that's not a Markdown link).")
 
         .. output ::
             https://doc-text.streamlit.app/

streamlit/elements/vega_charts.py

@@ -287,7 +287,8 @@ def _marshall_chart_data(
     data: Data = None,
 ) -> None:
     """Adds the data to the proto and removes it from the spec dict.
-    These operations will happen in-place."""
+    These operations will happen in-place.
+    """
 
     # Pull data out of spec dict when it's in a 'datasets' key:
     #   datasets: {foo: df1_bytes, bar: df2_bytes}, ...}

streamlit/elements/widgets/audio_input.py

@@ -218,7 +218,8 @@ class AudioInputMixin:
         label_visibility: LabelVisibility = "visible",
     ) -> UploadedFile | None:
         """Deprecated alias for st.audio_input.
-        See the docstring for the widget's new name."""
+        See the docstring for the widget's new name.
+        """
 
         show_deprecation_warning(
             make_deprecated_name_warning(

streamlit/elements/widgets/button.py

@@ -193,7 +193,6 @@ class ButtonMixin:
 
         Examples
         --------
-
         **Example 1: Customize your button type**
 
         >>> import streamlit as st

streamlit/elements/widgets/button_group.py

@@ -537,7 +537,6 @@ class ButtonGroupMixin:
 
         Examples
         --------
-
         **Example 1: Multi-select pills**
 
         Display a multi-select pills widget, and show the selection:
@@ -747,7 +746,6 @@ class ButtonGroupMixin:
 
         Examples
         --------
-
         **Example 1: Multi-select segmented control**
 
         Display a multi-select segmented control widget, and show the
@@ -831,7 +829,8 @@ class ButtonGroupMixin:
 
         def _transformed_format_func(option: V) -> ButtonGroupProto.Option:
             """If option starts with a material icon or an emoji, we extract it to send
-            it parsed to the frontend."""
+            it parsed to the frontend.
+            """
             transformed = format_func(option) if format_func else str(option)
             transformed_parts = transformed.split(" ")
             icon: str | None = None

streamlit/elements/widgets/data_editor.py

@@ -392,13 +392,11 @@ def _is_supported_index(df_index: pd.Index) -> bool:
 
     Parameters
     ----------
-
     df_index : pd.Index
         The index to check.
 
     Returns
     -------
-
     bool
         True if the index is supported, False otherwise.
     """
@@ -426,7 +424,8 @@ def _is_supported_index(df_index: pd.Index) -> bool:
 
 def _fix_column_headers(data_df: pd.DataFrame) -> None:
     """Fix the column headers of the provided dataframe inplace to work
-    correctly for data editing."""
+    correctly for data editing.
+    """
     import pandas as pd
 
     if isinstance(data_df.columns, pd.MultiIndex):

streamlit/elements/widgets/slider.py

@@ -145,7 +145,7 @@ def _datetime_to_micros(dt: datetime) -> int:
 
 
 def _micros_to_datetime(micros: int, orig_tz: tzinfo | None) -> datetime:
-    """Restore times/datetimes to original timezone (dates are always naive)"""
+    """Restore times/datetimes to original timezone (dates are always naive)."""
     utc_dt = UTC_EPOCH + timedelta(microseconds=micros)
     # Add the original timezone. No conversion is required here,
     # since in the serialization, we also just replace the timestamp with UTC.

streamlit/elements/widgets/text_widgets.py

@@ -485,6 +485,7 @@ class TextWidgetsMixin:
             is ``"hidden"``, Streamlit displays an empty spacer instead of the
             label, which can help keep the widget alligned with other widgets.
             If this is ``"collapsed"``, Streamlit displays no label or spacer.
+
         Returns
         -------
         str or None

streamlit/elements/write.py

@@ -336,7 +336,6 @@ class WriteMixin:
 
         Examples
         --------
-
         Its basic use case is to draw Markdown-formatted text, whenever the
         input is a string:
 

streamlit/errors.py

@@ -43,7 +43,8 @@ class DeprecationError(Error):
 
 class FragmentStorageKeyError(Error, KeyError):
     """A KeyError raised when a KeyError is encountered during a FragmentStorage
-    operation."""
+    operation.
+    """
 
     pass
 
@@ -150,7 +151,8 @@ class StreamlitAPIWarning(StreamlitAPIException, Warning):
 
 class StreamlitModuleNotFoundError(StreamlitAPIWarning):
     """Print a pretty message when a Streamlit command requires a dependency
-    that is not one of our core dependencies."""
+    that is not one of our core dependencies.
+    """
 
     def __init__(self, module_name, *args):
         message = (

streamlit/external/langchain/streamlit_callback_handler.py

@@ -170,7 +170,7 @@ class LLMThought:
 
     @property
     def last_tool(self) -> ToolRecord | None:
-        """The last tool executed by this thought"""
+        """The last tool executed by this thought."""
         return self._last_tool
 
     def _reset_llm_token_stream(self) -> None:
@@ -286,7 +286,6 @@ class StreamlitCallbackHandler(BaseCallbackHandler):
 
         Parameters
         ----------
-
         parent_container
             The `st.container` that will contain all the Streamlit elements that the
             Handler creates.

streamlit/file_util.py

@@ -89,7 +89,9 @@ def streamlit_read(path, binary=False):
 @contextlib.contextmanager
 def streamlit_write(path, binary=False):
     """Opens a file for writing within the streamlit path, and
-    ensuring that the path exists. For example:
+    ensuring that the path exists.
+
+    For example:
 
         with streamlit_write('foo/bar.txt') as bar:
             ...
@@ -125,7 +127,7 @@ def get_static_dir() -> str:
 
 
 def get_app_static_dir(main_script_path: str) -> str:
-    """Get the folder where app static files live"""
+    """Get the folder where app static files live."""
     main_script_path = Path(main_script_path)
     static_dir = main_script_path.parent / APP_STATIC_FOLDER_NAME
     return os.path.abspath(static_dir)

streamlit/navigation/page.py

@@ -49,7 +49,6 @@ def Page(
 
     Parameters
     ----------
-
     page : str, Path, or callable
         The page source as a ``Callable`` or path to a Python file. If the page
         source is defined by a Python file, the path can be a string or

streamlit/platform.py

@@ -21,9 +21,7 @@ from streamlit.runtime.scriptrunner_utils.script_run_context import get_script_r
 
 
 def post_parent_message(message: str) -> None:
-    """
-    Sends a string message to the parent window (when host configuration allows).
-    """
+    """Sends a string message to the parent window (when host configuration allows)."""
     ctx = get_script_run_ctx()
     if ctx is None:
         return

streamlit/runtime/caching/cache_data_api.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""@st.cache_data: pickle-based caching"""
+"""@st.cache_data: pickle-based caching."""
 
 from __future__ import annotations
 
@@ -81,7 +81,7 @@ CachePersistType: TypeAlias = Union[Literal["disk"], None]
 
 
 class CachedDataFuncInfo(CachedFuncInfo):
-    """Implements the CachedFuncInfo interface for @st.cache_data"""
+    """Implements the CachedFuncInfo interface for @st.cache_data."""
 
     def __init__(
         self,
@@ -113,7 +113,7 @@ class CachedDataFuncInfo(CachedFuncInfo):
 
     @property
     def display_name(self) -> str:
-        """A human-readable name for the cached function"""
+        """A human-readable name for the cached function."""
         return f"{self.func.__module__}.{self.func.__qualname__}"
 
     def get_function_cache(self, function_key: str) -> Cache:
@@ -127,7 +127,7 @@ class CachedDataFuncInfo(CachedFuncInfo):
 
     def validate_params(self) -> None:
         """
-        Validate the params passed to @st.cache_data are compatible with cache storage
+        Validate the params passed to @st.cache_data are compatible with cache storage.
 
         When called, this method could log warnings if cache params are invalid
         for current storage.
@@ -141,7 +141,7 @@ class CachedDataFuncInfo(CachedFuncInfo):
 
 
 class DataCaches(CacheStatsProvider):
-    """Manages all DataCache instances"""
+    """Manages all DataCache instances."""
 
     def __init__(self):
         self._caches_lock = threading.Lock()

streamlit/runtime/caching/cache_errors.py

@@ -137,6 +137,6 @@ class UnserializableReturnValueError(MarkdownFormattedException):
 
 
 class UnevaluatedDataFrameError(StreamlitAPIException):
-    """Used to display a message about uncollected dataframe being used"""
+    """Used to display a message about uncollected dataframe being used."""
 
     pass

streamlit/runtime/caching/cache_resource_api.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""@st.cache_resource implementation"""
+"""@st.cache_resource implementation."""
 
 from __future__ import annotations
 
@@ -67,7 +67,7 @@ def _equal_validate_funcs(a: ValidateFunc | None, b: ValidateFunc | None) -> boo
 
 
 class ResourceCaches(CacheStatsProvider):
-    """Manages all ResourceCache instances"""
+    """Manages all ResourceCache instances."""
 
     def __init__(self):
         self._caches_lock = threading.Lock()
@@ -141,7 +141,7 @@ def get_resource_cache_stats_provider() -> CacheStatsProvider:
 
 
 class CachedResourceFuncInfo(CachedFuncInfo):
-    """Implements the CachedFuncInfo interface for @st.cache_resource"""
+    """Implements the CachedFuncInfo interface for @st.cache_resource."""
 
     def __init__(
         self,
@@ -171,7 +171,7 @@ class CachedResourceFuncInfo(CachedFuncInfo):
 
     @property
     def display_name(self) -> str:
-        """A human-readable name for the cached function"""
+        """A human-readable name for the cached function."""
         return f"{self.func.__module__}.{self.func.__qualname__}"
 
     def get_function_cache(self, function_key: str) -> Cache:

streamlit/runtime/caching/cache_utils.py

@@ -103,7 +103,8 @@ class Cache:
     def clear(self, key: str | None = None):
         """Clear values from this cache.
         If no argument is passed, all items are cleared from the cache.
-        A key can be passed to clear that key from the cache only."""
+        A key can be passed to clear that key from the cache only.
+        """
         with self._value_locks_lock:
             if not key:
                 self._value_locks.clear()
@@ -163,7 +164,8 @@ def make_cached_func_wrapper(info: CachedFuncInfo) -> Callable[..., Any]:
 
 class BoundCachedFunc:
     """A wrapper around a CachedFunc that binds it to a specific instance in case of
-    decorated function is a class method."""
+    decorated function is a class method.
+    """
 
     def __init__(self, cached_func: CachedFunc, instance: Any):
         self._cached_func = cached_func
@@ -260,7 +262,8 @@ class CachedFunc:
 
     def _handle_cache_hit(self, result: CachedResult) -> Any:
         """Handle a cache hit: replay the result's cached messages, and return its
-        value."""
+        value.
+        """
         replay_cached_messages(
             result,
             self._info.cache_type,
@@ -352,7 +355,6 @@ class CachedFunc:
 
         Parameters
         ----------
-
         *args: Any
             Arguments of the cached functions.
 

streamlit/runtime/caching/storage/cache_storage_protocol.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 """Declares the CacheStorageContext dataclass, which contains parameter information for
-each function decorated by `@st.cache_data` (for example: ttl, max_entries etc.)
+each function decorated by `@st.cache_data` (for example: ttl, max_entries etc.).
 
 Declares the CacheStorageManager protocol, which implementations are used
 to create CacheStorage instances and to optionally clear all cache storages,
@@ -61,11 +61,11 @@ from typing import Literal, Protocol
 
 
 class CacheStorageError(Exception):
-    """Base exception raised by the cache storage"""
+    """Base exception raised by the cache storage."""
 
 
 class CacheStorageKeyNotFoundError(CacheStorageError):
-    """Raised when the key is not found in the cache storage"""
+    """Raised when the key is not found in the cache storage."""
 
 
 class InvalidCacheStorageContext(CacheStorageError):
@@ -138,17 +138,17 @@ class CacheStorage(Protocol):
 
     @abstractmethod
     def set(self, key: str, value: bytes) -> None:
-        """Sets the value for a given key"""
+        """Sets the value for a given key."""
         raise NotImplementedError
 
     @abstractmethod
     def delete(self, key: str) -> None:
-        """Delete a given key"""
+        """Delete a given key."""
         raise NotImplementedError
 
     @abstractmethod
     def clear(self) -> None:
-        """Remove all keys for the storage"""
+        """Remove all keys for the storage."""
         raise NotImplementedError
 
     def close(self) -> None:

streamlit/runtime/caching/storage/dummy_cache_storage.py

@@ -26,7 +26,7 @@ from streamlit.runtime.caching.storage.in_memory_cache_storage_wrapper import (
 
 class MemoryCacheStorageManager(CacheStorageManager):
     def create(self, context: CacheStorageContext) -> CacheStorage:
-        """Creates a new cache storage instance wrapped with in-memory cache layer"""
+        """Creates a new cache storage instance wrapped with in-memory cache layer."""
         persist_storage = DummyCacheStorage()
         return InMemoryCacheStorageWrapper(
             persist_storage=persist_storage, context=context
@@ -43,7 +43,7 @@ class DummyCacheStorage(CacheStorage):
     def get(self, key: str) -> bytes:
         """
         Dummy gets the value for a given key,
-        always raises an CacheStorageKeyNotFoundError
+        always raises an CacheStorageKeyNotFoundError.
         """
         raise CacheStorageKeyNotFoundError("Key not found in dummy cache")
 

streamlit/runtime/caching/storage/in_memory_cache_storage_wrapper.py

@@ -81,7 +81,7 @@ class InMemoryCacheStorageWrapper(CacheStorage):
     def get(self, key: str) -> bytes:
         """
         Returns the stored value for the key or raise CacheStorageKeyNotFoundError if
-        the key is not found
+        the key is not found.
         """
         try:
             entry_bytes = self._read_from_mem_cache(key)
@@ -91,23 +91,23 @@ class InMemoryCacheStorageWrapper(CacheStorage):
         return entry_bytes
 
     def set(self, key: str, value: bytes) -> None:
-        """Sets the value for a given key"""
+        """Sets the value for a given key."""
         self._write_to_mem_cache(key, value)
         self._persist_storage.set(key, value)
 
     def delete(self, key: str) -> None:
-        """Delete a given key"""
+        """Delete a given key."""
         self._remove_from_mem_cache(key)
         self._persist_storage.delete(key)
 
     def clear(self) -> None:
-        """Delete all keys for the in memory cache, and also the persistent storage"""
+        """Delete all keys for the in memory cache, and also the persistent storage."""
         with self._mem_cache_lock:
             self._mem_cache.clear()
         self._persist_storage.clear()
 
     def get_stats(self) -> list[CacheStat]:
-        """Returns a list of stats in bytes for the cache memory storage per item"""
+        """Returns a list of stats in bytes for the cache memory storage per item."""
         stats = []
 
         with self._mem_cache_lock:
@@ -122,7 +122,7 @@ class InMemoryCacheStorageWrapper(CacheStorage):
         return stats
 
     def close(self) -> None:
-        """Closes the cache storage"""
+        """Closes the cache storage."""
         self._persist_storage.close()
 
     def _read_from_mem_cache(self, key: str) -> bytes:

streamlit/runtime/caching/storage/local_disk_cache_storage.py

@@ -91,7 +91,7 @@ _CACHED_FILE_EXTENSION: Final = "memo"
 
 class LocalDiskCacheStorageManager(CacheStorageManager):
     def create(self, context: CacheStorageContext) -> CacheStorage:
-        """Creates a new cache storage instance wrapped with in-memory cache layer"""
+        """Creates a new cache storage instance wrapped with in-memory cache layer."""
         persist_storage = LocalDiskCacheStorage(context)
         return InMemoryCacheStorageWrapper(
             persist_storage=persist_storage, context=context
@@ -117,7 +117,7 @@ class LocalDiskCacheStorageManager(CacheStorageManager):
 
 class LocalDiskCacheStorage(CacheStorage):
     """Cache storage that persists data to disk
-    This is the default cache persistence layer for `@st.cache_data`
+    This is the default cache persistence layer for `@st.cache_data`.
     """
 
     def __init__(self, context: CacheStorageContext):
@@ -138,7 +138,7 @@ class LocalDiskCacheStorage(CacheStorage):
         """
         Returns the stored value for the key if persisted,
         raise CacheStorageKeyNotFoundError if not found, or not configured
-        with persist="disk"
+        with persist="disk".
         """
         if self.persist == "disk":
             path = self._get_cache_file_path(key)
@@ -158,7 +158,7 @@ class LocalDiskCacheStorage(CacheStorage):
             )
 
     def set(self, key: str, value: bytes) -> None:
-        """Sets the value for a given key"""
+        """Sets the value for a given key."""
         if self.persist == "disk":
             path = self._get_cache_file_path(key)
             try:
@@ -191,7 +191,7 @@ class LocalDiskCacheStorage(CacheStorage):
                 )
 
     def clear(self) -> None:
-        """Delete all keys for the current storage"""
+        """Delete all keys for the current storage."""
         cache_dir = get_cache_folder_path()
 
         if os.path.isdir(cache_dir):
@@ -203,7 +203,7 @@ class LocalDiskCacheStorage(CacheStorage):
                     os.remove(os.path.join(cache_dir, file_name))
 
     def close(self) -> None:
-        """Dummy implementation of close, we don't need to actually "close" anything"""
+        """Dummy implementation of close, we don't need to actually "close" anything."""
 
     def _get_cache_file_path(self, value_key: str) -> str:
         """Return the path of the disk cache file for the given value."""

streamlit/runtime/connection_factory.py

@@ -278,7 +278,6 @@ def connection_factory(
 
     Examples
     --------
-
     **Example 1: Inferred connection type**
 
     The easiest way to create a first-party (SQL, Snowflake, or Snowpark) connection is

streamlit/runtime/context.py

@@ -273,7 +273,7 @@ class ContextProxy:
     @property
     @gather_metrics("context.locale")
     def locale(self) -> str | None:
-        """The locale of the user browser, read-only"""
+        """The locale of the user browser, read-only."""
         ctx = get_script_run_ctx()
         if ctx is None or ctx.context_info is None:
             return None

streamlit/runtime/credentials.py

@@ -66,7 +66,7 @@ Collecting usage statistics. To deactivate, set browser.gatherUsageStats to fals
 
 
 def _send_email(email: str) -> None:
-    """Send the user's email for metrics, if submitted"""
+    """Send the user's email for metrics, if submitted."""
     import requests
 
     if email is None or "@" not in email:

streamlit/runtime/forward_msg_cache.py

@@ -281,7 +281,7 @@ class ForwardMsgCache(CacheStatsProvider):
                     del self._entries[msg_hash]
 
     def clear(self) -> None:
-        """Remove all entries from the cache"""
+        """Remove all entries from the cache."""
         self._entries.clear()
 
     def get_stats(self) -> list[CacheStat]:

streamlit/runtime/forward_msg_queue.py

@@ -40,7 +40,8 @@ class ForwardMsgQueue:
         before_enqueue_msg: Callable[[ForwardMsg], None] | None,
     ) -> None:
         """Set a callback to be called before a message is enqueued.
-        Used in static streamlit app generation."""
+        Used in static streamlit app generation.
+        """
         ForwardMsgQueue._before_enqueue_msg = before_enqueue_msg
 
     def __init__(self):

streamlit/runtime/fragment.py

@@ -61,7 +61,8 @@ class FragmentStorage(Protocol):
     @abstractmethod
     def clear(self, new_fragment_ids: set[str] | None = None) -> None:
         """Remove all fragments saved in this FragmentStorage unless listed in
-        new_fragment_ids."""
+        new_fragment_ids.
+        """
         raise NotImplementedError
 
     @abstractmethod

streamlit/runtime/memory_media_file_storage.py

@@ -90,7 +90,7 @@ class MemoryFile(NamedTuple):
 
 class MemoryMediaFileStorage(MediaFileStorage, CacheStatsProvider):
     def __init__(self, media_endpoint: str):
-        """Create a new MemoryMediaFileStorage instance
+        """Create a new MemoryMediaFileStorage instance.
 
         Parameters
         ----------
@@ -130,7 +130,7 @@ class MemoryMediaFileStorage(MediaFileStorage, CacheStatsProvider):
     def get_file(self, filename: str) -> MemoryFile:
         """Return the MemoryFile with the given filename. Filenames are of the
         form "file_id.extension". (Note that this is *not* the optional
-        user-specified filename for download files.)
+        user-specified filename for download files.).
 
         Raises a MediaFileStorageError if no such file exists.
         """

streamlit/runtime/metrics_util.py

@@ -160,7 +160,7 @@ _DBUS_MACHINE_ID_PATH = "/var/lib/dbus/machine-id"
 
 
 def _get_machine_id_v3() -> str:
-    """Get the machine ID
+    """Get the machine ID.
 
     This is a unique identifier for a user for tracking metrics,
     that is broken in different ways in some Linux distros and Docker images.
@@ -186,7 +186,7 @@ class Installation:
 
     @classmethod
     def instance(cls) -> Installation:
-        """Returns the singleton Installation"""
+        """Returns the singleton Installation."""
         # We use a double-checked locking optimization to avoid the overhead
         # of acquiring the lock in the common case:
         # https://en.wikipedia.org/wiki/Double-checked_locking

streamlit/runtime/runtime_util.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Runtime-related utility functions"""
+"""Runtime-related utility functions."""
 
 from __future__ import annotations