From 0a41a59474f13582c8cf927db574c44ace7a0b4c Mon Sep 17 00:00:00 2001 From: Carson Date: Thu, 13 Nov 2025 19:02:15 -0600 Subject: [PATCH] feat(pkg-py): Add .app() method, enable bookmarking by default --- pkg-py/CHANGELOG.md | 8 ++ pkg-py/src/querychat/_icons.py | 19 ++++ pkg-py/src/querychat/_querychat.py | 100 +++++++++++++++++++++- pkg-py/src/querychat/_querychat_module.py | 30 +++++++ pkg-py/src/querychat/tools.py | 14 +-- pyproject.toml | 2 +- 6 files changed, 160 insertions(+), 13 deletions(-) create mode 100644 pkg-py/src/querychat/_icons.py diff --git a/pkg-py/CHANGELOG.md b/pkg-py/CHANGELOG.md index cd26c2f5..06d22978 100644 --- a/pkg-py/CHANGELOG.md +++ b/pkg-py/CHANGELOG.md @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [UNRELEASED] + +### New features + +* New `QueryChat.app()` method enables quicker/easier chatting with a dataset. (#xx) +* Enabled bookmarking by default in both `.app()` and `.server()` methods. In latter case, you'll need to also specify the `bookmark_store` (either in `shiny.App()` or `shiny.express.app_opts()`) for it to take effect. (#xx) + + ## [UNRELEASED] ### Changes diff --git a/pkg-py/src/querychat/_icons.py b/pkg-py/src/querychat/_icons.py new file mode 100644 index 00000000..f207cff9 --- /dev/null +++ b/pkg-py/src/querychat/_icons.py @@ -0,0 +1,19 @@ +from typing import Literal + +from shiny import ui + +ICON_NAMES = Literal["funnel-fill", "terminal-fill", "table"] + + +def bs_icon(name: ICON_NAMES) -> ui.HTML: + """Get Bootstrap icon SVG by name.""" + if name not in BS_ICONS: + raise ValueError(f"Unknown Bootstrap icon: {name}") + return ui.HTML(BS_ICONS[name]) + + +BS_ICONS = { + "funnel-fill": '', + "terminal-fill": '', + "table": '', +} diff --git a/pkg-py/src/querychat/_querychat.py b/pkg-py/src/querychat/_querychat.py index 929c4922..521e360b 100644 --- a/pkg-py/src/querychat/_querychat.py +++ b/pkg-py/src/querychat/_querychat.py @@ -10,9 +10,11 @@ import chatlas import chevron import sqlalchemy -from shiny import ui +from shiny import App, Inputs, Outputs, Session, reactive, render, req, ui from shiny.session import get_current_session +from shinychat import output_markdown_stream +from ._icons import bs_icon from ._querychat_module import ModServerResult, mod_server, mod_ui from .datasource import DataFrameSource, DataSource, SQLAlchemySource @@ -134,6 +136,99 @@ def __init__( # Populated when ._server() gets called (in an active session) self._server_values: ModServerResult | None = None + def app( + self, *, bookmark_store: Literal["url", "server", "disable"] = "url" + ) -> App: + """ + Quickly chat with a dataset. + + Creates a Shiny app with a chat sidebar and data table view -- providing a + quick-and-easy way to start chatting with your data. + + Parameters + ---------- + bookmark_store + The bookmarking store to use for the Shiny app. Options are: + - `"url"`: Store bookmarks in the URL (default). + - `"server"`: Store bookmarks on the server. + - `"disable"`: Disable bookmarking. + + Returns + ------- + : + A Shiny App object that can be run with `app.run()` or served with `shiny run`. + + """ + enable_bookmarking = bookmark_store != "disable" + table_name = self.data_source.table_name + + def app_ui(request): + return ui.page_sidebar( + self.sidebar(), + ui.card( + ui.card_header( + ui.div( + ui.div( + bs_icon("terminal-fill"), + ui.output_text("query_title", inline=True), + class_="d-flex align-items-center gap-2", + ), + ui.output_ui("ui_reset", inline=True), + class_="hstack gap-3", + ), + ), + ui.output_ui("sql_output"), + fill=False, + style="max-height: 33%;", + ), + ui.card( + ui.card_header(bs_icon("table"), " Data"), + ui.output_data_frame("dt"), + ), + title=ui.span("querychat with ", ui.code(table_name)), + class_="bslib-page-dashboard", + fillable=True, + ) + + def app_server(input: Inputs, output: Outputs, session: Session): + self._server(enable_bookmarking=enable_bookmarking) + + @render.text + def query_title(): + return self.title() or "SQL Query" + + @render.ui + def ui_reset(): + req(self.sql()) + return ui.input_action_button( + "reset_query", + "Reset Query", + class_="btn btn-outline-danger btn-sm lh-1 ms-auto", + ) + + @reactive.effect + @reactive.event(input.reset_query) + def _(): + self.sql("") + self.title(None) + + @render.data_frame + def dt(): + return self.df() + + @render.ui + def sql_output(): + sql = self.sql() or f"SELECT * FROM {table_name}" + sql_code = f"```sql\n{sql}\n```" + return output_markdown_stream( + "sql_code", + content=sql_code, + auto_scroll=False, + width="100%", + ) + + return App(app_ui, app_server, bookmark_store=bookmark_store) + def sidebar( self, *, @@ -184,7 +279,7 @@ def ui(self, **kwargs): """ return mod_ui(self.id, **kwargs) - def _server(self): + def _server(self, *, enable_bookmarking: bool = True) -> None: """ Initialize the server module. @@ -212,6 +307,7 @@ def _server(self): system_prompt=self.system_prompt, greeting=self.greeting, client=self.client, + enable_bookmarking=enable_bookmarking, ) return diff --git a/pkg-py/src/querychat/_querychat_module.py b/pkg-py/src/querychat/_querychat_module.py index 2fe0f3cd..dbd304ae 100644 --- a/pkg-py/src/querychat/_querychat_module.py +++ b/pkg-py/src/querychat/_querychat_module.py @@ -14,6 +14,7 @@ import chatlas import pandas as pd from shiny import Inputs, Outputs, Session + from shiny.bookmark import BookmarkState, RestoreState from .datasource import DataSource @@ -60,10 +61,12 @@ def mod_server( system_prompt: str, greeting: str | None, client: chatlas.Chat, + enable_bookmarking: bool = False, ): # Reactive values to store state sql = ReactiveString("") title = ReactiveStringOrNone(None) + has_greeted = reactive.value[bool](False) # noqa: FBT003 # Set up the chat object for this session chat = copy.deepcopy(client) @@ -99,6 +102,9 @@ async def _(user_input: str): @reactive.effect async def greet_on_startup(): + if has_greeted(): + return + if greeting: await chat_ui.append_message(greeting) elif greeting is None: @@ -108,6 +114,8 @@ async def greet_on_startup(): ) await chat_ui.append_message_stream(stream) + has_greeted.set(True) + # Handle update button clicks @reactive.effect @reactive.event(input.chat_update) @@ -125,4 +133,26 @@ def _(): if new_title is not None: title.set(new_title) + if enable_bookmarking: + chat_ui.enable_bookmarking(client) + + def _on_bookmark(x: BookmarkState) -> None: + vals = x.values # noqa: PD011 + vals["querychat_sql"] = sql.get() + vals["querychat_title"] = title.get() + vals["querychat_has_greeted"] = has_greeted.get() + + session.bookmark.on_bookmark(_on_bookmark) + + def _on_restore(x: RestoreState) -> None: + vals = x.values # noqa: PD011 + if "querychat_sql" in vals: + sql.set(vals["querychat_sql"]) + if "querychat_title" in vals: + title.set(vals["querychat_title"]) + if "querychat_has_greeted" in vals: + has_greeted.set(vals["querychat_has_greeted"]) + + session.bookmark.on_restore(_on_restore) + return ModServerResult(df=filtered_df, sql=sql, title=title, client=chat) diff --git a/pkg-py/src/querychat/tools.py b/pkg-py/src/querychat/tools.py index 8e88bc0d..c4235001 100644 --- a/pkg-py/src/querychat/tools.py +++ b/pkg-py/src/querychat/tools.py @@ -5,9 +5,9 @@ import chevron from chatlas import ContentToolResult, Tool -from htmltools import HTML from shinychat.types import ToolResultDisplay +from ._icons import bs_icon from ._utils import df_to_html if TYPE_CHECKING: @@ -66,9 +66,7 @@ def update_dashboard(query: str, title: str) -> ContentToolResult: title=title, show_request=False, open=True, - icon=HTML( - '', - ), + icon=bs_icon("funnel-fill"), ), }, ) @@ -142,9 +140,7 @@ def reset_dashboard() -> ContentToolResult: title=None, show_request=False, open=False, - icon=HTML( - '', - ), + icon=bs_icon("terminal-fill"), ), }, ) @@ -213,9 +209,7 @@ def query(query: str, _intent: str = "") -> ContentToolResult: markdown=markdown, show_request=False, open=True, - icon=HTML( - '', - ), + icon=bs_icon("table"), ), }, ) diff --git a/pyproject.toml b/pyproject.toml index 69fcd83e..c17da757 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,7 +21,7 @@ maintainers = [ dependencies = [ "duckdb", "pandas", - "shiny", + "shiny @ git+https://github.com/posit-dev/py-shiny.git", "shinywidgets", "htmltools", "chatlas>=0.13.2",