nicegui 2.23.2__tar.gz → 2.24.0__tar.gz

{nicegui-2.23.2 → nicegui-2.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nicegui
-Version: 2.23.2
+Version: 2.24.0
 Summary: Create web-based user interfaces with Python. The nice way.
 License: MIT
 Keywords: gui,ui,web,interface,live
@@ -171,6 +171,7 @@ If you would like to support this project and have your avatar or company logo a
   <a href="https://github.com/sereneturtlefox"><img src="https://github.com/sereneturtlefox.png" width="50px" alt="None" /></a>
   <a href="https://github.com/whoulden"><img src="https://github.com/whoulden.png" width="50px" alt="Wayne Houlden" /></a>
   <a href="https://github.com/digiquip"><img src="https://github.com/digiquip.png" width="50px" alt="DigiQuip AS" /></a>
+  <a href="https://github.com/aitech95"><img src="https://github.com/aitech95.png" width="50px" alt="JACOB SHI " /></a>
   <a href="https://github.com/Christian-D-Bock"><img src="https://github.com/Christian-D-Bock.png" width="50px" alt="Christian Bock" /></a>
 </p>
 <!-- SPONSORS -->

{nicegui-2.23.2 → nicegui-2.24.0}/README.md

@@ -117,6 +117,7 @@ If you would like to support this project and have your avatar or company logo a
   <a href="https://github.com/sereneturtlefox"><img src="https://github.com/sereneturtlefox.png" width="50px" alt="None" /></a>
   <a href="https://github.com/whoulden"><img src="https://github.com/whoulden.png" width="50px" alt="Wayne Houlden" /></a>
   <a href="https://github.com/digiquip"><img src="https://github.com/digiquip.png" width="50px" alt="DigiQuip AS" /></a>
+  <a href="https://github.com/aitech95"><img src="https://github.com/aitech95.png" width="50px" alt="JACOB SHI " /></a>
   <a href="https://github.com/Christian-D-Bock"><img src="https://github.com/Christian-D-Bock.png" width="50px" alt="Christian Bock" /></a>
 </p>
 <!-- SPONSORS -->

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/client.py

@@ -32,6 +32,14 @@ if TYPE_CHECKING:
 
 templates = Jinja2Templates(Path(__file__).parent / 'templates')
 
+HTML_ESCAPE_TABLE = str.maketrans({
+    '&': '&',
+    '<': '&lt;',
+    '>': '&gt;',
+    '`': '&#96;',
+    '$': '&#36;',
+})
+
 
 class Client:
     page_routes: ClassVar[Dict[Callable[..., Any], str]] = {}
@@ -148,11 +156,7 @@ class Client:
             context={
                 'request': request,
                 'version': __version__,
-                'elements': elements.replace('&', '&amp;')
-                                    .replace('<', '&lt;')
-                                    .replace('>', '&gt;')
-                                    .replace('`', '&#96;')
-                                    .replace('$', '&#36;'),
+                'elements': elements.translate(HTML_ESCAPE_TABLE),
                 'head_html': self.head_html,
                 'body_html': '<style>' + '\n'.join(vue_styles) + '</style>\n' + self.body_html + '\n' + '\n'.join(vue_html),
                 'vue_scripts': '\n'.join(vue_scripts),

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/element_filter.py

@@ -12,6 +12,7 @@ from .elements.mixins.source_element import SourceElement
 from .elements.mixins.text_element import TextElement
 from .elements.notification import Notification
 from .elements.select import Select
+from .elements.tree import Tree
 
 T = TypeVar('T', bound=Element)
 
@@ -125,6 +126,9 @@ class ElementFilter(Generic[T]):
                         element_contents.extend(labels)
                     if not isinstance(element, Select) or element.is_showing_popup:
                         element_contents.extend(element._labels)  # pylint: disable=protected-access
+                if isinstance(element, Tree):
+                    LABEL_KEY = element.props.get('label-key')
+                    element_contents.extend(node[LABEL_KEY] for node in element.nodes(visible=True))
                 if any(all(needle not in str(haystack) for haystack in element_contents) for needle in self._contents):
                     continue
                 if any(needle in str(haystack) for haystack in element_contents for needle in self._exclude_content):

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/aggrid.js

@@ -42,7 +42,11 @@ export default {
         checkboxRenderer: CheckboxRenderer,
       };
 
-      this.gridOptions.onGridReady = (params) => this.handle_event("gridReady", params);
+      const originalOnGridReady = this.gridOptions.onGridReady;
+      this.gridOptions.onGridReady = (params) => {
+        originalOnGridReady(params);
+        this.handle_event("gridReady", params);
+      };
       this.api = agGrid.createGrid(this.$el, this.gridOptions);
       this.api.addGlobalListener(this.handle_event);
     },

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/checkbox.py

@@ -8,7 +8,10 @@ from .mixins.value_element import ValueElement
 
 class Checkbox(TextElement, ValueElement, DisableableElement):
 
-    def __init__(self, text: str = '', *, value: bool = False, on_change: Optional[Handler[ValueChangeEventArguments]] = None) -> None:
+    def __init__(self,
+                 text: str = '', *,
+                 value: Optional[bool] = False,
+                 on_change: Optional[Handler[ValueChangeEventArguments]] = None) -> None:
         """Checkbox
 
         This element is based on Quasar's `QCheckbox <https://quasar.dev/vue-components/checkbox>`_ component.

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/dialog.js

@@ -1,6 +1,6 @@
 export default {
   template: `
-    <q-dialog v-bind="$attrs" @show="addClass" @hide="removeClass">
+    <q-dialog @show="addClass" @hide="removeClass">
       <slot />
     </q-dialog>
   `,

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/editor.js

@@ -1,10 +1,6 @@
 export default {
   template: `
-    <q-editor
-      ref="qRef"
-      v-bind="$attrs"
-      v-model="inputValue"
-    >
+    <q-editor ref="qRef" v-model="inputValue">
       <template v-for="(_, slot) in $slots" v-slot:[slot]="slotProps">
         <slot :name="slot" v-bind="slotProps || {}" />
       </template>

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/header.js

@@ -1,5 +1,5 @@
 export default {
-  template: `<q-header ref="qRef" v-bind="$attrs"><slot></slot></q-header>`,
+  template: `<q-header ref="qRef"><slot></slot></q-header>`,
   mounted() {
     if (this.add_scroll_padding) {
       new ResizeObserver(() => {

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/image.js

@@ -1,10 +1,6 @@
 export default {
   template: `
-    <q-img
-      ref="qRef"
-      v-bind="$attrs"
-      :src="computed_src"
-    >
+    <q-img ref="qRef" :src="computed_src">
       <template v-for="(_, slot) in $slots" v-slot:[slot]="slotProps">
         <slot :name="slot" v-bind="slotProps || {}" />
       </template>

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/interactive_image.js

@@ -131,7 +131,7 @@ export default {
     },
     onUserEvents() {
       const events = {};
-      for (const type of this.events) {
+      for (const type of this.events || []) {
         events[type] = (event) => this.onMouseEvent(type, event);
       }
       return events;

nicegui-2.24.0/nicegui/elements/log.js

@@ -0,0 +1,18 @@
+export default {
+    template: `<div><slot></slot></div>`,
+    data() {
+        return {
+            shouldScroll: true,
+        };
+    },
+    beforeUpdate() {
+        if (this.$el) {
+            this.shouldScroll = this.$el.scrollTop + this.$el.clientHeight >= this.$el.scrollHeight;
+        }
+    },
+    updated() {
+        if (this.$el && this.shouldScroll) {
+            this.$el.scrollTop = this.$el.scrollHeight;
+        }
+    }
+};

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/log.py

@@ -4,7 +4,7 @@ from ..element import Element
 from .label import Label
 
 
-class Log(Element, default_classes='nicegui-log'):
+class Log(Element, component='log.js', default_classes='nicegui-log'):
 
     def __init__(self, max_lines: Optional[int] = None) -> None:
         """Log View

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/pyplot.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import asyncio
 import io
 import os
 import weakref
@@ -8,8 +7,7 @@ from typing import Any
 
 from typing_extensions import Self
 
-from .. import background_tasks, optional_features
-from ..client import Client
+from .. import optional_features
 from ..element import Element
 
 try:
@@ -61,7 +59,7 @@ class Pyplot(Element, default_classes='nicegui-pyplot'):
         self._convert_to_html()
 
         if not self.client.shared:
-            background_tasks.create(self._auto_close(), name='auto-close plot figure')
+            self.client.on_disconnect(lambda: plt.close(self.fig))
 
     def _convert_to_html(self) -> None:
         with io.StringIO() as output:
@@ -78,11 +76,6 @@ class Pyplot(Element, default_classes='nicegui-pyplot'):
             plt.close(self.fig)
         self.update()
 
-    async def _auto_close(self) -> None:
-        while self.client.id in Client.instances:
-            await asyncio.sleep(1.0)
-        plt.close(self.fig)
-
 
 class Matplotlib(Element, default_classes='nicegui-matplotlib'):
 

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/select.js

@@ -3,7 +3,6 @@ export default {
   template: `
     <q-select
       ref="qRef"
-      v-bind="$attrs"
       :options="filteredOptions"
       @filter="filterFn"
       @popup-show="addClass"

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/sub_pages.py

@@ -108,12 +108,6 @@ class SubPages(Element, component='sub_pages.js', default_classes='nicegui-sub-p
             self._render_error(e)
             return True
 
-        # NOTE: if the full path could not be consumed, the deepest sub pages element must handle the possible 404
-        if match.remaining_path and not any(isinstance(el, SubPages) for el in self.descendants()):
-            if asyncio.iscoroutine(result):
-                result.close()
-            return False
-
         self._handle_scrolling(match, behavior='instant')
         if asyncio.iscoroutine(result):
             async def background_task():

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/switch.py

@@ -8,7 +8,10 @@ from .mixins.value_element import ValueElement
 
 class Switch(TextElement, ValueElement, DisableableElement):
 
-    def __init__(self, text: str = '', *, value: bool = False, on_change: Optional[Handler[ValueChangeEventArguments]] = None) -> None:
+    def __init__(self,
+                 text: str = '', *,
+                 value: Optional[bool] = False,
+                 on_change: Optional[Handler[ValueChangeEventArguments]] = None) -> None:
         """Switch
 
         This element is based on Quasar's `QToggle <https://quasar.dev/vue-components/toggle>`_ component.

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/table.js

@@ -2,11 +2,7 @@ import { convertDynamicProperties } from "../../static/utils/dynamic_properties.
 
 export default {
   template: `
-    <q-table
-      ref="qRef"
-      v-bind="$attrs"
-      :columns="convertedColumns"
-    >
+    <q-table ref="qRef" :columns="convertedColumns">
       <template v-for="(_, slot) in $slots" v-slot:[slot]="slotProps">
         <slot :name="slot" v-bind="slotProps || {}" />
       </template>

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/elements/tree.py

@@ -153,15 +153,23 @@ class Tree(FilterElement):
         self.update()
         return self
 
-    def _find_node_keys(self, node_keys: Optional[List[str]] = None) -> Set[str]:
-        if node_keys is not None:
-            return set(node_keys)
-
-        CHILDREN_KEY = self._props['children-key']
-        NODE_KEY = self._props['node-key']
+    def nodes(self, *, visible: Optional[bool] = None) -> Iterator[Dict]:
+        """Iterate over all nodes.
 
+        :param visible: if ``True``, only visible nodes are returned; if ``False``, only invisible nodes are returned; if ``None``, all nodes are returned (default: ``None``)
+        """
         def iterate_nodes(nodes: List[Dict]) -> Iterator[Dict]:
+            expanded = self._props.get('expanded')
+            NODE_KEY = self._props['node-key']
+            CHILDREN_KEY = self._props['children-key']
             for node in nodes:
                 yield node
-                yield from iterate_nodes(node.get(CHILDREN_KEY, []))
-        return {node[NODE_KEY] for node in iterate_nodes(self._props['nodes'])}
+                is_expanded = expanded is None or node[NODE_KEY] in expanded
+                if (is_expanded and visible is not False) or (not is_expanded and visible is not True):
+                    yield from iterate_nodes(node.get(CHILDREN_KEY, []))
+        return iterate_nodes(self._props['nodes'])
+
+    def _find_node_keys(self, node_keys: Optional[List[str]] = None) -> Set[str]:
+        if node_keys is not None:
+            return set(node_keys)
+        return {node[self._props['node-key']] for node in self.nodes()}

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/functions/navigate.py

@@ -1,6 +1,7 @@
 from typing import Any, Callable, Union
 from urllib.parse import urlparse
 
+from .. import background_tasks
 from ..client import Client
 from ..context import context
 from ..element import Element
@@ -73,7 +74,10 @@ class Navigate:
             parsed = urlparse(path)
             if not parsed.scheme and not parsed.netloc and \
                     any(isinstance(el, SubPages) for el in context.client.elements.values()):
-                context.client.sub_pages_router._handle_navigate(path)  # pylint: disable=protected-access
+                async def navigate_sub_pages(client: Client) -> None:
+                    with client:
+                        await client.sub_pages_router._handle_navigate(path)  # pylint: disable=protected-access
+                background_tasks.create(navigate_sub_pages(context.client), name='navigate_sub_pages')
                 return
 
         context.client.open(path, new_tab)

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/nicegui.py

@@ -134,10 +134,11 @@ async def _startup() -> None:
     run.setup()
     app.start()
     background_tasks.create(binding.refresh_loop(), name='refresh bindings')
-    app.timer(10, Client.prune_instances, immediate=False)
-    app.timer(10, Slot.prune_stacks, immediate=False)
-    app.timer(10, prune_tab_storage, immediate=False)
-    app.timer(10, prune_user_storage, immediate=False)
+    app.timer(10, Client.prune_instances)
+    app.timer(10, Slot.prune_stacks)
+    app.timer(10, prune_tab_storage)
+    if app.storage.secret is not None:
+        app.timer(10, prune_user_storage)
     air.connect()
 
 

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/page.py

@@ -10,7 +10,6 @@ from fastapi import HTTPException, Request, Response
 
 from . import background_tasks, binding, core, helpers
 from .client import Client
-from .elements.sub_pages import SubPages
 from .favicon import create_favicon_route
 from .language import Language
 from .logging import log
@@ -145,10 +144,6 @@ class page:
                     dec_kwargs['client'] = client
                 try:
                     result = func(*dec_args, **dec_kwargs)
-                    # NOTE: after building the page, there might be sub pages that have 404 -- and initial requests should send 404 status request in such cases
-                    sub_pages_elements = [e for e in client.elements.values() if isinstance(e, SubPages)]
-                    if any(sub_pages.has_404 for sub_pages in sub_pages_elements):
-                        raise HTTPException(404, f'{client.sub_pages_router.current_path} not found')
                 except Exception as e:
                     return create_error_page(e, request)
             if helpers.is_coroutine_function(func):
@@ -174,6 +169,10 @@ class page:
                 else:
                     result = None
                     task.add_done_callback(check_for_late_return_value)
+
+            if not await client.sub_pages_router._can_resolve_full_path(client):  # pylint: disable=protected-access
+                return create_error_page(HTTPException(404, f'{client.sub_pages_router.current_path} not found'), request)
+
             if isinstance(result, Response):  # NOTE if setup returns a response, we don't need to render the page
                 return result
             binding._refresh_step()  # pylint: disable=protected-access

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/sub_pages_router.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import asyncio
 from typing import TYPE_CHECKING, Callable, List, Optional
 
 from fastapi import Request
@@ -21,7 +22,14 @@ class SubPagesRouter:
         on('sub_pages_navigate', lambda event: self._handle_navigate(event.args))
 
         if request is not None:
+            forwarded_prefix = request.headers.get('X-Forwarded-Prefix', '')
+            root = _normalize(request.scope.get('root_path', ''))
+            combined = _normalize(forwarded_prefix or '') + _normalize(root or '')
             path = request.url.path
+            for p in (combined, root):
+                if p and (path == p or path.startswith(p + '/')):
+                    path = path[len(p):] or '/'
+                    break
             if request.url.query:
                 path += '?' + request.url.query
             # NOTE: we do not use request.url.fragment because browsers do not send it to the server
@@ -41,27 +49,21 @@ class SubPagesRouter:
         """
         self._path_changed_handlers.append(handler)
 
-    def _handle_open(self, path: str) -> bool:
+    async def _handle_open(self, path: str) -> bool:
         self.current_path = path
         self.is_initial_request = False
         for callback in self._path_changed_handlers:
             callback(path)
-        updated = False
         for child in context.client.layout.descendants():
             if isinstance(child, SubPages):
-                try:
-                    child._show()  # pylint: disable=protected-access
-                    if child._match is not None:  # pylint: disable=protected-access
-                        updated = True
-                except ValueError:
-                    pass
-        return updated
-
-    def _handle_navigate(self, path: str) -> None:
+                child._show()  # pylint: disable=protected-access
+        return await self._can_resolve_full_path(context.client)
+
+    async def _handle_navigate(self, path: str) -> None:
         # NOTE: keep a reference to the client because _handle_open clears the slots so that context.client does not work anymore
         client = context.client
         if (
-            self._handle_open(path) or  # path is handled by `ui.sub_pages`
+            await self._handle_open(path) or  # path is handled by `ui.sub_pages`
             not self._other_page_builder_matches_path(path, client)  # `ui.sub_pages` is still responsible
         ):
             client.run_javascript(f'''
@@ -96,3 +98,26 @@ class SubPagesRouter:
                 return True
 
         return False
+
+    @staticmethod
+    async def _can_resolve_full_path(client: Client) -> bool:
+        sub_pages_elements = [el for el in client.layout.descendants() if isinstance(el, SubPages)]
+        if any(el._active_tasks for el in sub_pages_elements):  # pylint: disable=protected-access
+            await asyncio.sleep(0)
+            # NOTE: refresh the list to include newly created nested sub pages in async sub page builders after the event loop tick
+            sub_pages_elements = [el for el in client.layout.descendants() if isinstance(el, SubPages)]
+        has_404 = False
+        for sub_pages in sub_pages_elements:
+            if (
+                sub_pages._match is not None and  # pylint: disable=protected-access
+                sub_pages._404_enabled and  # pylint: disable=protected-access
+                sub_pages._match.remaining_path and  # pylint: disable=protected-access
+                not any(isinstance(el, SubPages) for el in sub_pages.descendants())
+            ):
+                sub_pages._set_match(None)  # pylint: disable=protected-access
+                has_404 = True
+        return not has_404
+
+
+def _normalize(p: str) -> str:
+    return p[:-1] if p and p != '/' and p.endswith('/') else p

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/testing/general_fixtures.py

@@ -22,20 +22,7 @@ def pytest_configure(config: pytest.Config) -> None:
 def nicegui_reset_globals() -> Generator[None, None, None]:
     """Reset the global state of the NiceGUI package."""
     for route in list(app.routes):
-        if isinstance(route, Route) and route.path.startswith('/_nicegui/auto/static/'):
-            app.remove_route(route.path)
-
-    all_page_routes = set(Client.page_routes.values())
-    all_page_routes.add('/')
-    for path in all_page_routes:
-        app.remove_route(path)
-
-    for route in list(app.routes):
-        if (
-            isinstance(route, Route) and
-            '{' in route.path and '}' in route.path and
-            not route.path.startswith('/_nicegui/')
-        ):
+        if isinstance(route, Route) and (not route.path.startswith('/_nicegui/') or route.path.startswith('/_nicegui/auto/static')):
             app.remove_route(route.path)
 
     app.openapi_schema = None
@@ -43,10 +30,6 @@ def nicegui_reset_globals() -> Generator[None, None, None]:
     app.user_middleware.clear()
     app.urls.clear()
     core.air = None
-    # NOTE favicon routes must be removed separately because they are not "pages"
-    for route in list(app.routes):
-        if isinstance(route, Route) and route.path.endswith('/favicon.ico'):
-            app.routes.remove(route)
     importlib.reload(core)
     importlib.reload(run)
 

{nicegui-2.23.2 → nicegui-2.24.0}/nicegui/testing/user_interaction.py

@@ -102,6 +102,25 @@ class UserInteraction(Generic[T]):
                     element.value = target_value
                     return self
 
+                elif isinstance(element, ui.tree) and isinstance(self.target, str):
+                    NODE_KEY = element.props.get('node-key')
+                    LABEL_KEY = element.props.get('label-key')
+                    target_key = next((
+                        node[NODE_KEY]
+                        for node in element.nodes(visible=True)
+                        if self.target == node.get(LABEL_KEY)
+                    ), None)
+                    if target_key is None:
+                        return self
+                    expanded_set = set(element.props.get('expanded', [node[NODE_KEY] for node in element.nodes()]))
+                    if target_key in expanded_set:
+                        expanded_set.remove(target_key)
+                    else:
+                        expanded_set.add(target_key)
+                    element.props['expanded'] = list(expanded_set)
+                    element.update()
+                    return self
+
                 for listener in element._event_listeners.values():  # pylint: disable=protected-access
                     if listener.element_id != element.id:
                         continue

{nicegui-2.23.2 → nicegui-2.24.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nicegui"
-version = "v2.23.2"
+version = "v2.24.0"
 description = "Create web-based user interfaces with Python. The nice way."
 authors = ["Zauberzeug GmbH <info@zauberzeug.com>"]
 license = "MIT"