ex4nicegui 0.6.4__tar.gz → 0.6.6__tar.gz

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ex4nicegui
-Version: 0.6.4
+Version: 0.6.6
 Summary: Extension library based on nicegui, providing data responsive,BI functionality modules
 Home-page: 
 Author: carson_jia
@@ -420,6 +420,31 @@ ui.button("change b", on_click=change_b)
 
 ---
 
+### `new_scope`
+
+By default, all watch functions are automatically destroyed when the client connection is disconnected. For finer-grained control, the `new_scope` function can be utilized.
+
+```python
+from nicegui import ui
+from ex4nicegui import rxui, to_ref, effect, new_scope
+
+a = to_ref(0.0)
+
+scope1 = new_scope()
+
+@scope1.run
+def _():
+    @effect
+    def _():
+        print(f"scope 1:{a.value}")
+
+
+rxui.number(value=a)
+rxui.button("dispose scope 1", on_click=scope1.dispose)
+```
+
+---
+
 ## functionality
 
 ### vmodel

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/README.md

@@ -414,6 +414,31 @@ ui.button("change b", on_click=change_b)
 
 ---
 
+### `new_scope`
+
+默认情况下，所有检测函数在客户端连接断开时自动销毁。如果需要更细粒度的控制，可以使用 `new_scope`
+
+```python
+from nicegui import ui
+from ex4nicegui import rxui, to_ref, effect, new_scope
+
+a = to_ref(0.0)
+
+scope1 = new_scope()
+
+@scope1.run
+def _():
+    @effect
+    def _():
+        print(f"scope 1:{a.value}")
+
+
+rxui.number(value=a)
+rxui.button("dispose scope 1", on_click=scope1.dispose)
+```
+
+---
+
 
 ## 组件功能
 

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/ex4nicegui/__init__.py

@@ -20,7 +20,7 @@ from ex4nicegui.utils.signals import (
     is_reactive,
 )
 from ex4nicegui.utils.asyncComputed import async_computed
-
+from ex4nicegui.utils.clientScope import new_scope
 
 __all__ = [
     "async_computed",
@@ -43,6 +43,7 @@ __all__ = [
     "batch",
     "to_raw",
     "is_setter_ref",
+    "new_scope",
 ]
 
-__version__ = "0.6.4"
+__version__ = "0.6.6"

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/ex4nicegui/bi/dataSource.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 from typing import Callable, Dict, List, Optional, Set, cast, TYPE_CHECKING
 from ex4nicegui import to_ref, ref_computed, on, batch, effect
-from nicegui import context as ng_context, Client, ui
+from nicegui import Client, ui
 
 from dataclasses import dataclass, field
 from . import types
@@ -149,7 +149,7 @@ class DataSource:
             self.__notify_update()
 
     def get_component_info_key(self, element_id: types._TElementID):
-        client_id = ng_context.get_client().id
+        client_id = ui.context.client.id
         return ComponentInfoKey(client_id, element_id)
 
     def get_filtered_data(self, element: ui.element):
@@ -175,7 +175,7 @@ class DataSource:
         update_callback: Optional[_TComponentUpdateCallback] = None,
         ui_result: Optional[UiResult] = None,
     ):
-        ng_client = ng_context.get_client()
+        ng_client = ui.context.client
         client_id = ng_client.id
 
         if not self._component_map.has_client_record(client_id):
@@ -198,7 +198,7 @@ class DataSource:
         filter: Optional[Filter],
         notify_update=True,
     ):
-        client_id = ng_context.get_client().id
+        client_id = ui.context.client.id
         key = ComponentInfoKey(client_id, element_id)
 
         if not self._component_map.has_record(key):
@@ -216,7 +216,7 @@ class DataSource:
         return self
 
     def notify_update(self, exclude: Optional[List[UiResult]] = None):
-        client_id = ng_context.get_client().id
+        client_id = ui.context.client.id
         exclude_infos = [
             self._component_map.get_info(ComponentInfoKey(client_id, ur.id))
             for ur in (exclude or [])

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/ex4nicegui/bi/elements/ui_echarts.py

@@ -2,10 +2,7 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any, Callable, Dict, Union, cast
 from nicegui.events import UiEventArguments
 from ex4nicegui.reactive import rxui
-from ex4nicegui.reactive.EChartsComponent.ECharts import (
-    EChartsMouseEventArguments,
-    echarts,
-)
+from ex4nicegui.reactive.EChartsComponent.ECharts import echarts
 from nicegui import ui
 from ex4nicegui.bi.dataSource import DataSource
 from .models import UiResult
@@ -21,7 +18,7 @@ class EChartsResult(UiResult[echarts]):
         super().__init__(element, dataSource)
         self.chart_update = chart_update
 
-    def on_chart_click(self, handler: Callable[[EChartsMouseEventArguments], Any]):
+    def on_chart_click(self, handler: Callable[[UiEventArguments], Any]):
         return self.element.echarts_on("click", handler)
 
     def on_chart_click_blank(self, handler: Callable[[UiEventArguments], Any]):

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/ex4nicegui/gsap/gsap.py

@@ -2,7 +2,7 @@ import os
 from pathlib import Path
 from typing import Dict, Optional, Union
 from nicegui.element import Element
-from nicegui import context as ng_context
+from nicegui import ui
 from weakref import WeakKeyDictionary
 
 
@@ -45,7 +45,7 @@ class Gsap(
         def fn():
             self.run_method("runScript", script)
 
-        if ng_context.get_client().has_socket_connection:
+        if ui.context.client.has_socket_connection:
             fn()
         else:
             tasks = self._props["scriptTasks"]
@@ -55,7 +55,7 @@ class Gsap(
         def fn():
             self.run_method(name, targets, vars)
 
-        if ng_context.get_client().has_socket_connection:
+        if ui.context.client.has_socket_connection:
             fn()
         else:
             tasks = self._props["tasks"]
@@ -66,7 +66,7 @@ __instance_map = WeakKeyDictionary()
 
 
 def _get_instance():
-    current_client = ng_context.get_client()
+    current_client = ui.context.client
     ins = __instance_map.get(current_client)
 
     if not ins:

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/ex4nicegui/gsap/timeline.py

@@ -2,7 +2,7 @@ import os
 from pathlib import Path
 from typing import Dict, Optional, Union
 from nicegui.element import Element
-from nicegui import context as ng_context
+from nicegui import ui
 
 
 class Timeline(
@@ -40,7 +40,7 @@ class Timeline(
         def fn():
             self.run_method("runScript", script)
 
-        if ng_context.get_client().has_socket_connection:
+        if ui.context.client.has_socket_connection:
             fn()
         else:
             tasks = self._props["scriptTasks"]
@@ -52,7 +52,7 @@ class Timeline(
         def fn():
             self.run_method(name, targets, vars)
 
-        if ng_context.get_client().has_socket_connection:
+        if ui.context.client.has_socket_connection:
             fn()
         else:
             tasks = self._props["tasks"]

ex4nicegui-0.6.6/ex4nicegui/reactive/EChartsComponent/ECharts.js

@@ -0,0 +1,112 @@
+import { convertDynamicProperties } from "../../static/utils/dynamic_properties.js";
+
+function collectMapRegisterTask() {
+  const tasks = new Map();
+
+  if (typeof window.ex4ngEchartsMapTasks !== "undefined") {
+
+    for (const [mapName, src] of window.ex4ngEchartsMapTasks.entries()) {
+
+      const registerPromise = new Promise((resolve, reject) => {
+        fetch(src)
+          .then((response) => response.json())
+          .then((data) => {
+            echarts.registerMap(mapName, data);
+            resolve();
+          });
+
+      });
+
+      tasks.set(mapName, registerPromise);
+    }
+  }
+
+  return tasks;
+}
+
+function hasMapOrGeo(options) {
+  if (options) {
+    const hasMapSeries = options.series && Array.isArray(options.series) &&
+      options.series.some(seriesItem =>
+        seriesItem.type === 'map' ||
+        seriesItem.type === 'lines'
+      );
+
+    const hasGeoConfig = options.geo && (typeof options.geo === 'object' || Array.isArray(options.geo));
+
+    return hasMapSeries || hasGeoConfig;
+  }
+  return false;
+}
+
+const mapRegisterTasks = collectMapRegisterTask();
+
+export default {
+  template: "<div></div>",
+  async mounted() {
+    await this.$nextTick(); // wait for Tailwind classes to be applied
+
+    if (hasMapOrGeo(this.options)) {
+      await Promise.all(Array.from(mapRegisterTasks.values()));
+    }
+
+    this.chart = echarts.init(this.$el, this.theme);
+
+    this.resizeObs = new ResizeObserver(this.chart.resize)
+
+    // Prevent interruption of chart animations due to resize operations.
+    // It is recommended to register the callbacks for such an event before setOption.
+    const createResizeObserver = () => {
+      this.resizeObs.observe(this.$el);
+      this.chart.off("finished", createResizeObserver);
+    };
+    this.chart.on("finished", createResizeObserver);
+
+    if (this.options) {
+      this.update_chart();
+    } else {
+      const fn = new Function('return ' + this.code)()
+      fn(this.chart)
+      this.$emit("__update_options_from_client", this.chart.getOption())
+    }
+    this.chart.getZr().on("click", (e) => {
+      if (!e.target) {
+        this.$emit("clickBlank")
+      }
+    });
+
+  },
+  beforeDestroy() {
+    this.chart.dispose();
+    this.resizeObs.unobserve();
+  },
+  beforeUnmount() {
+    this.chart.dispose();
+    this.resizeObs.unobserve();
+  },
+  methods: {
+    update_chart(opts) {
+      convertDynamicProperties(this.options, true);
+      this.chart.setOption(this.options, opts ?? { notMerge: this.chart.options?.series.length != this.options.series.length });
+    },
+
+    echarts_on(eventName, query) {
+      this.chart.on(eventName.replace(/^chart:/, ''), query, (e) => {
+        this.$emit(eventName, e);
+      });
+    },
+
+    run_chart_method(name, ...args) {
+      if (name.startsWith(":")) {
+        name = name.slice(1);
+        args = args.map((arg) => new Function("return " + arg)());
+      }
+      return runMethod(this.chart, name, args);
+    },
+  },
+  props: {
+    options: Object | undefined,
+    theme: String | Object | undefined,
+    code: String | undefined,
+  },
+};

{ex4nicegui-0.6.4 → ex4nicegui-0.6.6}/ex4nicegui/reactive/EChartsComponent/ECharts.py

@@ -3,70 +3,26 @@ from typing import (
     Any,
     Callable,
     Dict,
-    List,
     Optional,
     Union,
 )
-from typing_extensions import Literal
-from dataclasses import dataclass
-from nicegui.dataclasses import KWONLY_SLOTS
-from nicegui.events import (
-    handle_event,
-    UiEventArguments,
-)
+
+from nicegui.events import handle_event, UiEventArguments, GenericEventArguments
 from nicegui.element import Element
 from nicegui.awaitable_response import AwaitableResponse
-from nicegui import context as ng_context
 from pathlib import Path
 import nicegui
-import uuid
+
+from .types import (
+    _T_event_name,
+)
+from ex4nicegui.reactive.deferredTask import DeferredTask
+from .utils import get_bound_event_args, create_event_handler_args
 
 NG_ROOT = Path(nicegui.__file__).parent / "elements"
 libraries = [NG_ROOT / "lib/echarts/echarts.min.js"]
 
 
-_Chart_Click_Args = [
-    "componentType",
-    "seriesType",
-    "seriesIndex",
-    "seriesName",
-    "name",
-    "dataIndex",
-    "data",
-    "dataType",
-    "value",
-    "color",
-]
-
-
-@dataclass(**KWONLY_SLOTS)
-class EChartsMouseEventArguments(UiEventArguments):
-    componentType: str
-    seriesType: str
-    seriesIndex: int
-    seriesName: str
-    name: str
-    dataIndex: int
-    data: dict
-    dataType: Optional[str]
-    value: Any
-    color: str
-
-
-_T_echats_on_callback = Callable[[EChartsMouseEventArguments], Any]
-_T_mouse_event_name = Literal[
-    "click",
-    "dblclick",
-    "mousedown",
-    "mousemove",
-    "mouseup",
-    "mouseover",
-    "mouseout",
-    "globalout",
-    "contextmenu",
-]
-
-
 class echarts(Element, component="ECharts.js", libraries=libraries):  # type: ignore
     def __init__(
         self,
@@ -74,6 +30,7 @@ class echarts(Element, component="ECharts.js", libraries=libraries):  # type: ig
         code: Optional[str] = None,
     ) -> None:
         super().__init__()
+        self.__deferred_task = DeferredTask()
 
         if (options is None) and (bool(code) is False):
             raise ValueError("At least one of options and code must be valid.")
@@ -89,36 +46,6 @@ class echarts(Element, component="ECharts.js", libraries=libraries):  # type: ig
         self._props["options"] = options
         self._props["code"] = code
 
-        self._echarts_on_tasks: List[Callable] = []
-        self._echarts_on_callback_map: Dict[str, _T_echats_on_callback] = {}
-
-        async def on_client_connect(
-            client: nicegui.Client,
-        ) -> Any:
-            await client.connected()
-
-            for func in self._echarts_on_tasks:
-                func()
-
-            client.connect_handlers.remove(on_client_connect)  # type: ignore
-
-        ng_context.get_client().on_connect(on_client_connect)
-
-        def echartsOn_handler(e):
-            callbackId = e.args["callbackId"]
-            params: Dict = e.args["params"]
-            params["dataType"] = params.get("dataType")
-
-            if callbackId in self._echarts_on_callback_map:
-                event_args = EChartsMouseEventArguments(
-                    sender=e.sender, client=e.client, **params
-                )
-                handler = self._echarts_on_callback_map[callbackId]
-
-                handle_event(handler, event_args)
-
-        self.on("event_on", echartsOn_handler)
-
     def update_chart(
         self,
         merge_opts: Optional[dict] = None,
@@ -164,34 +91,24 @@ class echarts(Element, component="ECharts.js", libraries=libraries):  # type: ig
                 ),
             )
 
-        self.on(
-            "clickBlank",
-            inner_handler,
-            _Chart_Click_Args,
-        )
+        self.on("clickBlank", inner_handler)
 
     def echarts_on(
         self,
-        event_name: _T_mouse_event_name,
-        handler: _T_echats_on_callback,
+        event_name: _T_event_name,
+        handler: Callable[[UiEventArguments], None],
         query: Optional[Union[str, Dict]] = None,
     ):
-        if not ng_context.get_client().has_socket_connection:
+        def org_handler(e: GenericEventArguments) -> None:
+            event_args = create_event_handler_args(event_name, e)
+            handle_event(handler, event_args)
 
-            def task_func():
-                self.echarts_on(event_name, handler, query)
+        ui_event_name = f"chart:{event_name}"
+        super().on(ui_event_name, org_handler, args=get_bound_event_args(event_name))
 
-            self._echarts_on_tasks.append(task_func)
-            return
-
-        callback_id = uuid.uuid4().hex
-        self.run_method(
-            "echarts_on",
-            event_name,
-            query,
-            callback_id,
-        )
-        self._echarts_on_callback_map[callback_id] = handler
+        @self.__deferred_task.register
+        def _():
+            self.run_method("echarts_on", ui_event_name, query)
 
     def run_chart_method(
         self, name: str, *args, timeout: float = 1, check_interval: float = 0.01

ex4nicegui-0.6.6/ex4nicegui/reactive/EChartsComponent/events.py

@@ -0,0 +1,26 @@
+from typing import (
+    Any,
+    Optional,
+)
+from dataclasses import dataclass, fields
+from nicegui.dataclasses import KWONLY_SLOTS
+from nicegui.events import (
+    UiEventArguments,
+)
+
+
+@dataclass(**KWONLY_SLOTS)
+class EChartsMouseEventArguments(UiEventArguments):
+    componentType: str
+    seriesType: str
+    seriesIndex: int
+    seriesName: str
+    name: str
+    dataIndex: int
+    data: dict
+    dataType: Optional[str]
+    value: Any
+    color: str
+
+
+_Mouse_Event_Arguments_Fields = [f.name for f in fields(EChartsMouseEventArguments)]

ex4nicegui-0.6.6/ex4nicegui/reactive/EChartsComponent/types.py

@@ -0,0 +1,51 @@
+from typing import (
+    Union,
+)
+from typing_extensions import Literal
+
+
+_T_mouse_event_name = Literal[
+    "click",
+    "dblclick",
+    "mousedown",
+    "mousemove",
+    "mouseup",
+    "mouseover",
+    "mouseout",
+    "globalout",
+    "contextmenu",
+]
+
+_T_generic_event_name = Literal[
+    "highlight",
+    "downplay",
+    "selectchanged",
+    "legendselectchanged",
+    "legendselected",
+    "legendunselected",
+    "legendselectall",
+    "legendinverseselect",
+    "legendscroll",
+    "datazoom",
+    "datarangeselected",
+    "graphroam",
+    "georoam",
+    "treeroam",
+    "timelinechanged",
+    "timelineplaychanged",
+    "restore",
+    "dataviewchanged",
+    "magictypechanged",
+    "geoselectchanged",
+    "geoselected",
+    "geounselected",
+    "axisareaselected",
+    "brush",
+    "brushEnd",
+    "brushselected",
+    "globalcursortaken",
+    "rendered",
+    "finished",
+]
+
+_T_event_name = Union[_T_mouse_event_name, _T_generic_event_name]

ex4nicegui-0.6.6/ex4nicegui/reactive/EChartsComponent/utils.py

@@ -0,0 +1,44 @@
+from typing import List, Optional
+import typing
+from .types import _T_event_name, _T_mouse_event_name
+from .events import EChartsMouseEventArguments, _Mouse_Event_Arguments_Fields
+from nicegui.events import UiEventArguments, GenericEventArguments
+from functools import lru_cache
+
+
+@lru_cache(maxsize=1)
+def _get_mouse_event_names():
+    return set(typing.get_args(_T_mouse_event_name))
+
+
+def is_mouse_event(event_name: _T_event_name) -> bool:
+    return event_name in _get_mouse_event_names()
+
+
+def get_bound_event_args(event_name: _T_event_name) -> Optional[List[str]]:
+    if is_mouse_event(event_name):
+        return _Mouse_Event_Arguments_Fields
+
+    return None
+
+
+def create_event_handler_args(
+    event_name: _T_event_name, e: GenericEventArguments
+) -> UiEventArguments:
+    if is_mouse_event(event_name):
+        return EChartsMouseEventArguments(
+            sender=e.sender,
+            client=e.client,
+            componentType=e.args["componentType"],
+            seriesType=e.args["seriesType"],
+            seriesIndex=e.args["seriesIndex"],
+            seriesName=e.args["seriesName"],
+            name=e.args["name"],
+            dataIndex=e.args["dataIndex"],
+            data=e.args["data"],
+            dataType=e.args.get("dataType"),
+            value=e.args["value"],
+            color=e.args["color"],
+        )
+
+    return GenericEventArguments(sender=e.sender, client=e.client, args=e.args)

ex4nicegui-0.6.6/ex4nicegui/reactive/deferredTask.py

@@ -0,0 +1,29 @@
+from typing import Callable
+from nicegui import ui, Client as ng_client
+
+
+class DeferredTask:
+    def __init__(self):
+        self._tasks = []
+
+        async def on_client_connect(
+            client: ng_client,
+        ):
+            await client.connected()
+
+            for task in self._tasks:
+                task()
+
+            self._tasks.clear()
+
+            # Avoid events becoming ineffective due to page refresh when sharing the client.
+            if not client.shared:
+                client.connect_handlers.remove(on_client_connect)  # type: ignore
+
+        ui.context.client.on_connect(on_client_connect)
+
+    def register(self, task: Callable[..., None]):
+        if ui.context.client.has_socket_connection:
+            task()
+        else:
+            self._tasks.append(task)