fixing more merge errors

documentation_tools.py

@@ -1,196 +0,0 @@
-import importlib
-import inspect
-import re
-from typing import Callable, Optional, Union
-
-import docutils.core
-
-from nicegui import globals, ui
-from nicegui.binding import BindableProperty
-from nicegui.elements.markdown import apply_tailwind, remove_indentation
-
-from .demo import demo
-
-SPECIAL_CHARACTERS = re.compile('[^(a-z)(A-Z)(0-9)-]')
-
-
-def pascal_to_snake(name: str) -> str:
-    return re.sub(r'(?<!^)(?=[A-Z])', '_', name).lower()
-
-
-def create_anchor_name(text: str) -> str:
-    return SPECIAL_CHARACTERS.sub('_', text).lower()
-
-
-def get_menu() -> ui.left_drawer:
-    return [element for element in globals.get_client().elements.values() if isinstance(element, ui.left_drawer)][0]
-
-
-def heading(text: str, *, make_menu_entry: bool = True) -> None:
-    ui.link_target(create_anchor_name(text))
-    ui.html(f'<em>{text}</em>').classes('mt-8 text-3xl font-weight-500')
-    if make_menu_entry:
-        with get_menu():
-            ui.label(text).classes('font-bold mt-4')
-
-
-def subheading(text: str, *, make_menu_entry: bool = True, more_link: Optional[str] = None) -> None:
-    name = create_anchor_name(text)
-    ui.html(f'<div id="{name}"></div>').style('position: relative; top: -90px')
-    with ui.row().classes('gap-2 items-center relative'):
-        if more_link:
-            ui.link(text, f'documentation/{more_link}').classes('text-2xl')
-        else:
-            ui.label(text).classes('text-2xl')
-        with ui.link(target=f'#{name}').classes('absolute').style('transform: translateX(-150%)'):
-            ui.icon('link', size='sm').classes('opacity-10 hover:opacity-80')
-    if make_menu_entry:
-        with get_menu() as menu:
-            async def click():
-                if await ui.run_javascript(f'!!document.querySelector("div.q-drawer__backdrop")'):
-                    menu.hide()
-                    ui.open(f'#{name}')
-            ui.link(text, target=f'#{name}').props('data-close-overlay').on('click', click)
-
-
-def render_docstring(doc: str, with_params: bool = True) -> ui.html:
-    doc = remove_indentation(doc)
-    doc = doc.replace('param ', '')
-    html = docutils.core.publish_parts(doc, writer_name='html5_polyglot')['html_body']
-    html = apply_tailwind(html)
-    if not with_params:
-        html = re.sub(r'<dl class=".* simple">.*?</dl>', '', html, flags=re.DOTALL)
-    return ui.html(html).classes('documentation bold-links arrow-links')
-
-
-class text_demo:
-
-    def __init__(self, title: str, explanation: str, tab: Optional[Union[str, Callable]] = None) -> None:
-        self.title = title
-        self.explanation = explanation
-        self.make_menu_entry = True
-        self.tab = tab
-
-    def __call__(self, f: Callable) -> Callable:
-        subheading(self.title, make_menu_entry=self.make_menu_entry)
-        ui.markdown(self.explanation).classes('bold-links arrow-links')
-        f.tab = self.tab
-        return demo(f)
-
-
-class intro_demo(text_demo):
-
-    def __init__(self, title: str, explanation: str) -> None:
-        super().__init__(title, explanation)
-        self.make_menu_entry = False
-
-
-class element_demo:
-
-    def __init__(self, element_class: Union[Callable, type, str]) -> None:
-        if isinstance(element_class, str):
-            module = importlib.import_module(f'website.more_documentation.{element_class}_documentation')
-            element_class = getattr(module, 'main_demo')
-        self.element_class = element_class
-
-    def __call__(self, f: Callable, *, more_link: Optional[str] = None) -> Callable:
-        doc = f.__doc__ or self.element_class.__doc__ or self.element_class.__init__.__doc__
-        title, documentation = doc.split('\n', 1)
-        with ui.column().classes('w-full mb-8 gap-2'):
-            if more_link:
-                subheading(title, more_link=more_link)
-            render_docstring(documentation, with_params=more_link is None)
-            result = demo(f)
-            if more_link:
-                ui.markdown(f'See [more...](documentation/{more_link})').classes('bold-links arrow-links')
-        return result
-
-
-def load_demo(api: Union[type, Callable, str]) -> None:
-    name = api if isinstance(api, str) else pascal_to_snake(api.__name__)
-    try:
-        module = importlib.import_module(f'website.more_documentation.{name}_documentation')
-    except ModuleNotFoundError:
-        module = importlib.import_module(f'website.more_documentation.{name.replace("_", "")}_documentation')
-    element_demo(api)(getattr(module, 'main_demo'), more_link=name)
-
-
-def is_method_or_property(cls: type, attribute_name: str) -> bool:
-    attribute = cls.__dict__.get(attribute_name, None)
-    return (
-        inspect.isfunction(attribute) or
-        inspect.ismethod(attribute) or
-        isinstance(attribute, property) or
-        isinstance(attribute, BindableProperty)
-    )
-
-
-def generate_class_doc(class_obj: type) -> None:
-    mro = [base for base in class_obj.__mro__ if base.__module__.startswith('nicegui.')]
-    ancestors = mro[1:]
-    attributes = {}
-    for base in reversed(mro):
-        for name in dir(base):
-            if not name.startswith('_') and is_method_or_property(base, name):
-                attributes[name] = getattr(base, name, None)
-    properties = {name: attribute for name, attribute in attributes.items() if not callable(attribute)}
-    methods = {name: attribute for name, attribute in attributes.items() if callable(attribute)}
-
-    if properties:
-        subheading('Properties')
-        with ui.column().classes('gap-2'):
-            for name, property in sorted(properties.items()):
-                ui.markdown(f'**`{name}`**`{generate_property_signature_description(property)}`')
-                if property.__doc__:
-                    render_docstring(property.__doc__).classes('ml-8')
-    if methods:
-        subheading('Methods')
-        with ui.column().classes('gap-2'):
-            for name, method in sorted(methods.items()):
-                ui.markdown(f'**`{name}`**`{generate_method_signature_description(method)}`')
-                if method.__doc__:
-                    render_docstring(method.__doc__).classes('ml-8')
-    if ancestors:
-        subheading('Inherited from')
-        with ui.column().classes('gap-2'):
-            for ancestor in ancestors:
-                ui.markdown(f'- `{ancestor.__name__}`')
-
-
-def generate_method_signature_description(method: Callable) -> str:
-    param_strings = []
-    for param in inspect.signature(method).parameters.values():
-        param_string = param.name
-        if param_string == 'self':
-            continue
-        if param.annotation != inspect.Parameter.empty:
-            param_type = inspect.formatannotation(param.annotation)
-            param_string += f''': {param_type.strip("'")}'''
-        if param.default != inspect.Parameter.empty:
-            param_string += f' = [...]' if callable(param.default) else f' = {repr(param.default)}'
-        if param.kind == inspect.Parameter.VAR_POSITIONAL:
-            param_string = f'*{param_string}'
-        param_strings.append(param_string)
-    method_signature = ', '.join(param_strings)
-    description = f'({method_signature})'
-    return_annotation = inspect.signature(method).return_annotation
-    if return_annotation != inspect.Parameter.empty:
-        return_type = inspect.formatannotation(return_annotation)
-        description += f''' -> {return_type.strip("'").replace("typing_extensions.", "").replace("typing.", "")}'''
-    return description
-
-
-def generate_property_signature_description(property: Optional[property]) -> str:
-    description = ''
-    if property is None:
-        return ': BindableProperty'
-    if property.fget:
-        return_annotation = inspect.signature(property.fget).return_annotation
-        if return_annotation != inspect.Parameter.empty:
-            return_type = inspect.formatannotation(return_annotation)
-            description += f': {return_type}'
-    if property.fset:
-        description += ' (settable)'
-    if property.fdel:
-        description += ' (deletable)'
-    return description

examples/opencv_webcam/main.py

@@ -41,7 +41,6 @@ async def grab_video_frame() -> Response:
     jpeg = await loop.run_in_executor(process_pool_executor, convert, frame)
     return Response(content=jpeg, media_type='image/jpeg')
 
-ui.label('Webcam')
 # For non-flickering image updates an interactive image is much better than `ui.image()`.
 video_image = ui.interactive_image().classes('w-full h-full')
 # A timer constantly updates the source of the image.

nicegui/element.py

@@ -233,6 +233,7 @@ class Element(Visibility):
                 request=storage.request_contextvar.get(),
             )
             self._event_listeners[listener.id] = listener
+            self.update()
         return self
 
     def _handle_event(self, msg: Dict) -> None:

nicegui/elements/button.py

@@ -19,7 +19,7 @@ class Button(TextElement, DisableableElement, BackgroundColorElement):
 
         This element is based on Quasar's `QBtn <https://quasar.dev/vue-components/button>`_ component.
 
-        The ``color`` parameter excepts a Quasar color, a Tailwind color, or a CSS color.
+        The ``color`` parameter accepts a Quasar color, a Tailwind color, or a CSS color.
         If a Quasar color is used, the button will be styled according to the Quasar theme including the color of the text.
         Note that there are colors like "red" being both a Quasar color and a CSS color.
         In such cases the Quasar color will be used.

nicegui/run_with.py

@@ -18,6 +18,7 @@ def run_with(
     language: Language = 'en-US',
     binding_refresh_interval: float = 0.1,
     exclude: str = '',
+    mount_path: str = '/',
     storage_secret: Optional[str] = None,
 ) -> None:
     globals.ui_run_has_been_called = True
@@ -34,4 +35,4 @@ def run_with(
     app.on_event('startup')(lambda: handle_startup(with_welcome_message=False))
     app.on_event('shutdown')(lambda: handle_shutdown())
 
-    app.mount('/', globals.app)
+    app.mount(mount_path, globals.app)

tests/conftest.py

@@ -36,7 +36,7 @@ def selenium(selenium: webdriver.Chrome) -> webdriver.Chrome:
 
 
 @pytest.fixture(autouse=True)
-def reset_globals() -> None:
+def reset_globals() -> Generator[None, None, None]:
     for path in {'/'}.union(globals.page_routes.values()):
         globals.app.remove_route(path)
     globals.app.middleware_stack = None