feat: add web_server mode

Author: longxiaofei

app/src/index.tsx

@@ -365,6 +365,9 @@ function GWalker(props: IAppProps, id: string) {
         case "gradio":
             preRender = initOnHttpCommunication;
             break;
+        case "web_server":
+            preRender = initOnHttpCommunication;
+            break;
         default:
             preRender = defaultInit;
     }

examples/web_server_demo.py

@@ -0,0 +1,73 @@
+"""
+pygwalker>=0.4.8.6
+
+This is poc for PygWalker integration with FastAPI.
+
+If you want to use Graphic-Walker in your web application, the best practice is to use Graphic-Walker as a separate front-end component for development, rather than using pygwalker.
+
+run it: uvicorn web_server_demo:app --reload --port 8000
+view it: http://127.0.0.1:8000/pyg_html/test0
+"""
+from typing import Dict, Any
+import json
+
+from fastapi import FastAPI, Body
+from fastapi.responses import HTMLResponse, JSONResponse
+from pygwalker.api.pygwalker import PygWalker
+from pygwalker.communications.base import BaseCommunication
+from pygwalker.utils.encode import DataFrameEncoder
+from pygwalker import GlobalVarManager
+import pandas as pd
+
+app = FastAPI()
+
+
+def init_pygwalker_entity_map() -> Dict[str, PygWalker]:
+    """Register PygWalker entity"""
+    GlobalVarManager.set_privacy("offline")
+    df = pd.read_csv("https://kanaries-app.s3.ap-northeast-1.amazonaws.com/public-datasets/bike_sharing_dc.csv")
+    walker = PygWalker(
+        gid="test0",
+        dataset=df,
+        field_specs=None,
+        spec="",
+        source_invoke_code="",
+        theme_key="vega",
+        appearance="light",
+        show_cloud_tool=False,
+        use_preview=False,
+        kernel_computation=True,
+        use_save_tool=False,
+        is_export_dataframe=False,
+        kanaries_api_key="",
+        default_tab="vis",
+        cloud_computation=False,
+        gw_mode="explore",
+    )
+    comm = BaseCommunication(walker.gid)
+    walker._init_callback(comm)
+    return {
+        walker.gid: walker
+    }
+
+
+pygwalker_entity_map = init_pygwalker_entity_map()
+
+
+@app.post("/_pygwalker/comm/{gid}")
+def pygwalker_comm(gid: str, payload: Dict[str, Any] = Body(...)):
+    if gid not in pygwalker_entity_map:
+        return {"success": False, "message": f"Unknown gid: {gid}"}
+
+    comm_obj = pygwalker_entity_map[gid].comm
+    result = comm_obj._receive_msg(payload["action"], payload["data"])
+    return JSONResponse(content=json.loads(json.dumps(result, cls=DataFrameEncoder)))
+
+
+@app.get("/pyg_html/{gid}")
+def pyg_html(gid: str):
+    walker = pygwalker_entity_map[gid]
+    props = walker._get_props("web_server")
+    props["communicationUrl"] = "_pygwalker/comm"
+    html = walker._get_render_iframe(props, True)
+    return HTMLResponse(content=html)

pygwalker/__init__.py

@@ -10,7 +10,7 @@
 from pygwalker.services.global_var import GlobalVarManager
 from pygwalker.services.kaggle import show_tips_user_kaggle as __show_tips_user_kaggle
 
-__version__ = "0.4.8.5"
+__version__ = "0.4.8.6"
 __hash__ = __rand_str()
 
 from pygwalker.api.jupyter import walk, render, table

pygwalker/api/pygwalker.py

@@ -102,6 +102,7 @@ def __init__(
         self._last_exported_dataframe = None
         self.default_tab = default_tab
         self.cloud_computation = cloud_computation
+        self.comm = None
         check_update()
         # Temporarily adapt to pandas import module bug
         if self.kernel_computation:
@@ -326,6 +327,7 @@ def _get_chart_by_name(self, chart_name: str) -> ChartData:
 
     def _init_callback(self, comm: BaseCommunication, preview_tool: PreviewImageTool = None):
         upload_tool = BatchUploadDatasToolOnWidgets(comm)
+        self.comm = comm
 
         def reuqest_data_callback(_):
             upload_tool.run(

pyproject.toml

@@ -25,7 +25,7 @@ dependencies = [
     "requests",
     "arrow",
     "sqlalchemy",
-    "gw_dsl_parser==0.1.48a5",
+    "gw_dsl_parser==0.1.48a6",
     "appdirs",
     "segment-analytics-python==2.2.3",
     "pandas",