Make attrs use Typed(dict), add Tag.find_by_id, cleanup tests

Author: frmdstryr

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.12.3
+- Make attrs use Typed(dict) to avoid creating an empty dict for each node
+- Make attrs remove old keys when attrs changes
+- Add Tag.find_by_id
+
 # 0.12.2
 - Use @observe from enaml to avoid unecessary notifications during init_widget
 - Improve speedup code

examples/simple_site/index.enaml renamed to examples/simple_site/views.enaml

@@ -15,7 +15,7 @@
 
 setup(
     name='enaml-web',
-    version='0.12.2',
+    version='0.12.3',
     author='CodeLV',
     author_email='[email protected]',
     url='https://github.com/codelv/enaml-web',

setup.py

@@ -1,5 +1,7 @@
+import pytest
 from enaml.core.enaml_compiler import EnamlCompiler
 from enaml.core.parser import parse
+from web.core.app import WebApplication
 
 
 def compile_source(source, item, filename="<test>", namespace=None):
@@ -25,3 +27,9 @@ def compile_source(source, item, filename="<test>", namespace=None):
     namespace = namespace or {}
     exec(code, namespace)
     return namespace[item]
+
+
+@pytest.fixture
+def app():
+    app = WebApplication.instance() or WebApplication()
+    yield app

tests/utils.py renamed to tests/conftest.py

@@ -1,13 +1,6 @@
 import pytest
 from textwrap import dedent
-from utils import compile_source
-from web.core.app import WebApplication
-
-
-@pytest.fixture
-def app():
-    app = WebApplication.instance() or WebApplication()
-    yield app
+from conftest import compile_source
 
 
 def test_block(app):

tests/test_block.py

@@ -2,8 +2,7 @@
 import pytest
 from textwrap import dedent
 from lxml import html
-from utils import compile_source
-from web.core.app import WebApplication
+from conftest import compile_source
 
 try:
     import nbformat  # noqa: F401
@@ -20,12 +19,6 @@
     MARKDOWN_UNAVAILABLE = True
 
 
-@pytest.fixture
-def app():
-    app = WebApplication.instance() or WebApplication()
-    yield app
-
-
 def test_hello_world(app):
     Page = compile_source(
         dedent(
@@ -136,6 +129,34 @@ def test_html(app, tag, attr, query):
         ("A", "ondragenter", '"a"', "b", '//a[@ondragenter="b"]'),
         ("A", "ondragleave", '"a"', "b", '//a[@ondragleave="b"]'),
         ("A", "ondrop", '"a"', "b", '//a[@ondrop="b"]'),
+        (
+            "A",
+            "attrs",
+            {"data-x": "a"},
+            {"data-x": "b"},
+            '//a[@data-x="b"]',
+        ),  # attrs value changed
+        (
+            "A",
+            "attrs",
+            None,
+            {"data-x": "b"},
+            '//a[@data-x="b"]',
+        ),  # attrs from none to new
+        (
+            "A",
+            "attrs",
+            {"data-x": "b"},
+            None,
+            "//a[not(@data-x)]",
+        ),  # attrs from old to none
+        (  # Test attrs key change
+            "A",
+            "attrs",
+            {"data-x": "a"},
+            {"data-y": "b"},
+            '//a[@data-y="b" and not(@data-x)]',
+        ),
     ),
 )
 def test_html_change(app, tag, attr, default, change, query):

tests/test_html.py

@@ -9,14 +9,6 @@
     from pages import HelloWorld, Simple, ListView
 
 
-@pytest.fixture
-def app():
-    from web.core.app import WebApplication
-
-    app = WebApplication.instance() or WebApplication()
-    yield app
-
-
 @pytest.mark.benchmark(group="hello")
 def test_hello_world_jinja(app, benchmark):
     with open("{}/templates/hello_world.html".format(TEMPLATE_DIR)) as f:

tests/test_speed.py

@@ -16,7 +16,6 @@
 from atom.api import (
     Event,
     Enum,
-    Dict,
     Value,
     Str,
     Instance,
@@ -102,7 +101,7 @@ class Tag(ToolkitObject):
     alt = d_(Str()).tag(attr=False)
 
     #: Custom attributes not explicitly defined
-    attrs = d_(Dict()).tag(attr=False)
+    attrs = d_(Typed(dict)).tag(attr=False)
 
     #: JS onclick definition
     onclick = d_(Str()).tag(attr=False)
@@ -183,8 +182,9 @@ def _update_proxy(self, change: ChangeDict):
             value = change["value"]
             proxy = self.proxy
             assert proxy is not None
-            handler = getattr(proxy, f"set_{name}", None)
-            if handler is not None:
+            if name == "attrs":
+                proxy.set_attrs(value, change["oldvalue"])
+            elif handler := getattr(proxy, f"set_{name}", None):
                 handler(value)
             else:
                 proxy.set_attribute(name, value)
@@ -281,6 +281,25 @@ def _child_index(self, child: Tag) -> int:
     # =========================================================================
     # Tag API
     # =========================================================================
+    def find_by_id(self, id: str) -> Optional[Tag]:
+        """Find a child node with the given id.
+
+        Parameters
+        ----------
+        id: str
+            The id to look for.
+
+        Returns
+        -------
+        results: Optional[Tag]
+            The first node with the given id or None.
+
+        """
+        for child in self.traverse():
+            if isinstance(child, Tag) and child.id == id:
+                return child
+        return None
+
     def xpath(self, query: str, **kwargs) -> list[Tag]:
         """Find nodes matching the given xpath query
 

web/components/html.py

@@ -111,13 +111,13 @@ def init_widget(self):
             set_attr("ondragleave", v)
         if v := d.ondrop:
             set_attr("ondrop", v)
-
-        for k, v in d.attrs.items():
-            set_attr(k, v)
+        if attrs := d.attrs:
+            for k, v in attrs.items():
+                set_attr(k, v)
 
         for m in get_fields(d.__class__):
             name = m.name
-            value = m.do_getattr(d)
+            value = getattr(d, name)
             if value is True:
                 widget.set(name, name)
             elif value:
@@ -284,13 +284,27 @@ def set_tag(self, tag: str):
         assert w is not None
         w.tag = tag
 
-    def set_attrs(self, attrs: dict[str, str]):
+    def set_attrs(
+        self, attrs: Optional[dict[str, str]], oldattrs: Optional[dict[str, str]]
+    ):
         """Set any attributes not explicitly defined"""
         w = self.widget
         assert w is not None
-        set_attr = w.set
-        for k, v in attrs.items():
-            set_attr(k, v)
+        if attrs and oldattrs:
+            # Attrs changed
+            for k in oldattrs:
+                if k not in attrs:
+                    w.attrib.pop(k, None)
+            for k, v in attrs.items():
+                w.set(k, v)
+        elif not attrs and oldattrs:
+            # All attrs removed
+            for k in oldattrs:
+                w.attrib.pop(k, None)
+        elif attrs and not oldattrs:
+            # Only new attrs
+            for k, v in attrs.items():
+                w.set(k, v)
 
     def set_cls(self, cls: Union[tuple[str], list[str], str]):
         if isinstance(cls, (tuple, list)):