streamlit-nightly 1.40.3.dev20241130__tar.gz → 1.40.3.dev20241202__tar.gz

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamlit-nightly
-Version: 1.40.3.dev20241130
+Version: 1.40.3.dev20241202
 Summary: A faster way to build and share data apps
 Home-page: https://streamlit.io
 Author: Snowflake Inc

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/setup.py

@@ -21,7 +21,7 @@ from setuptools.command.install import install
 
 THIS_DIRECTORY = Path(__file__).parent
 
-VERSION = "1.40.3.dev20241130"  # PEP-440
+VERSION = "1.40.3.dev20241202"  # PEP-440
 
 # IMPORTANT: We should try very hard *not* to add dependencies to Streamlit.
 # And if you do add one, make the required version as general as possible:

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/streamlit/elements/exception.py

@@ -16,18 +16,17 @@ from __future__ import annotations
 
 import os
 import traceback
-from typing import TYPE_CHECKING, Final, cast
+from typing import TYPE_CHECKING, Callable, Final, TypeVar, cast
 
-import streamlit
 from streamlit.errors import (
     MarkdownFormattedException,
-    StreamlitAPIException,
     StreamlitAPIWarning,
     UncaughtAppException,
 )
 from streamlit.logger import get_logger
 from streamlit.proto.Exception_pb2 import Exception as ExceptionProto
 from streamlit.runtime.metrics_util import gather_metrics
+from streamlit.runtime.scriptrunner_utils.script_run_context import get_script_run_ctx
 
 if TYPE_CHECKING:
     from streamlit.delta_generator import DeltaGenerator
@@ -38,12 +37,6 @@ _LOGGER: Final = get_logger(__name__)
 # frontend when we encounter an uncaught app exception.
 _GENERIC_UNCAUGHT_EXCEPTION_TEXT: Final = "This app has encountered an error. The original error message is redacted to prevent data leaks.  Full error details have been recorded in the logs (if you're on Streamlit Cloud, click on 'Manage app' in the lower right of your app)."
 
-# Extract the streamlit package path. Make it absolute, resolve aliases, and
-# ensure there's a trailing path separator
-_STREAMLIT_DIR: Final = os.path.join(
-    os.path.realpath(os.path.dirname(streamlit.__file__)), ""
-)
-
 
 class ExceptionMixin:
     @gather_metrics("exception")
@@ -84,16 +77,9 @@ def marshall(exception_proto: ExceptionProto, exception: BaseException) -> None:
     exception : BaseException
         The exception whose data we're extracting
     """
-    # If this is a StreamlitAPIException, we prune all Streamlit entries
-    # from the exception's stack trace.
-    is_api_exception = isinstance(exception, StreamlitAPIException)
     is_markdown_exception = isinstance(exception, MarkdownFormattedException)
     is_uncaught_app_exception = isinstance(exception, UncaughtAppException)
 
-    stack_trace = _get_stack_trace_str_list(
-        exception, strip_streamlit_stack_entries=is_api_exception
-    )
-
     # Some exceptions (like UserHashError) have an alternate_name attribute so
     # we can pretend to the user that the exception is called something else.
     if getattr(exception, "alternate_name", None) is not None:
@@ -101,6 +87,8 @@ def marshall(exception_proto: ExceptionProto, exception: BaseException) -> None:
     else:
         exception_proto.type = type(exception).__name__
 
+    stack_trace = _get_stack_trace_str_list(exception)
+
     exception_proto.stack_trace.extend(stack_trace)
     exception_proto.is_warning = isinstance(exception, Warning)
 
@@ -185,9 +173,7 @@ def _format_syntax_error_message(exception: SyntaxError) -> str:
     return str(exception)
 
 
-def _get_stack_trace_str_list(
-    exception: BaseException, strip_streamlit_stack_entries: bool = False
-) -> list[str]:
+def _get_stack_trace_str_list(exception: BaseException) -> list[str]:
     """Get the stack trace for the given exception.
 
     Parameters
@@ -195,16 +181,13 @@ def _get_stack_trace_str_list(
     exception : BaseException
         The exception to extract the traceback from
 
-    strip_streamlit_stack_entries : bool
-        If True, all traceback entries that are in the Streamlit package
-        will be removed from the list. We do this for exceptions that result
-        from incorrect usage of Streamlit APIs, so that the user doesn't see
-        a bunch of noise about ScriptRunner, DeltaGenerator, etc.
-
     Returns
     -------
-    list
-        The exception traceback as a list of strings
+    tuple of two string lists
+        The exception traceback as two lists of strings. The first represents the part
+        of the stack trace the users don't typically want to see, containing internal
+        Streamlit code. The second is whatever comes after the Streamlit stack trace,
+        which is usually what the user wants.
 
     """
     extracted_traceback: traceback.StackSummary | None = None
@@ -218,36 +201,93 @@ def _get_stack_trace_str_list(
 
     # Format the extracted traceback and add it to the protobuf element.
     if extracted_traceback is None:
-        stack_trace_str_list = [
+        trace_str_list = [
             "Cannot extract the stack trace for this exception. "
             "Try calling exception() within the `catch` block."
         ]
     else:
-        if strip_streamlit_stack_entries:
-            extracted_frames = _get_nonstreamlit_traceback(extracted_traceback)
-            stack_trace_str_list = traceback.format_list(extracted_frames)
+        internal_frames, external_frames = _split_internal_streamlit_frames(
+            extracted_traceback
+        )
+
+        if external_frames:
+            trace_str_list = traceback.format_list(external_frames)
         else:
-            stack_trace_str_list = traceback.format_list(extracted_traceback)
+            trace_str_list = traceback.format_list(internal_frames)
 
-    stack_trace_str_list = [item.strip() for item in stack_trace_str_list]
+        trace_str_list = [item.strip() for item in trace_str_list]
 
-    return stack_trace_str_list
+    return trace_str_list
 
 
-def _is_in_streamlit_package(file: str) -> bool:
-    """True if the given file is part of the streamlit package."""
+def _is_in_package(file: str, package_path: str) -> bool:
+    """True if the given file is part of package_path."""
     try:
-        common_prefix = os.path.commonprefix([os.path.realpath(file), _STREAMLIT_DIR])
+        common_prefix = os.path.commonprefix([os.path.realpath(file), package_path])
     except ValueError:
         # Raised if paths are on different drives.
         return False
 
-    return common_prefix == _STREAMLIT_DIR
+    return common_prefix == package_path
 
 
-def _get_nonstreamlit_traceback(
+def _split_internal_streamlit_frames(
     extracted_tb: traceback.StackSummary,
-) -> list[traceback.FrameSummary]:
-    return [
-        entry for entry in extracted_tb if not _is_in_streamlit_package(entry.filename)
-    ]
+) -> tuple[list[traceback.FrameSummary], list[traceback.FrameSummary]]:
+    """Split the traceback into a Streamlit-internal part and an external part.
+
+    The internal part is everything up to (but excluding) the first frame belonging to
+    the user's code. The external part is everything else.
+
+    So if the stack looks like this:
+
+        1. Streamlit frame
+        2. Pandas frame
+        3. Altair frame
+        4. Streamlit frame
+        5. User frame
+        6. User frame
+        7. Streamlit frame
+        8. Matplotlib frame
+
+    ...then this should return 1-4 as the internal traceback and 5-8 as the external.
+
+    (Note that something like the example above is extremely unlikely to happen since
+    it's not like Altair is calling Streamlit code, but you get the idea.)
+    """
+
+    ctx = get_script_run_ctx()
+
+    if not ctx:
+        return [], list(extracted_tb)
+
+    package_path = os.path.join(os.path.realpath(str(ctx.main_script_parent)), "")
+
+    return _split_list(
+        extracted_tb,
+        split_point=lambda tb: _is_in_package(tb.filename, package_path),
+    )
+
+
+T = TypeVar("T")
+
+
+def _split_list(
+    orig_list: list[T], split_point: Callable[[T], bool]
+) -> tuple[list[T], list[T]]:
+    before: list[T] = []
+    after: list[T] = []
+
+    saw_split_point = False
+
+    for item in orig_list:
+        if not saw_split_point:
+            if split_point(item):
+                saw_split_point = True
+
+        if saw_split_point:
+            after.append(item)
+        else:
+            before.append(item)
+
+    return before, after

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/streamlit/navigation/page.py

@@ -178,7 +178,7 @@ class StreamlitPage:
         if not ctx:
             return
 
-        main_path = Path(ctx.pages_manager.main_script_path).parent
+        main_path = ctx.pages_manager.main_script_parent
         if isinstance(page, str):
             page = Path(page)
         if isinstance(page, Path):

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/streamlit/runtime/pages_manager.py

@@ -57,8 +57,7 @@ class PagesStrategyV1:
             def _handle_page_changed(_path: str) -> None:
                 source_util.invalidate_pages_cache()
 
-            main_script_path = Path(pages_manager.main_script_path)
-            pages_dir = main_script_path.parent / "pages"
+            pages_dir = pages_manager.main_script_parent / "pages"
             watch_dir(
                 str(pages_dir),
                 _handle_page_changed,
@@ -243,6 +242,10 @@ class PagesManager:
     def main_script_path(self) -> ScriptPath:
         return self._main_script_path
 
+    @property
+    def main_script_parent(self) -> Path:
+        return Path(self._main_script_path).parent
+
     @property
     def main_script_hash(self) -> PageHash:
         return self._main_script_hash
@@ -295,7 +298,7 @@ class PagesManager:
     def set_pages(self, pages: dict[PageHash, PageInfo]) -> None:
         # Manually setting the pages indicates we are using MPA v2.
         if isinstance(self.pages_strategy, PagesStrategyV1):
-            if os.path.exists(Path(self.main_script_path).parent / "pages"):
+            if os.path.exists(self.main_script_parent / "pages"):
                 _LOGGER.warning(
                     "st.navigation was called in an app with a pages/ directory. This may cause unusual app behavior. You may want to rename the pages/ directory."
                 )

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/streamlit/runtime/scriptrunner_utils/script_run_context.py

@@ -39,6 +39,8 @@ from streamlit.errors import (
 from streamlit.logger import get_logger
 
 if TYPE_CHECKING:
+    from pathlib import Path
+
     from streamlit.cursor import RunningCursor
     from streamlit.proto.ForwardMsg_pb2 import ForwardMsg
     from streamlit.proto.PageProfile_pb2 import Command
@@ -114,6 +116,10 @@ class ScriptRunContext:
     def active_script_hash(self):
         return self._active_script_hash
 
+    @property
+    def main_script_parent(self) -> Path:
+        return self.pages_manager.main_script_parent
+
     @contextlib.contextmanager
     def run_with_active_hash(self, page_hash: str):
         original_page_hash = self._active_script_hash

{streamlit_nightly-1.40.3.dev20241130 → streamlit_nightly-1.40.3.dev20241202}/streamlit_nightly.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamlit-nightly
-Version: 1.40.3.dev20241130
+Version: 1.40.3.dev20241202
 Summary: A faster way to build and share data apps
 Home-page: https://streamlit.io
 Author: Snowflake Inc