ex4nicegui 0.6.5__py3-none-any.whl → 0.6.7__py3-none-any.whl

ex4nicegui/reactive/officials/switch.py

@@ -8,7 +8,7 @@ from ex4nicegui.reactive.utils import ParameterClassifier
 from ex4nicegui.utils.apiEffect import ui_effect
 
 from ex4nicegui.utils.signals import (
-    ReadonlyRef,
+    TGetterOrReadonlyRef,
     _TMaybeRef as TMaybeRef,
     to_value,
 )
@@ -49,13 +49,13 @@ class SwitchBindableUi(BindableUi[ui.switch]):
     def value(self):
         return self.element.value
 
-    def bind_prop(self, prop: str, ref_ui: ReadonlyRef):
+    def bind_prop(self, prop: str, ref_ui: TGetterOrReadonlyRef):
         if prop == "value":
             return self.bind_value(ref_ui)
 
         return super().bind_prop(prop, ref_ui)
 
-    def bind_value(self, ref_ui: ReadonlyRef[bool]):
+    def bind_value(self, ref_ui: TGetterOrReadonlyRef[bool]):
         @ui_effect
         def _():
             self.element.set_value(to_value(ref_ui))

ex4nicegui/reactive/officials/tab_panels.py

@@ -1,6 +1,7 @@
 from typing import Any, Callable, Optional
 from ex4nicegui.reactive.utils import ParameterClassifier
 from ex4nicegui.utils.signals import (
+    TGetterOrReadonlyRef,
     to_value,
     _TMaybeRef as TMaybeRef,
 )
@@ -17,6 +18,17 @@ class TabPanelsBindableUi(BindableUi[ui.tab_panels]):
         animated: TMaybeRef[bool] = True,
         keep_alive: TMaybeRef[bool] = True,
     ) -> None:
+        """Tab Panels
+
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#tab_panels
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#tab_panels
+
+        Args:
+            value (TMaybeRef[str], optional): The value of the tab panel. Defaults to None.
+            on_change (Callable[..., Any], optional): The callback function when the value of the tab panel changes. Defaults to None.
+            animated (TMaybeRef[bool], optional): Whether to animate the tab panel. Defaults to True.
+            keep_alive (TMaybeRef[bool], optional): Whether to keep the tab panel alive. Defaults to True.
+        """
         pc = ParameterClassifier(
             locals(),
             maybeRefs=["value", "animated", "keep_alive"],
@@ -34,13 +46,13 @@ class TabPanelsBindableUi(BindableUi[ui.tab_panels]):
     def value(self):
         return self.element.value
 
-    def bind_prop(self, prop: str, ref_ui: TMaybeRef):
+    def bind_prop(self, prop: str, ref_ui: TGetterOrReadonlyRef):
         if prop == "value":
             return self.bind_value(ref_ui)
 
         return super().bind_prop(prop, ref_ui)
 
-    def bind_value(self, ref_ui: TMaybeRef):
+    def bind_value(self, ref_ui: TGetterOrReadonlyRef):
         @self._ui_effect
         def _():
             self.element.set_value(to_value(ref_ui))

ex4nicegui/reactive/officials/table.py

@@ -9,6 +9,7 @@ from typing_extensions import Literal
 from ex4nicegui.reactive.utils import ParameterClassifier, dataframe2col_str
 import ex4nicegui.utils.common as utils_common
 from ex4nicegui.utils.signals import (
+    TGetterOrReadonlyRef,
     ReadonlyRef,
     is_ref,
     ref_computed,
@@ -143,7 +144,7 @@ class TableBindableUi(BindableUi[ui.table]):
         ]
         return cls(cols, rows, **other_kws)
 
-    def bind_prop(self, prop: str, ref_ui: ReadonlyRef):
+    def bind_prop(self, prop: str, ref_ui: TGetterOrReadonlyRef):
         if prop == "dataframe":
             return self.bind_dataframe(ref_ui)
 
@@ -155,7 +156,7 @@ class TableBindableUi(BindableUi[ui.table]):
 
         return super().bind_prop(prop, ref_ui)
 
-    def bind_dataframe(self, ref_df: ReadonlyRef):
+    def bind_dataframe(self, ref_df: TGetterOrReadonlyRef):
         @ref_computed
         def cp_converted_df():
             df = ref_df.value
@@ -180,7 +181,7 @@ class TableBindableUi(BindableUi[ui.table]):
 
         return self
 
-    def bind_rows(self, ref_ui: ReadonlyRef[List[Dict]]):
+    def bind_rows(self, ref_ui: TGetterOrReadonlyRef[List[Dict]]):
         @on(ref_ui, deep=True)
         def _():
             ele = self.element
@@ -189,7 +190,7 @@ class TableBindableUi(BindableUi[ui.table]):
 
         return self
 
-    def bind_columns(self, ref_ui: ReadonlyRef[List[Dict]]):
+    def bind_columns(self, ref_ui: TGetterOrReadonlyRef[List[Dict]]):
         @on(ref_ui, deep=True)
         def _():
             ele = self.element

ex4nicegui/reactive/officials/tabs.py

@@ -1,6 +1,7 @@
 from typing import Any, Callable, Optional
 from ex4nicegui.reactive.utils import ParameterClassifier
 from ex4nicegui.utils.signals import (
+    TGetterOrReadonlyRef,
     to_value,
     _TMaybeRef as TMaybeRef,
 )
@@ -31,13 +32,13 @@ class TabsBindableUi(BindableUi[ui.tabs]):
     def value(self):
         return self.element.value
 
-    def bind_prop(self, prop: str, ref_ui: TMaybeRef):
+    def bind_prop(self, prop: str, ref_ui: TGetterOrReadonlyRef):
         if prop == "value":
             return self.bind_value(ref_ui)
 
         return super().bind_prop(prop, ref_ui)
 
-    def bind_value(self, ref_ui: TMaybeRef):
+    def bind_value(self, ref_ui: TGetterOrReadonlyRef):
         @self._ui_effect
         def _():
             self.element.set_value(to_value(ref_ui))

ex4nicegui/reactive/officials/textarea.py

@@ -8,7 +8,7 @@ from typing import (
 from ex4nicegui.reactive.utils import ParameterClassifier
 from ex4nicegui.utils.apiEffect import ui_effect
 from ex4nicegui.utils.signals import (
-    ReadonlyRef,
+    TGetterOrReadonlyRef,
     Ref,
     _TMaybeRef as TMaybeRef,
     effect,
@@ -54,13 +54,13 @@ class TextareaBindableUi(BindableUi[ui.textarea]):
     def value(self):
         return self.element.value
 
-    def bind_prop(self, prop: str, ref_ui: ReadonlyRef):
+    def bind_prop(self, prop: str, ref_ui: TGetterOrReadonlyRef):
         if prop == "value":
             return self.bind_value(ref_ui)
 
         return super().bind_prop(prop, ref_ui)
 
-    def bind_value(self, ref_ui: ReadonlyRef[str]):
+    def bind_value(self, ref_ui: TGetterOrReadonlyRef[str]):
         @ui_effect
         def _():
             self.element.set_value(to_value(ref_ui))

ex4nicegui/reactive/q_pagination.py

@@ -1,6 +1,7 @@
 from typing import Any, Optional, Callable
 from ex4nicegui.reactive.utils import ParameterClassifier
 from ex4nicegui.utils.signals import (
+    TGetterOrReadonlyRef,
     to_value,
     _TMaybeRef as TMaybeRef,
 )
@@ -35,13 +36,13 @@ class PaginationBindableUi(BindableUi[ui.pagination]):
     def value(self):
         return self.element.value
 
-    def bind_prop(self, prop: str, ref_ui: TMaybeRef):
+    def bind_prop(self, prop: str, ref_ui: TGetterOrReadonlyRef):
         if prop == "value":
             return self.bind_value(ref_ui)
 
         return super().bind_prop(prop, ref_ui)
 
-    def bind_value(self, ref_ui: TMaybeRef[int]):
+    def bind_value(self, ref_ui: TGetterOrReadonlyRef[int]):
         @self._ui_effect
         def _():
             self.element.set_value(to_value(ref_ui))

ex4nicegui/utils/clientScope.py

@@ -2,7 +2,6 @@ from typing import Dict
 from signe.core.scope import ScopeSuite
 from nicegui import Client, ui
 
-
 _TClientID = str
 
 
@@ -18,12 +17,18 @@ class NgClientScopeManager:
         self._client_scope_map: Dict[_TClientID, NgScopeSuite] = {}
 
     def new_scope(self, detached: bool = False):
-        return self.get_current_scope().scope(detached)
+        """Create a scope that can collect all reactive watch functions within it, allowing for a unified destruction process.
 
-    def get_current_scope(self):
-        # if len(ng_context.get_slot_stack()) <= 0:
-        #     return
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#new_scope
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#new_scope
+
+        Args:
+            detached (bool, optional): Whether the scope should be detached from the client. Defaults to False.
+
+        """
+        return self.get_current_scope().scope(detached=detached)
 
+    def get_current_scope(self):
         client = ui.context.client
 
         if client.id not in self._client_scope_map:
@@ -35,10 +40,13 @@ class NgClientScopeManager:
                 @client.on_disconnect
                 def _(e: Client):
                     if e.id in self._client_scope_map:
-                        self._client_scope_map[e.id]._top_scope.dispose()
+                        self._client_scope_map[e.id]._top_scope.dispose()  # type: ignore
                         del self._client_scope_map[e.id]
 
         return self._client_scope_map[client.id]
 
 
 _CLIENT_SCOPE_MANAGER = NgClientScopeManager()
+
+
+new_scope = _CLIENT_SCOPE_MANAGER.new_scope