ex4nicegui 0.4.5__tar.gz → 0.4.7__tar.gz

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ex4nicegui
-Version: 0.4.5
+Version: 0.4.7
 Summary: ...
 Home-page: 
 Author: carson_jia

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/README.md

@@ -159,6 +159,223 @@ ui.run()
 ```
 
 
+## 组件功能
+
+### 绑定类名
+
+所有的组件类提供 `bind_classes` 用于绑定 `class`，支持三种不同的数据结构。
+
+绑定字典
+
+```python
+bg_color = to_ref(False)
+has_error = to_ref(False)
+
+rxui.label("test").bind_classes({"bg-blue": bg_color, "text-red": has_error})
+
+rxui.switch("bg_color", value=bg_color)
+rxui.switch("has_error", value=has_error)
+```
+
+字典键值为类名,对应值为 bool 的响应式变量。当响应式值为 `True`，类名应用到组件 class
+
+
+---
+
+绑定返回值为字典的响应式变量
+
+```python
+bg_color = to_ref(False)
+has_error = to_ref(False)
+
+class_obj = ref_computed(
+    lambda: {"bg-blue": bg_color.value, "text-red": has_error.value}
+)
+
+rxui.switch("bg_color", value=bg_color)
+rxui.switch("has_error", value=has_error)
+rxui.label("bind to ref_computed").bind_classes(class_obj)
+```
+
+---
+
+绑定为列表
+
+```python
+bg_color = to_ref("red")
+bg_color_class = ref_computed(lambda: f"bg-{bg_color.value}")
+
+text_color = to_ref("green")
+text_color_class = ref_computed(lambda: f"text-{text_color.value}")
+
+rxui.select(["red", "green", "yellow"], label="bg color", value=bg_color)
+rxui.select(["red", "green", "yellow"], label="text color", value=text_color)
+
+rxui.label("binding to arrays").bind_classes([bg_color_class, text_color_class])
+
+```
+
+列表中每个元素为返回类名的响应式变量
+
+---
+
+### bind-style
+
+```python
+from nicegui import ui
+from ex4nicegui.reactive import rxui
+from ex4nicegui.utils.signals import to_ref
+
+
+bg_color = to_ref("blue")
+text_color = to_ref("red")
+
+rxui.label("test").bind_style(
+    {
+        "background-color": bg_color,
+        "color": text_color,
+    }
+)
+
+rxui.select(["blue", "green", "yellow"], label="bg color", value=bg_color)
+rxui.select(["red", "green", "yellow"], label="text color", value=text_color)
+```
+
+`bind_style` 传入字典，`key` 为样式名字，`value` 为样式值，响应式字符串
+
+
+---
+
+## 响应式
+
+```python
+from ex4nicegui import (
+    to_ref,
+    ref_computed,
+    on,
+    effect,
+    effect_refreshable,
+    batch,
+    event_batch,
+)
+```
+常用 `to_ref`,`effect`,`ref_computed`,`on`
+
+---
+
+### `to_ref`
+定义响应式对象,通过 `.value` 读写
+```python
+a = to_ref(1)
+b = to_ref("text")
+
+a.value =2
+b.value = 'new text'
+
+print(a.value)
+```
+
+---
+
+### `effect`
+接受一个函数,自动监控函数中使用到的响应式对象变化,从而自动执行函数
+
+```python
+a = to_ref(1)
+b = to_ref("text")
+
+
+@effect
+def auto_run_when_ref_value():
+    print(f"a:{a.value}")
+
+
+def change_value():
+    a.value = 2
+    b.value = "new text"
+
+
+ui.button("change", on_click=change_value)
+```
+
+首次执行 effect ,函数`auto_run_when_ref_value`将被执行一次.之后点击按钮,改变 `a` 的值(通过 `a.value`),函数`auto_run_when_ref_value`再次执行
+
+---
+
+### `ref_computed`
+与 `effect` 具备一样的功能，`ref_computed` 还能从函数中返回结果。一般用于从 `to_ref` 中进行二次计算
+
+```python
+a = to_ref(1)
+a_square = ref_computed(lambda: a.value * 2)
+
+
+@effect
+def effect1():
+    print(f"a_square:{a_square.value}")
+
+
+def change_value():
+    a.value = 2
+
+
+ui.button("change", on_click=change_value)
+```
+
+点击按钮后，`a.value` 值被修改，从而触发 `a_square` 重新计算.由于 `effect1` 中读取了 `a_square` 的值，从而触发 `effect1` 执行
+
+> `ref_computed` 是只读的 `to_ref`
+
+---
+
+### `on`
+类似 `effect` 的功能,但是 `on` 需要明确指定监控的响应式对象
+
+```python
+
+a1 = to_ref(1)
+a2 = to_ref(10)
+b = to_ref("text")
+
+
+@on(a1)
+def watch_a1_only():
+    print(f"watch_a1_only ... a1:{a1.value},a2:{a2.value}")
+
+
+@on([a1, b], onchanges=True)
+def watch_a1_and_b():
+    print(f"watch_a1_and_b ... a1:{a1.value},a2:{a2.value},b:{b.value}")
+
+
+def change_a1():
+    a1.value += 1
+    ui.notify("change_a1")
+
+
+ui.button("change a1", on_click=change_a1)
+
+
+def change_a2():
+    a2.value += 1
+    ui.notify("change_a2")
+
+
+ui.button("change a2", on_click=change_a2)
+
+
+def change_b():
+    b.value += "x"
+    ui.notify("change_b")
+
+
+ui.button("change b", on_click=change_b)
+
+```
+
+- 参数 `onchanges` 为 True 时(默认值为 False),指定的函数不会在绑定时执行 
+
+---
 
 ## BI 模块
 

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/__init__.py

@@ -19,4 +19,4 @@ from ex4nicegui.experimental_ import (
 )
 
 
-__version__ = "0.4.5"
+__version__ = "0.4.7"

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/bi/dataSourceFacade.py

@@ -24,7 +24,9 @@ from .elements.ui_table import ui_table
 from ex4nicegui.bi import types as bi_types
 
 if TYPE_CHECKING:
-    from ex4nicegui.bi.elements.models import UiResult
+    from ex4nicegui.bi.elements.models import (
+        UiResult,
+    )
 
 _TData = TypeVar("_TData")
 
@@ -41,7 +43,9 @@ class DataSourceFacade(Generic[_TData]):
     @property
     def filtered_data(self) -> _TData:
         """Data after filtering"""
-        return cast(_TData, self._dataSource.filtered_data)
+        return cast(
+            _TData, self._dataSource.filtered_data
+        )
 
     def reload(self, data, reset_filters=True):
         """Reload the data source with the provided new data.
@@ -55,7 +59,9 @@ class DataSourceFacade(Generic[_TData]):
         if reset_filters:
             self.remove_filters()
 
-    def remove_filters(self, *components: UiResult):
+    def remove_filters(
+        self, *components: UiResult
+    ):
         """Remove the filter from the data source"""
         if len(components) == 0:
             # remove all
@@ -67,7 +73,9 @@ class DataSourceFacade(Generic[_TData]):
         self,
         column: str,
         *,
-        sort_options: Optional[bi_types._TDuplicates_column_values_sort_options] = None,
+        sort_options: Optional[
+            bi_types._TDuplicates_column_values_sort_options
+        ] = None,
         exclude_null_value=False,
         clearable=True,
         multiple=True,
@@ -76,8 +84,8 @@ class DataSourceFacade(Generic[_TData]):
         """
         Creates a user interface select box.
 
-        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#dsui_select
-        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#dsui_select
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#ui_select
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#ui_select
 
 
         Args:
@@ -89,11 +97,20 @@ class DataSourceFacade(Generic[_TData]):
         Returns:
             SelectResult: An instance of a user interface select box.
         """
-        kws = {key: value for key, value in locals().items() if key not in ("kwargs")}
+        kws = {
+            key: value
+            for key, value in locals().items()
+            if key not in ("kwargs")
+        }
         kws.update(kwargs)
         return ui_select(**kws)
 
-    def ui_aggrid(self, *, options: Optional[Dict] = None, **kwargs):
+    def ui_aggrid(
+        self,
+        *,
+        options: Optional[Dict] = None,
+        **kwargs,
+    ):
         """
         Creates aggrid table.
 
@@ -107,7 +124,11 @@ class DataSourceFacade(Generic[_TData]):
         Returns:
             ui.aggrid: aggrid table.
         """
-        kws = {key: value for key, value in locals().items() if key not in ("kwargs")}
+        kws = {
+            key: value
+            for key, value in locals().items()
+            if key not in ("kwargs")
+        }
         kws.update(kwargs)
         return ui_aggrid(**kws)
 
@@ -131,7 +152,11 @@ class DataSourceFacade(Generic[_TData]):
         Returns:
             ui.table: ui.table.
         """
-        kws = {key: value for key, value in locals().items() if key not in ("kwargs")}
+        kws = {
+            key: value
+            for key, value in locals().items()
+            if key not in ("kwargs")
+        }
         kws.update(kwargs)
         return ui_table(**kws)
 
@@ -139,10 +164,14 @@ class DataSourceFacade(Generic[_TData]):
         self,
         column: str,
         *,
-        sort_options: Optional[bi_types._TDuplicates_column_values_sort_options] = None,
+        sort_options: Optional[
+            bi_types._TDuplicates_column_values_sort_options
+        ] = None,
         exclude_null_value=False,
         hide_filtered=True,
-        custom_options_map: Optional[Union[Dict, Callable[[Any], Any]]] = None,
+        custom_options_map: Optional[
+            Union[Dict, Callable[[Any], Any]]
+        ] = None,
         **kwargs,
     ):
         """
@@ -160,7 +189,11 @@ class DataSourceFacade(Generic[_TData]):
         Returns:
             RadioResult: An radio Selection.
         """
-        kws = {key: value for key, value in locals().items() if key not in ("kwargs")}
+        kws = {
+            key: value
+            for key, value in locals().items()
+            if key not in ("kwargs")
+        }
         kws.update(kwargs)
         return ui_radio(**kws)
 
@@ -180,7 +213,11 @@ class DataSourceFacade(Generic[_TData]):
         Returns:
             ui.radio: An Slider.
         """
-        kws = {key: value for key, value in locals().items() if key not in ("kwargs")}
+        kws = {
+            key: value
+            for key, value in locals().items()
+            if key not in ("kwargs")
+        }
         kws.update(kwargs)
         return ui_slider(**kws)
 
@@ -200,12 +237,19 @@ class DataSourceFacade(Generic[_TData]):
         Returns:
             QRange: An Range.
         """
-        kws = {key: value for key, value in locals().items() if key not in ("kwargs")}
+        kws = {
+            key: value
+            for key, value in locals().items()
+            if key not in ("kwargs")
+        }
         kws.update(kwargs)
         return ui_range(**kws)
 
     def ui_echarts(
-        self, fn: Callable[[Any], Union[Dict, "pyecharts.Base"]]  # pyright: ignore
+        self,
+        fn: Callable[
+            [Any], Union[Dict, "pyecharts.Base"]
+        ],  # pyright: ignore
     ):
         """Create charts
 
@@ -246,10 +290,20 @@ class DataSourceFacade(Generic[_TData]):
         return ui_echarts(self, fn)
 
     def send_filter(
-        self, element: ui.element, filter: bi_types._TFilterCallback[_TData]
+        self,
+        element: ui.element,
+        filter: bi_types._TFilterCallback[_TData],
     ):
         ele_id = element.id
-        key = self._dataSource.get_component_info_key(ele_id)
-        if not self._dataSource._component_map.has_record(key):
-            self._dataSource._register_component(ele_id)
-        self._dataSource.send_filter(ele_id, Filter(filter))
+        key = self._dataSource.get_component_info_key(
+            ele_id
+        )
+        if not self._dataSource._component_map.has_record(
+            key
+        ):
+            self._dataSource._register_component(
+                ele_id
+            )
+        self._dataSource.send_filter(
+            ele_id, Filter(filter)
+        )

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/bi/index.py

@@ -10,7 +10,7 @@ _TData = TypeVar("_TData")
 def data_source(data: Union[Callable[..., _TData], _TData]) -> DataSourceFacade[_TData]:
     """Create a data source
 
-    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/docs/apis/README.en.md#bidata_source
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#bidata_source
     @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#bidata_source
 
     Args:

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/reactive/officials/aggrid.py

@@ -4,7 +4,6 @@ from typing import (
     Dict,
     Optional,
 )
-import ex4nicegui.utils.common as utils_common
 from ex4nicegui.utils.signals import (
     effect,
     ReadonlyRef,
@@ -25,7 +24,7 @@ class AggridBindableUi(BindableUi[ui.aggrid]):
         html_columns: TMaybeRef[List[int]] = [],
         theme: TMaybeRef[str] = "balham",
         auto_size_columns: bool = True,
-        **org_kws
+        **org_kws,
     ) -> None:
         kws = {
             "options": options,
@@ -54,21 +53,17 @@ class AggridBindableUi(BindableUi[ui.aggrid]):
     def from_pandas(
         df: TMaybeRef,
         columns_define_fn: Optional[Callable[[str], Dict]] = None,
-        **org_kws
+        **org_kws,
     ):
         columns_define_fn = columns_define_fn or (lambda x: {})
         if is_ref(df):
 
-            @ref_computed
-            def cp_convert_df():
-                return utils_common.convert_dataframe(df.value)
-
             @ref_computed
             def cp_options():
                 columnDefs = AggridBindableUi._get_columnDefs_from_dataframe(
-                    cp_convert_df.value, columns_define_fn
+                    df.value, columns_define_fn
                 )
-                rowData = cp_convert_df.value.to_dict("records")
+                rowData = df.value.to_dict("records")
                 data = {"columnDefs": columnDefs, "rowData": rowData}
                 return data
 

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/reactive/officials/base.py

@@ -3,12 +3,13 @@ from __future__ import annotations
 from typing import (
     Any,
     Callable,
+    Dict,
     List,
     Optional,
     TypeVar,
     Generic,
+    Union,
     cast,
-    overload,
 )
 from typing_extensions import Self
 from ex4nicegui.utils.signals import (
@@ -18,6 +19,10 @@ from ex4nicegui.utils.signals import (
     ref_computed,
     _TMaybeRef as TMaybeRef,
     effect,
+    to_value,
+    is_ref,
+    on,
+    signe_utils,
 )
 from nicegui import Tailwind, ui
 from nicegui.elements.mixins.color_elements import (
@@ -26,11 +31,22 @@ from nicegui.elements.mixins.color_elements import (
     TAILWIND_COLORS,
 )
 from nicegui.elements.mixins.text_element import TextElement
+from nicegui.elements.mixins.disableable_element import DisableableElement
+
 
 T = TypeVar("T")
 
 TWidget = TypeVar("TWidget", bound=ui.element)
 
+_T_bind_classes_type_dict = Dict[str, TMaybeRef[bool]]
+_T_bind_classes_type_ref_dict = ReadonlyRef[Dict[str, bool]]
+_T_bind_classes_type_array = List[Union[ReadonlyRef[str], Ref[str]]]
+
+
+_T_bind_classes_type = Union[
+    _T_bind_classes_type_dict, _T_bind_classes_type_ref_dict, _T_bind_classes_type_array
+]
+
 
 class BindableUi(Generic[TWidget]):
     def __init__(self, element: TWidget) -> None:
@@ -144,6 +160,68 @@ class BindableUi(Generic[TWidget]):
     def clear(self) -> None:
         cast(ui.element, self.element).clear()
 
+    def bind_classes(self, classes: _T_bind_classes_type):
+        """data binding is manipulating an element's class list
+
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#bind-class-names
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#%E7%BB%91%E5%AE%9A%E7%B1%BB%E5%90%8D
+
+        Args:
+            classes (_T_bind_classes_type):
+        """
+        if isinstance(classes, dict):
+            for name, ref_obj in classes.items():
+
+                @effect
+                def _(name=name, ref_obj=ref_obj):
+                    if to_value(ref_obj):
+                        self.classes(add=name)
+                    else:
+                        self.classes(remove=name)
+
+        elif isinstance(classes, (Ref, ReadonlyRef)):
+            ref_obj = to_value(classes)
+            assert isinstance(ref_obj, dict)
+
+            @effect
+            def _():
+                for name, value in to_value(classes).items():
+                    if value:
+                        self.classes(add=name)
+                    else:
+                        self.classes(remove=name)
+        elif isinstance(classes, list):
+            for ref_name in classes:
+                if is_ref(ref_name):
+
+                    @on(ref_name)
+                    def _(state: signe_utils.WatchedState):
+                        self.classes(add=state.current, remove=state.previous)
+                else:
+                    self.classes(ref_name)  # type: ignore
+
+        return self
+
+    def bind_style(self, style: Dict[str, Union[ReadonlyRef[str], Ref[str]]]):
+        """data binding is manipulating an element's style
+
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#bind-style
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#bind-style
+
+        Args:
+            style (Dict[str, Union[ReadonlyRef[str], Ref[str]]]): _description_
+        """
+        if isinstance(style, dict):
+            for name, ref_obj in style.items():
+                if is_ref(ref_obj):
+
+                    @effect
+                    def _(name=name, ref_obj=ref_obj):
+                        self.element._style[name] = ref_obj.value
+                        self.element.update()
+
+        return self
+
 
 class SingleValueBindableUi(BindableUi[TWidget], Generic[T, TWidget]):
     def __init__(self, value: TMaybeRef[T], element: TWidget) -> None:
@@ -162,9 +240,6 @@ class SingleValueBindableUi(BindableUi[TWidget], Generic[T, TWidget]):
         return self
 
 
-from nicegui.elements.mixins.disableable_element import DisableableElement
-
-
 _T_DisableableBinder = TypeVar("_T_DisableableBinder", bound=DisableableElement)
 
 

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/reactive/officials/echarts.py

@@ -68,6 +68,8 @@ class EChartsBindableUi(BindableUi[echarts]):
 
             @ref_computed
             def chart_opt():
+                if not bool(chart.value):
+                    return {}
                 return EChartsBindableUi._pyecharts2opts(chart.value)
 
             return EChartsBindableUi(chart_opt)

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/reactive/officials/number.py

@@ -21,15 +21,10 @@ T = TypeVar("T")
 class NumberBindableUi(SingleValueBindableUi[float, ui.number]):
     @staticmethod
     def _setup_(binder: "NumberBindableUi"):
-        def onValueChanged(e):
-            binder._ref.value = e.args  # type: ignore
-
         @effect
         def _():
             binder.element.value = binder.value
 
-        binder.element.on("update:modelValue", handler=onValueChanged)
-
     def __init__(
         self,
         label: Optional[TMaybeRef[str]] = None,
@@ -61,13 +56,20 @@ class NumberBindableUi(SingleValueBindableUi[float, ui.number]):
 
         value_kws = _convert_kws_ref2value(kws)
 
+        def inject_on_change(e):
+            self._ref.value = e.value
+            if on_change:
+                on_change(e)
+
+        value_kws.update({"on_change": inject_on_change})
+
         element = ui.number(**value_kws)
         element.classes("min-w-[10rem]")
 
-        super().__init__(value, element)
+        super().__init__(value, element)  # type: ignore
 
         for key, value in kws.items():
-            if is_ref(value):
-                self.bind_prop(key, value)
+            if key != "value" and is_ref(value):
+                self.bind_prop(key, value)  # type: ignore
 
         NumberBindableUi._setup_(self)

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/reactive/officials/table.py

@@ -4,7 +4,6 @@ from typing import (
     List,
     Optional,
     Dict,
-    cast,
 )
 from typing_extensions import Literal
 import ex4nicegui.utils.common as utils_common
@@ -19,11 +18,6 @@ from ex4nicegui.utils.signals import (
 from nicegui import ui
 from .base import BindableUi
 from .utils import _convert_kws_ref2value
-from nicegui.events import (
-    GenericEventArguments,
-    TableSelectionEventArguments,
-    handle_event,
-)
 
 
 class TableBindableUi(BindableUi[ui.table]):
@@ -61,10 +55,10 @@ class TableBindableUi(BindableUi[ui.table]):
         self._arg_row_key = row_key
         self._selection_ref: ReadonlyRef[List[Any]] = to_ref([])
 
-        def on_select(_):
+        def on_selection(_):
             self._selection_ref.value = self.element.selected  # type: ignore
 
-        self.element.on("selection", on_select)
+        self.element.on("selection", on_selection)
 
     @property
     def selection_ref(self):
@@ -92,13 +86,9 @@ class TableBindableUi(BindableUi[ui.table]):
 
         if is_ref(df):
 
-            @ref_computed
-            def cp_convert_df():
-                return utils_common.convert_dataframe(df.value)
-
             @ref_computed
             def cp_rows():
-                return cp_convert_df.value.to_dict("records")
+                return df.value.to_dict("records")
 
             @ref_computed
             def cp_cols():
@@ -109,15 +99,14 @@ class TableBindableUi(BindableUi[ui.table]):
                             "label": col,
                             "field": col,
                         },
-                        **columns_define_fn(col),
+                        **columns_define_fn(col),  # type: ignore
                     }
-                    for col in cp_convert_df.value.columns
+                    for col in df.value.columns
                 ]
 
             return TableBindableUi(cp_cols, cp_rows, **other_kws)
 
-        df = utils_common.convert_dataframe(df)
-        rows = df.to_dict("records")
+        rows = df.to_dict("records")  # type: ignore
 
         cols = [
             {
@@ -128,7 +117,7 @@ class TableBindableUi(BindableUi[ui.table]):
                 },
                 **columns_define_fn(col),
             }
-            for col in df.columns
+            for col in df.columns  # type: ignore
         ]
         return TableBindableUi(cols, rows, **other_kws)
 

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui/utils/signals.py

@@ -94,6 +94,17 @@ def to_value(maybe_ref: _TMaybeRef[T]) -> T:
 
 
 def to_ref(maybe_ref: _TMaybeRef[T]):
+    """Takes an inner value and returns a reactive and mutable ref object, which has a single property .value that points to the inner value.
+
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#to_ref
+    @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#to_ref
+
+
+    Args:
+        maybe_ref (_TMaybeRef[T]): _description_
+
+
+    """
     if is_ref(maybe_ref):
         return cast(Ref[T], maybe_ref)
 
@@ -128,6 +139,19 @@ def effect(
     debug_trigger: Optional[Callable] = None,
     debug_name: Optional[str] = None,
 ) -> signe_utils._TEffect_Fn[None]:
+    """Runs a function immediately while reactively tracking its dependencies and re-runs it whenever the dependencies are changed.
+
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#effect
+    @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#effect
+
+
+    Args:
+        fn (None, optional): _description_. Defaults to ....
+        priority_level (int, optional): _description_. Defaults to 1.
+        debug_trigger (Optional[Callable], optional): _description_. Defaults to None.
+        debug_name (Optional[str], optional): _description_. Defaults to None.
+
+    """
     ...
 
 
@@ -166,6 +190,20 @@ def ref_computed(
     priority_level: int = 1,
     debug_name: Optional[str] = None,
 ) -> ReadonlyRef[T]:
+    """Takes a getter function and returns a readonly reactive ref object for the returned value from the getter. It can also take an object with get and set functions to create a writable ref object.
+
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#ref_computed
+    @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#ref_computed
+
+
+    Args:
+        fn (Callable[[], T]): _description_
+        desc (str, optional): _description_. Defaults to "".
+        debug_trigger (Optional[Callable[..., None]], optional): _description_. Defaults to None.
+        priority_level (int, optional): _description_. Defaults to 1.
+        debug_name (Optional[str], optional): _description_. Defaults to None.
+
+    """
     ...
 
 
@@ -251,6 +289,19 @@ def on(
     priority_level=1,
     effect_kws: Optional[Dict[str, Any]] = None,
 ):
+    """Watches one or more reactive data sources and invokes a callback function when the sources change.
+
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#on
+    @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#on
+
+
+    Args:
+        refs (Union[ReadonlyRef, Sequence[ReadonlyRef]]): _description_
+        onchanges (bool, optional): _description_. Defaults to False.
+        priority_level (int, optional): _description_. Defaults to 1.
+        effect_kws (Optional[Dict[str, Any]], optional): _description_. Defaults to None.
+
+    """
     effect_kws = effect_kws or {}
     if not isinstance(refs, Sequence):
         refs = [refs]

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ex4nicegui
-Version: 0.4.5
+Version: 0.4.7
 Summary: ...
 Home-page: 
 Author: carson_jia

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/ex4nicegui.egg-info/requires.txt

@@ -1,3 +1,3 @@
-signe>=0.2.5
+signe>=0.2.6
 nicegui>=1.4.0
 typing_extensions

{ex4nicegui-0.4.5 → ex4nicegui-0.4.7}/setup.py

@@ -21,7 +21,7 @@ def get_data_files(base):
 with open("README.md", encoding="utf8") as readme_file:
     readme = readme_file.read()
 
-requirements = ["signe>=0.2.5", "nicegui>=1.4.0", "typing_extensions"]
+requirements = ["signe>=0.2.6", "nicegui>=1.4.0", "typing_extensions"]
 
 test_requirements = ["pytest>=3", "playwright", "pandas"]