Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(express): Automatically suppress non-renderable UI objects #1773

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 41 additions & 3 deletions shiny/express/_recall_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,53 @@
import functools
import sys
from types import TracebackType
from typing import Callable, Generic, Mapping, Optional, Type, TypeVar
from typing import Any, Callable, Generic, Mapping, Optional, Type, TypeVar

from htmltools import MetadataNode, Tag, TagList, wrap_displayhook_handler
from htmltools import (
HTML,
MetadataNode,
ReprHtml,
Tag,
Tagifiable,
TagList,
wrap_displayhook_handler,
)

from .._typing_extensions import ParamSpec
from ..render.renderer import Renderer

P = ParamSpec("P")
R = TypeVar("R")
U = TypeVar("U")


def only_append_renderable(handler: Callable[[object], None]) -> Callable[[Any], None]:
def f(x: Any):
if isinstance(x, (list, tuple)):
for item in x: # pyright: ignore[reportUnknownVariableType]
f(item)
return
elif isinstance(x, (str, float, int, bool)):
handler(x)
return
elif isinstance(x, (HTML, Tag, TagList, Tagifiable, ReprHtml, Renderer)):
handler(x) # pyright: ignore[reportUnknownArgumentType]
return

trunc_to = 80
x_trunc = f"{x!r}"
if len(x_trunc) > trunc_to:
x_trunc = x_trunc[:trunc_to] + "..."

print(
# TODO: Make this a more informative warning
f"Express has suppressed the object `{x_trunc}` because it is of type {type(x)}. "
"Coerce to HTML, a string, or an htmltools tag to display this object."
)

return f


class RecallContextManager(Generic[R]):
def __init__(
self,
Expand All @@ -31,7 +67,9 @@ def __init__(
self.kwargs: dict[str, object] = dict(kwargs)
# Let htmltools.wrap_displayhook_handler decide what to do with objects before
# we append them.
self.wrapped_append = wrap_displayhook_handler(self.args.append)
self.wrapped_append = only_append_renderable(
wrap_displayhook_handler(self.args.append)
)

def __enter__(self) -> None:
self._prev_displayhook = sys.displayhook
Expand Down
Loading