nicegui 2.22.2__tar.gz → 2.23.0__tar.gz

{nicegui-2.22.2 → nicegui-2.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nicegui
-Version: 2.22.2
+Version: 2.23.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/Christian-D-Bock"><img src="https://github.com/Christian-D-Bock.png" width="50px" alt="Christian Bock" /></a>
 </p>
 <!-- SPONSORS -->
 

{nicegui-2.22.2 → nicegui-2.23.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/Christian-D-Bock"><img src="https://github.com/Christian-D-Bock.png" width="50px" alt="Christian Bock" /></a>
 </p>
 <!-- SPONSORS -->
 

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/client.py

@@ -131,7 +131,7 @@ class Client:
     def build_response(self, request: Request, status_code: int = 200) -> Response:
         """Build a FastAPI response for the client."""
         self.outbox.updates.clear()
-        prefix = request.headers.get('X-Forwarded-Prefix', request.scope.get('root_path', ''))
+        prefix = request.headers.get('X-Forwarded-Prefix', '') + request.scope.get('root_path', '')
         elements = json.dumps({
             id: element._to_dict() for id, element in self.elements.items()  # pylint: disable=protected-access
         })

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/element.py

@@ -76,17 +76,18 @@ class Element(Visibility):
         self._deleted: bool = False
 
         client.elements[self.id] = self
-        self.parent_slot: Optional[Slot] = None
+        self._parent_slot: Optional[weakref.ref[Slot]] = None
         slot_stack = context.slot_stack
         if slot_stack:
-            self.parent_slot = slot_stack[-1]
-            self.parent_slot.children.append(self)
+            parent_slot = slot_stack[-1]
+            parent_slot.children.append(self)
+            self._parent_slot = weakref.ref(parent_slot)
 
         self.tailwind = Tailwind(self)
 
         client.outbox.enqueue_update(self)
-        if self.parent_slot:
-            client.outbox.enqueue_update(self.parent_slot.parent)
+        if self._parent_slot:
+            client.outbox.enqueue_update(parent_slot.parent)
 
     def __init_subclass__(cls, *,
                           component: Union[str, Path, None] = None,
@@ -156,6 +157,20 @@ class Element(Visibility):
             raise RuntimeError('The client this element belongs to has been deleted.')
         return client
 
+    @property
+    def parent_slot(self) -> Optional[Slot]:
+        """The parent slot of the element."""
+        if self._parent_slot is None:
+            return None
+        parent_slot = self._parent_slot()
+        if parent_slot is None:
+            raise RuntimeError('The parent slot of the element has been deleted.')
+        return parent_slot
+
+    @parent_slot.setter
+    def parent_slot(self, value: Optional[Slot]) -> None:
+        self._parent_slot = weakref.ref(value) if value else None
+
     def add_resource(self, path: Union[str, Path]) -> None:
         """Add a resource to the element.
 
@@ -455,8 +470,9 @@ class Element(Visibility):
         """
         if include_self:
             yield self
-        if self.parent_slot:
-            yield from self.parent_slot.parent.ancestors(include_self=True)
+        parent_slot = self.parent_slot
+        if parent_slot:
+            yield from parent_slot.parent.ancestors(include_self=True)
 
     def descendants(self, *, include_self: bool = False) -> Iterator[Element]:
         """Iterate over the descendants of the element.
@@ -485,21 +501,24 @@ class Element(Visibility):
         :param target_index: index within the target slot (default: append to the end)
         :param target_slot: slot within the target container (default: default slot)
         """
-        assert self.parent_slot is not None
-        self.parent_slot.children.remove(self)
-        self.parent_slot.parent.update()
-        target_container = target_container or self.parent_slot.parent
+        parent_slot = self.parent_slot
+        assert parent_slot is not None
+        parent_slot.children.remove(self)
+        parent_slot.parent.update()
+        target_container = target_container or parent_slot.parent
 
         if target_slot is None:
-            self.parent_slot = target_container.default_slot
+            parent_slot = target_container.default_slot
+            self.parent_slot = parent_slot
         elif target_slot in target_container.slots:
-            self.parent_slot = target_container.slots[target_slot]
+            parent_slot = target_container.slots[target_slot]
+            self.parent_slot = parent_slot
         else:
             raise ValueError(f'Slot "{target_slot}" does not exist in the target container. '
                              f'Add it first using `add_slot("{target_slot}")`.')
 
-        target_index = target_index if target_index >= 0 else len(self.parent_slot.children)
-        self.parent_slot.children.insert(target_index, self)
+        target_index = target_index if target_index >= 0 else len(parent_slot.children)
+        parent_slot.children.insert(target_index, self)
 
         target_container.update()
 
@@ -512,14 +531,16 @@ class Element(Visibility):
             children = list(self)
             element = children[element]
         self.client.remove_elements(element.descendants(include_self=True))
-        assert element.parent_slot is not None
-        element.parent_slot.children.remove(element)
+        parent_slot = element.parent_slot
+        assert parent_slot is not None
+        parent_slot.children.remove(element)
         self.update()
 
     def delete(self) -> None:
         """Delete the element and all its children."""
-        assert self.parent_slot is not None
-        self.parent_slot.parent.remove(self)
+        parent_slot = self.parent_slot
+        assert parent_slot is not None
+        parent_slot.parent.remove(self)
 
     def _handle_delete(self) -> None:
         """Called when the element is deleted.

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/elements/color_input.py

@@ -1,3 +1,5 @@
+import re
+from colorsys import rgb_to_yiq
 from typing import Any, Optional
 
 from ..events import Handler, ValueChangeEventArguments
@@ -7,6 +9,9 @@ from .mixins.disableable_element import DisableableElement
 from .mixins.label_element import LabelElement
 from .mixins.value_element import ValueElement
 
+HEX_COLOR_PATTERN_6 = re.compile(r'^#([0-9a-fA-F]{6})$')
+HEX_COLOR_PATTERN_3 = re.compile(r'^#([0-9a-fA-F]{3})$')
+
 
 class ColorInput(LabelElement, ValueElement, DisableableElement):
     LOOPBACK = False
@@ -53,7 +58,19 @@ class ColorInput(LabelElement, ValueElement, DisableableElement):
     def _update_preview(self) -> None:
         if not self.preview:
             return
-        self.button.style(f'''
-            background-color: {(self.value or "#fff").split(";", 1)[0]};
-            text-shadow: 2px 0 #fff, -2px 0 #fff, 0 2px #fff, 0 -2px #fff, 1px 1px #fff, -1px -1px #fff, 1px -1px #fff, -1px 1px #fff;
-        ''')
+
+        color = self.value.strip()
+        if HEX_COLOR_PATTERN_6.match(color):
+            r = int(color[1:3], 16) / 255
+            g = int(color[3:5], 16) / 255
+            b = int(color[5:7], 16) / 255
+        elif HEX_COLOR_PATTERN_3.match(color):
+            r = int(color[1], 16) / 15
+            g = int(color[2], 16) / 15
+            b = int(color[3], 16) / 15
+        else:
+            self.button.style('background-color: transparent').props(remove='color')
+            return
+        luminance = rgb_to_yiq(r, g, b)[0]
+        icon_color = 'grey-10' if luminance > 0.5 else 'grey-3'
+        self.button.style(f'background-color: {color}').props(f'color="{icon_color}"')

nicegui-2.23.0/nicegui/elements/dark_mode.js

@@ -0,0 +1,16 @@
+export default {
+  mounted() {
+    this.update();
+  },
+  updated() {
+    this.update();
+  },
+  methods: {
+    update() {
+      Quasar.Dark.set(this.value === null ? "auto" : this.value);
+    },
+  },
+  props: {
+    value: Boolean,
+  },
+};

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/elements/dark_mode.py

@@ -1,6 +1,5 @@
 from typing import Optional
 
-from .. import core, helpers
 from ..events import Handler, ValueChangeEventArguments
 from .mixins.value_element import ValueElement
 
@@ -21,19 +20,6 @@ class DarkMode(ValueElement, component='dark_mode.js'):
         """
         super().__init__(value=value, on_value_change=on_change)
 
-        # HACK: this is a temporary warning to inform users about issue #3753
-        if core.app.is_started:
-            self._check_for_issue_3753()
-        else:
-            core.app.on_startup(self._check_for_issue_3753)
-
-    def _check_for_issue_3753(self) -> None:
-        if self.client.page.resolve_dark() is None and core.app.config.tailwind:
-            helpers.warn_once(
-                '`ui.dark_mode` is not supported on pages with `dark=None` while running with `tailwind=True` (the default). '
-                'See https://github.com/zauberzeug/nicegui/issues/3753 for more information.'
-            )
-
     def enable(self) -> None:
         """Enable dark mode."""
         self.value = True

nicegui-2.23.0/nicegui/elements/dialog.js

@@ -0,0 +1,19 @@
+export default {
+  template: `
+    <q-dialog v-bind="$attrs" @show="addClass" @hide="removeClass">
+      <slot />
+    </q-dialog>
+  `,
+  methods: {
+    addClass() {
+      // NOTE: prevent the page from scrolling when the dialog is closed (#5031)
+      document.documentElement.classList.add("nicegui-dialog-open");
+    },
+    removeClass() {
+      document.documentElement.classList.remove("nicegui-dialog-open");
+    },
+  },
+  unmounted() {
+    this.removeClass();
+  },
+};

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/elements/dialog.py

@@ -4,7 +4,7 @@ from typing import Any, Optional
 from .mixins.value_element import ValueElement
 
 
-class Dialog(ValueElement):
+class Dialog(ValueElement, component='dialog.js'):
 
     def __init__(self, *, value: bool = False) -> None:
         """Dialog
@@ -19,7 +19,7 @@ class Dialog(ValueElement):
 
         :param value: whether the dialog should be opened on creation (default: `False`)
         """
-        super().__init__(tag='q-dialog', value=value, on_value_change=None)
+        super().__init__(value=value, on_value_change=None)
         self._result: Any = None
         self._submitted: Optional[asyncio.Event] = None
 

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/elements/plotly.vue

@@ -23,9 +23,9 @@ export default {
 
       // re-use plotly instance if config is the same
       if (JSON.stringify(options.config) == JSON.stringify(this.last_options.config)) {
-        Plotly.react(this.$el.id, this.options.data, this.options.layout);
+        Plotly.react(this.$el.id, this.options, options.config);
       } else {
-        Plotly.newPlot(this.$el.id, this.options.data, this.options.layout, options.config);
+        Plotly.newPlot(this.$el.id, this.options, options.config);
         this.set_handlers();
       }
 

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/elements/select.js

@@ -6,6 +6,8 @@ export default {
       v-bind="$attrs"
       :options="filteredOptions"
       @filter="filterFn"
+      @popup-show="addClass"
+      @popup-hide="removeClass"
     >
       <template v-for="(_, slot) in $slots" v-slot:[slot]="slotProps">
         <slot :name="slot" v-bind="slotProps || {}" />
@@ -28,6 +30,14 @@ export default {
         ? this.initialOptions.filter((v) => String(v.label).toLocaleLowerCase().indexOf(needle) > -1)
         : this.initialOptions;
     },
+    addClass() {
+      // NOTE: prevent the page from scrolling when the select popup is closed (#5031)
+      document.documentElement.classList.add("nicegui-select-popup-open");
+    },
+    async removeClass() {
+      await this.$nextTick();
+      document.documentElement.classList.remove("nicegui-select-popup-open");
+    },
   },
   updated() {
     if (!this.$attrs.multiple) return;
@@ -36,6 +46,9 @@ export default {
       this.filteredOptions = newFilteredOptions;
     }
   },
+  unmounted() {
+    this.removeClass();
+  },
   watch: {
     options: {
       handler(newOptions) {

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/elements/timer.py

@@ -40,8 +40,9 @@ class Timer(BaseTimer, Element, component='timer.js'):
     def _cleanup(self) -> None:
         super()._cleanup()
         if not self._deleted:
-            assert self.parent_slot
-            self.parent_slot.parent.remove(self)
+            parent_slot = self.parent_slot
+            assert parent_slot is not None
+            parent_slot.parent.remove(self)
 
     def set_visibility(self, visible: bool) -> None:
         raise NotImplementedError('Use `activate()`, `deactivate()` or `cancel()`. See #3670 for more information.')

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/native/native.py

@@ -123,7 +123,7 @@ try:
 
         async def create_file_dialog(  # type: ignore # pylint: disable=invalid-overridden-method
             self,
-            dialog_type: int = webview.OPEN_DIALOG,
+            dialog_type: int = webview.FileDialog.OPEN if hasattr(webview, 'FileDialog') else webview.OPEN_DIALOG,
             directory: str = '',
             allow_multiple: bool = False,
             save_filename: str = '',

nicegui-2.23.0/nicegui/props.py

@@ -0,0 +1,125 @@
+import ast
+import re
+import weakref
+from typing import TYPE_CHECKING, Any, Dict, Generic, Optional, TypeVar
+
+from . import helpers
+
+if TYPE_CHECKING:
+    from .element import Element
+
+PROPS_PATTERN = re.compile(r'''
+# Match a key or key-value pair optionally followed by whitespace or end of string
+# The value can be unquoted, or enclosed in quotes, or square or curly brackets
+(?P<key>[:\w\-]+)           # Capture group 1: Key
+(                           # Optional non-capturing group for value
+    =                       # An equals sign
+    (                       # followed by one of ...
+        (?P<double>         # a value enclosed in double quotes
+            "                   # Match double quote
+            [^"\\]*             # Match any character except quotes or backslashes zero or more times
+            (\\.[^"\\]*)*       # Match any escaped character followed by any character except quotes or backslashes zero or more times
+            "                   # Match the closing quote
+        )
+        |                   # or
+        (?P<single>         # a value enclosed in single quotes
+            '                   # Match a single quote
+            [^'\\]*             # Match any character except quotes or backslashes zero or more times
+            (\\.[^'\\]*)*       # Match any escaped character followed by any character except quotes or backslashes zero or more times
+            '                   # Match the closing quote
+        )
+        |                   # or
+        (?P<square>         # a value enclosed in square brackets
+            \[                  # Match the opening [
+            [^\]\\]*            # Match any character except a ] or backslashes zero or more times
+            (\\.[^\]\\]*)*      # Match any escaped character followed by any character except ] or backslashes zero or more times
+            \]                  # Match the closing ]
+        )
+        |                   # or
+        (?P<curly>          # a value enclosed in curly braces
+            \{                  # Match the opening {
+            [^\}\\]*            # Match any character except } or backslashes zero or more times
+            (\\.[^\}\\]*)*      # Match any escaped character followed by any character except ] or backslashes zero or more times
+            \}                  # Match the closing }
+        )
+        |                   # or, as a final alternative ....
+        (?P<unquoted>[\w\-.,%:\/=?&;+#@~$]+)  # a value without quotes
+    )
+)?                          # End of optional non-capturing group for value
+($|\s)                      # Match end of string or whitespace
+''', re.VERBOSE)
+
+T = TypeVar('T', bound='Element')
+
+
+class Props(dict, Generic[T]):
+
+    def __init__(self, *args, element: T, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self._element = weakref.ref(element)
+        self._warnings: Dict[str, str] = {}
+
+    @property
+    def element(self) -> T:
+        """The element this props object belongs to."""
+        element = self._element()
+        if element is None:
+            raise RuntimeError('The element this props object belongs to has been deleted.')
+        return element
+
+    def add_warning(self, prop: str, message: str) -> None:
+        """Add a warning message for a prop."""
+        self._warnings[prop] = message
+
+    def __call__(self,
+                 add: Optional[str] = None, *,
+                 remove: Optional[str] = None) -> T:
+        """Add or remove props.
+
+        This allows modifying the look of the element or its layout using `Quasar <https://quasar.dev/>`_ props.
+        Since props are simply applied as HTML attributes, they can be used with any HTML element.
+
+        Boolean properties are assumed ``True`` if no value is specified.
+
+        :param add: whitespace-delimited list of either boolean values or key=value pair to add
+        :param remove: whitespace-delimited list of property keys to remove
+        """
+        element = self.element
+        needs_update = False
+        for key in self.parse(remove):
+            if key in self:
+                needs_update = True
+                del self[key]
+        for key, value in self.parse(add).items():
+            if self.get(key) != value:
+                needs_update = True
+                self[key] = value
+        if needs_update:
+            element.update()
+        for name, message in self._warnings.items():
+            if name in self:
+                del self[name]
+                helpers.warn_once(message)
+        return element
+
+    @staticmethod
+    def parse(text: Optional[str]) -> Dict[str, Any]:
+        """Parse a string of props into a dictionary."""
+        if not text:
+            return {}
+        props = {}
+        for match in PROPS_PATTERN.finditer(text):
+            match_groups = match.groupdict()
+            key = match_groups['key']
+
+            for group in ['single', 'double', 'square', 'curly']:
+                if match_groups[group] is not None:
+                    props[key] = ast.literal_eval(match_groups[group])
+                    break
+            else:
+                if match_groups['unquoted'] is not None:
+                    props[key] = match_groups['unquoted']
+                else:
+                    props[key] = True
+
+        return props

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/static/nicegui.css

@@ -10,6 +10,12 @@
   outline-offset: 2px;
 }
 
+/* prevent page from smooth-scrolling when dialogs or select popups close */
+.nicegui-dialog-open,
+.nicegui-select-popup-open {
+  scroll-behavior: auto;
+}
+
 /* flex containers */
 .nicegui-content,
 .nicegui-header,

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/templates/index.html

@@ -21,7 +21,7 @@
     {% endfor %}
   </head>
   <body>
-    <script nomodule src="{{ prefix | safe }}/_nicegui/{{version}}/static/es-module-shims.js"></script>
+    <script async src="{{ prefix | safe }}/_nicegui/{{version}}/static/es-module-shims.js"></script>
     <script defer src="{{ prefix | safe }}/_nicegui/{{version}}/static/socket.io.min.js"></script>
     {% if tailwind %}
     <script defer src="{{ prefix | safe }}/_nicegui/{{version}}/static/tailwindcss.min.js"></script>
@@ -61,8 +61,7 @@
       {{ vue_scripts | safe }}
 
       {% if tailwind %}
-      if (dark !== None) tailwind.config.darkMode = "class";
-      if (dark === True) document.body.classList.add("dark");
+      tailwind.config.darkMode = ["class", "body.body--dark"];
       {% endif %}
 
       app.mount("#app");

{nicegui-2.22.2 → nicegui-2.23.0}/nicegui/timer.py

@@ -37,6 +37,7 @@ class Timer:
         self.active = active
         self._is_canceled = False
         self._immediate = immediate
+        self._current_invocation: Optional[asyncio.Task] = None
 
         coroutine = self._run_once if once else self._run_in_loop
         if core.app.is_started:
@@ -56,9 +57,14 @@ class Timer:
         """Deactivate the timer."""
         self.active = False
 
-    def cancel(self) -> None:
-        """Cancel the timer."""
+    def cancel(self, *, with_current_invocation: bool = False) -> None:
+        """Cancel the timer.
+
+        :param with_current_invocation: whether to cancel the currently invoked task of the callback (*added in version 2.23.0*)
+        """
         self._is_canceled = True
+        if with_current_invocation and self._current_invocation is not None:
+            self._current_invocation.cancel()
 
     async def _run_once(self) -> None:
         try:
@@ -67,7 +73,8 @@ class Timer:
             with self._get_context():
                 await asyncio.sleep(self.interval)
                 if self.active and not self._should_stop():
-                    await self._invoke_callback()
+                    self._current_invocation = asyncio.create_task(self._invoke_callback())
+                    await self._current_invocation
         finally:
             self._cleanup()
 
@@ -82,7 +89,8 @@ class Timer:
                     try:
                         start = time.time()
                         if self.active:
-                            await self._invoke_callback()
+                            self._current_invocation = asyncio.create_task(self._invoke_callback())
+                            await self._current_invocation
                         dt = time.time() - start
                         await asyncio.sleep(self.interval - dt)
                     except asyncio.CancelledError:
@@ -96,9 +104,10 @@ class Timer:
     async def _invoke_callback(self) -> None:
         try:
             assert self.callback is not None
-            result = self.callback()
-            if isinstance(result, Awaitable) and not isinstance(result, AwaitableResponse):
-                await result
+            with self._get_context():
+                result = self.callback()
+                if isinstance(result, Awaitable) and not isinstance(result, AwaitableResponse):
+                    await result
         except Exception as e:
             core.app.handle_exception(e)
 

{nicegui-2.22.2 → nicegui-2.23.0}/pyproject.toml

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

nicegui-2.22.2/nicegui/elements/dark_mode.js

@@ -1,22 +0,0 @@
-export default {
-  mounted() {
-    this.update();
-  },
-  updated() {
-    this.update();
-  },
-  methods: {
-    update() {
-      Quasar.Dark.set(this.value === null ? "auto" : this.value);
-      if (window.tailwind) {
-        const mode = this.value === null ? "media" : "class";
-        if (mode !== tailwind.config.darkMode) tailwind.config.darkMode = mode;
-        if (this.value) document.body.classList.add("dark");
-        else document.body.classList.remove("dark");
-      }
-    },
-  },
-  props: {
-    value: Boolean,
-  },
-};