PyPI - webwidgets - Versions diffs - 0.2.1__tar.gz → 1.0.0__tar.gz - Mend

webwidgets 0.2.1tar.gz → 1.0.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

webwidgets-1.0.0/.gitignore ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ __pycache__
2	+ ignore

webwidgets-1.0.0/PKG-INFO ADDED Viewed

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: webwidgets
+Version: 1.0.0
+Summary: A Python package for designing web UIs.
+Project-URL: Source code, https://github.com/mlaasri/WebWidgets
+Author: mlaasri
+License-File: LICENSE
+Keywords: design,webui
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+# WebWidgets
+![CI Status](https://img.shields.io/github/actions/workflow/status/mlaasri/WebWidgets/ci-full.yml?branch=main)
+A Python package for creating web UIs
+## Installation
+You can install **WebWidgets** with `pip`. To install the latest stable version, run:
+```bash
+pip install webwidgets
+```
+## Usage
+**WebWidgets** allows you to create custom widgets and build websites with them. For example:
+```python
+import webwidgets as ww
+from webwidgets.compilation.html import HTMLNode, RawText
+# A <div> element
+class Div(HTMLNode):
+    pass
+# A simple text widget
+class Text(ww.Widget):
+    def build(self):
+        return Div([RawText("Hello, World!")])
+# A website with one page containing a Text widget
+page = ww.Page([Text()])
+website = ww.Website([page])
+# Compile the website into HTML code
+compiled = website.compile()
+print(compiled.html_content[0])
+```
+Prints the following result:
+```console
+<!DOCTYPE html>
+<html>
+    <head></head>
+    <body>
+        <div>
+            Hello, World!
+        </div>
+    </body>
+</html>
+```

webwidgets-1.0.0/README.md ADDED Viewed

@@ -0,0 +1,53 @@
+# WebWidgets
+![CI Status](https://img.shields.io/github/actions/workflow/status/mlaasri/WebWidgets/ci-full.yml?branch=main)
+A Python package for creating web UIs
+## Installation
+You can install **WebWidgets** with `pip`. To install the latest stable version, run:
+```bash
+pip install webwidgets
+```
+## Usage
+**WebWidgets** allows you to create custom widgets and build websites with them. For example:
+```python
+import webwidgets as ww
+from webwidgets.compilation.html import HTMLNode, RawText
+# A <div> element
+class Div(HTMLNode):
+    pass
+# A simple text widget
+class Text(ww.Widget):
+    def build(self):
+        return Div([RawText("Hello, World!")])
+# A website with one page containing a Text widget
+page = ww.Page([Text()])
+website = ww.Website([page])
+# Compile the website into HTML code
+compiled = website.compile()
+print(compiled.html_content[0])
+```
+Prints the following result:
+```console
+<!DOCTYPE html>
+<html>
+    <head></head>
+    <body>
+        <div>
+            Hello, World!
+        </div>
+    </body>
+</html>
+```

{webwidgets-0.2.1 → webwidgets-1.0.0}/tests/compilation/test_html_node.py RENAMED Viewed

@@ -12,7 +12,7 @@
 import pytest
 from webwidgets.compilation.html.html_node import HTMLNode, no_start_tag, \
-    no_end_tag, one_line, RawText
+    no_end_tag, one_line, RawText, RootNode
 class TestHTMLNode:
@@ -63,9 +63,14 @@ class TestHTMLNode:
     def test_attributes(self):
         node = HTMLNode(attributes={'id': 'test-id', 'class': 'test-class'})
-        assert node.start_tag == '<htmlnode id="test-id" class="test-class">'
+        assert node.start_tag == '<htmlnode class="test-class" id="test-id">'
         assert node.end_tag == '</htmlnode>'
-        assert node.to_html() == '<htmlnode id="test-id" class="test-class"></htmlnode>'
+        assert node.to_html() == '<htmlnode class="test-class" id="test-id"></htmlnode>'
+    def test_attributes_order(self):
+        node = HTMLNode(attributes={'d': '0', 'a': '1', 'c': '2', 'b': '3'})
+        assert node._render_attributes() == 'a="1" b="3" c="2" d="0"'
+        assert node.to_html() == '<htmlnode a="1" b="3" c="2" d="0"></htmlnode>'
     def test_no_start_tag(self):
         node = TestHTMLNode.NoStartNode()
@@ -230,7 +235,7 @@ class TestHTMLNode:
         assert node.to_html() == expected_html
     @pytest.mark.parametrize("indent_level", [0, 1, 2])
-    @pytest.mark.parametrize("indent_size", [3, 4, 8])
+    @pytest.mark.parametrize("indent_size", [2, 3, 4, 8])
     def test_indentation(self, indent_level: int, indent_size: int):
         """Test the to_html method with different indentation parameters."""
@@ -270,6 +275,28 @@ class TestHTMLNode:
             indent_size=indent_size, indent_level=indent_level)
         assert actual_html == expected_html
+    @pytest.mark.parametrize("indent_level", [-3, -2, -1])
+    def test_negative_indent_level(self, indent_level: int):
+        node = HTMLNode(children=[
+            RawText('child1'),
+            RawText('child2'),
+            HTMLNode(children=[
+                RawText('grandchild1'),
+                RawText('grandchild2')
+            ])
+        ])
+        expected_html = "\n".join([
+            "<htmlnode>",
+            "child1",
+            "child2",
+            "<htmlnode>",
+            f"{'    ' if indent_level == -1 else ''}grandchild1",
+            f"{'    ' if indent_level == -1 else ''}grandchild2",
+            "</htmlnode>",
+            "</htmlnode>"
+        ])
+        assert node.to_html(indent_level=indent_level) == expected_html
     def test_collapse_empty(self):
         node = HTMLNode(children=[
             TestHTMLNode.CustomNode(),
@@ -441,3 +468,16 @@ class TestHTMLNode:
         copied_node.children.append(child)
         assert len(node.children) == 1
         assert id(node.children[0]) == id(child)
+    def test_empty_root_node(self):
+        node = RootNode()
+        assert node.to_html() == ""
+    @pytest.mark.parametrize("n", [1, 2, 3])
+    def test_root_node_with_children(self, n):
+        node = RootNode(
+            children=[HTMLNode()] * n
+        )
+        expected_html = "\n".join(["<htmlnode></htmlnode>"] * n)
+        print(expected_html)
+        assert node.to_html() == expected_html

{webwidgets-0.2.1 → webwidgets-1.0.0}/tests/compilation/test_html_tags.py RENAMED Viewed

@@ -21,7 +21,21 @@ class TestHTMLTags:
     def test_text_node_with_attributes(self):
         text_node = TextNode("Hello, World!",
                              attributes={"class": "my-class", "id": "my-id"})
-        assert text_node.to_html() in [
-            '<textnode class="my-class" id="my-id">Hello, World!</textnode>',
-            '<textnode id="my-id" class="my-class">Hello, World!</textnode>',
-        ]
+        assert text_node.to_html() == \
+            '<textnode class="my-class" id="my-id">Hello, World!</textnode>'
+    def test_body(self):
+        body = Body()
+        assert body.to_html() == "<body></body>"
+    def test_doctype(self):
+        doctype = Doctype()
+        assert doctype.to_html() == "<!DOCTYPE html>"
+    def test_head(self):
+        head = Head()
+        assert head.to_html() == "<head></head>"
+    def test_html(self):
+        html = Html()
+        assert html.to_html() == "<html></html>"

webwidgets-1.0.0/tests/utility/test_indentation.py ADDED Viewed

@@ -0,0 +1,29 @@
+# =======================================================================
+#
+#  This file is part of WebWidgets, a Python package for designing web
+#  UIs.
+#
+#  You should have received a copy of the MIT License along with
+#  WebWidgets. If not, see <https://opensource.org/license/mit>.
+#
+#  Copyright(C) 2025, mlaasri
+#
+# =======================================================================
+import pytest
+from webwidgets.utility.indentation import get_indentation
+class TestIndentation:
+    @pytest.mark.parametrize("indent_level", [0, 1, 2])
+    @pytest.mark.parametrize("indent_size", [3, 4, 8])
+    def test_get_indentation(self, indent_level: int, indent_size: int):
+        """Tests get_indentation with different indentation levels and sizes."""
+        expected_indentation = ' ' * indent_size * indent_level
+        assert get_indentation(
+            indent_level, indent_size) == expected_indentation
+    @pytest.mark.parametrize("indent_level", [-2, -1, 0])
+    @pytest.mark.parametrize("indent_size", [3, 4, 8])
+    def test_get_indentation_for_negative_levels(self, indent_level, indent_size):
+        assert get_indentation(indent_level, indent_size) == ''

webwidgets-1.0.0/tests/website/__init__.py ADDED Viewed

@@ -0,0 +1,11 @@
+# =======================================================================
+#
+#  This file is part of WebWidgets, a Python package for designing web
+#  UIs.
+#
+#  You should have received a copy of the MIT License along with
+#  WebWidgets. If not, see <https://opensource.org/license/mit>.
+#
+#  Copyright(C) 2025, mlaasri
+#
+# =======================================================================

webwidgets-1.0.0/tests/website/test_website.py ADDED Viewed

@@ -0,0 +1,402 @@
+# =======================================================================
+#
+#  This file is part of WebWidgets, a Python package for designing web
+#  UIs.
+#
+#  You should have received a copy of the MIT License along with
+#  WebWidgets. If not, see <https://opensource.org/license/mit>.
+#
+#  Copyright(C) 2025, mlaasri
+#
+# =======================================================================
+import pytest
+from typing import Dict
+import webwidgets as ww
+from webwidgets.compilation.html.html_node import HTMLNode, RawText
+class TestWebsite:
+    class Empty(ww.Widget):
+        def build(self):
+            return HTMLNode()
+    class Text(ww.Widget):
+        def __init__(self, text: str, style: Dict[str, str] = None):
+            super().__init__()
+            self.text = text
+            self.style = style
+        def build(self):
+            return HTMLNode(children=[RawText(self.text)], style=self.style)
+    class SimpleWebsite(ww.Website):
+        def __init__(self):
+            page = ww.Page([
+                TestWebsite.Text("Text!", {"padding": "0"}),
+                TestWebsite.Text("Another Text!", {"margin": "0"}),
+            ])
+            super().__init__([page])
+    @pytest.mark.parametrize("num_pages", [1, 2, 3])
+    @pytest.mark.parametrize("num_widgets", [1, 2, 3])
+    @pytest.mark.parametrize("text", ["a", "b", "c"])
+    def test_compile_website_without_css(self, num_pages, num_widgets, text):
+        # Create a new website object
+        website = ww.Website()
+        for _ in range(num_pages):
+            website.add(ww.Page([TestWebsite.Text(text)] * num_widgets))
+        # Compile the website to HTML
+        compiled = website.compile()
+        # Check if the compiled HTML contains the expected code
+        expected_html = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head></head>",
+            "    <body>"
+        ]) + "\n" + "\n".join([
+            "        <htmlnode>",
+            f"            {text}",
+            "        </htmlnode>",
+        ] * num_widgets) + "\n" + "\n".join([
+            "    </body>",
+            "</html>"
+        ])
+        assert len(compiled.html_content) == num_pages
+        assert all(c == expected_html for c in compiled.html_content)
+        # Check if the compiled CSS contains the expected code
+        assert compiled.css_content == ""  # No CSS in this case
+    @pytest.mark.parametrize("num_pages", [1, 2, 3, 4, 5, 6])
+    @pytest.mark.parametrize("num_widgets", [1, 2, 3])
+    @pytest.mark.parametrize("text", ["a", "b", "c"])
+    def test_compile_website_with_css(self, num_pages, num_widgets, text):
+        # Defining a set of styles to pick from
+        styles = [{"margin": "0"}, {"color": "blue"}, {"font-size": "16px"}]
+        # Compile expected rule names based on number of pages involved
+        rule_names = {
+            1: ["r0"],
+            2: ["r1", "r0"],
+            3: ["r2", "r0", "r1"]
+        }
+        for k in range(4, num_pages + 1):
+            rule_names[k] = [rule_names[3][i % len(styles)] for i in range(k)]
+        # Create a new website object
+        website = ww.Website()
+        for i in range(num_pages):
+            website.add(
+                ww.Page([
+                    TestWebsite.Text(text, styles[i % len(styles)])
+                ] * num_widgets))
+        # Compile the website to HTML
+        compiled = website.compile()
+        # Check if the compiled HTML contains the expected code
+        expected_html = [(
+            "\n".join([
+                "<!DOCTYPE html>",
+                "<html>",
+                "    <head>",
+                '        <link href="styles.css" rel="stylesheet">',
+                "    </head>",
+                "    <body>"
+            ]) + "\n" + "\n".join([
+                f'        <htmlnode class="{rule_names[num_pages][i % len(rule_names)]}">',
+                f"            {text}",
+                "        </htmlnode>",
+            ] * num_widgets) + "\n" + "\n".join([
+                "    </body>",
+                "</html>"
+            ])) for i in range(num_pages)]
+        assert compiled.html_content == expected_html
+        # Check if the compiled CSS contains the expected code
+        sorted_rules = sorted(list(set(
+            zip(rule_names[num_pages],
+                [list(styles[i % len(styles)].items())[0]
+                 for i in range(num_pages)]))), key=lambda x: x[0])
+        expected_css = "\n\n".join([
+            '\n'.join([
+                f".{name} " + "{",
+                f"    {p}: {v};",
+                "}"
+            ]) for name, (p, v) in sorted_rules
+        ])
+        assert compiled.css_content == expected_css
+    def test_compile_collapse_empty(self):
+        website = ww.Website([ww.Page([TestWebsite.Empty()])])
+        # Collapse empty elements
+        compiled_true = website.compile(collapse_empty=True)
+        expected_html_true = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head></head>",
+            "    <body>",
+            "        <htmlnode></htmlnode>",
+            "    </body>",
+            "</html>"
+        ])
+        assert len(compiled_true.html_content) == 1
+        assert compiled_true.html_content[0] == expected_html_true
+        assert compiled_true.css_content == ""
+        # Don't collapse empty elements
+        compiled_false = website.compile(collapse_empty=False)
+        expected_html_false = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head>",
+            "    </head>",
+            "    <body>",
+            "        <htmlnode>",
+            "        </htmlnode>",
+            "    </body>",
+            "</html>"
+        ])
+        assert len(compiled_false.html_content) == 1
+        assert compiled_false.html_content[0] == expected_html_false
+        assert compiled_false.css_content == ""
+    @pytest.mark.parametrize("css_file_name",
+                             ["style.css", "s.css", "css.css"])
+    def test_compile_css_file_name(self, css_file_name):
+        website = TestWebsite.SimpleWebsite()
+        compiled = website.compile(css_file_name=css_file_name)
+        expected_html = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head>",
+            f'        <link href="{css_file_name}" rel="stylesheet">',
+            "    </head>",
+            "    <body>",
+            '        <htmlnode class="r1">',
+            "            Text!",
+            "        </htmlnode>",
+            '        <htmlnode class="r0">',
+            "            Another Text!",
+            "        </htmlnode>",
+            "    </body>",
+            "</html>"
+        ])
+        expected_css = "\n".join([
+            ".r0 {",
+            "    margin: 0;",
+            "}",
+            "",
+            ".r1 {",
+            "    padding: 0;",
+            "}"
+        ])
+        assert len(compiled.html_content) == 1
+        assert compiled.html_content[0] == expected_html
+        assert compiled.css_content == expected_css
+    def test_compile_force_one_line(self):
+        website = TestWebsite.SimpleWebsite()
+        expected_css = "\n".join([
+            ".r0 {",
+            "    margin: 0;",
+            "}",
+            "",
+            ".r1 {",
+            "    padding: 0;",
+            "}"
+        ])
+        # Force one line HTML
+        compiled_true = website.compile(force_one_line=True)
+        expected_html_true = ''.join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "<head>",
+            '<link href="styles.css" rel="stylesheet">',
+            "</head>",
+            "<body>",
+            '<htmlnode class="r1">',
+            "Text!",
+            "</htmlnode>",
+            '<htmlnode class="r0">',
+            "Another Text!",
+            "</htmlnode>",
+            "</body>",
+            "</html>"
+        ])
+        assert len(compiled_true.html_content) == 1
+        assert compiled_true.html_content[0] == expected_html_true
+        assert compiled_true.css_content == expected_css
+        # Don't force one line HTML
+        compiled_false = website.compile(force_one_line=False)
+        expected_html_false = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head>",
+            '        <link href="styles.css" rel="stylesheet">',
+            "    </head>",
+            "    <body>",
+            '        <htmlnode class="r1">',
+            "            Text!",
+            "        </htmlnode>",
+            '        <htmlnode class="r0">',
+            "            Another Text!",
+            "        </htmlnode>",
+            "    </body>",
+            "</html>"
+        ])
+        assert len(compiled_false.html_content) == 1
+        assert compiled_false.html_content[0] == expected_html_false
+        assert compiled_false.css_content == expected_css
+    @pytest.mark.parametrize("indent_level", [0, 1, 2])
+    @pytest.mark.parametrize("indent_size", [2, 3, 4, 8])
+    def test_compile_indentation(self, indent_level: int, indent_size: int):
+        """Test the `compile` method with custom indentation levels and sizes."""
+        website = TestWebsite.SimpleWebsite()
+        compiled = website.compile(
+            indent_level=indent_level,
+            indent_size=indent_size
+        )
+        # Check the results
+        expected_html = "\n".join([
+            f"{' ' * indent_size * indent_level}<!DOCTYPE html>",
+            f"{' ' * indent_size * indent_level}<html>",
+            f"{' ' * indent_size * (indent_level + 1)}<head>",
+            f'{" " * indent_size * (indent_level + 2)}<link href="styles.css" rel="stylesheet">',
+            f"{' ' * indent_size * (indent_level + 1)}</head>",
+            f"{' ' * indent_size * (indent_level + 1)}<body>",
+            f'{" " * indent_size * (indent_level + 2)}<htmlnode class="r1">',
+            f"{' ' * indent_size * (indent_level + 3)}Text!",
+            f"{' ' * indent_size * (indent_level + 2)}</htmlnode>",
+            f'{" " * indent_size * (indent_level + 2)}<htmlnode class="r0">',
+            f"{' ' * indent_size * (indent_level + 3)}Another Text!",
+            f"{' ' * indent_size * (indent_level + 2)}</htmlnode>",
+            f"{' ' * indent_size * (indent_level + 1)}</body>",
+            f"{' ' * indent_size * indent_level}</html>"
+        ])
+        assert len(compiled.html_content) == 1
+        assert compiled.html_content[0] == expected_html
+        expected_css = "\n".join([
+            ".r0 {",
+            f"{' ' * indent_size}margin: 0;",
+            "}",
+            "",
+            ".r1 {",
+            f"{' ' * indent_size}padding: 0;",
+            "}"
+        ])
+        assert compiled.css_content == expected_css
+    @pytest.mark.parametrize("indent_level", [-2, -1])
+    def test_compile_negative_indent_levels(self, indent_level: int):
+        website = TestWebsite.SimpleWebsite()
+        compiled = website.compile(indent_level=indent_level)
+        indent = "    " if indent_level == -1 else ""
+        expected_html = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "<head>",
+            f'{indent}<link href="styles.css" rel="stylesheet">',
+            "</head>",
+            "<body>",
+            f'{indent}<htmlnode class="r1">',
+            f"{indent}    Text!",
+            f"{indent}</htmlnode>",
+            f'{indent}<htmlnode class="r0">',
+            f"{indent}    Another Text!",
+            f"{indent}</htmlnode>",
+            "</body>",
+            "</html>"
+        ])
+        expected_css = "\n".join([
+            ".r0 {",
+            "    margin: 0;",
+            "}",
+            "",
+            ".r1 {",
+            "    padding: 0;",
+            "}"
+        ])
+        assert len(compiled.html_content) == 1
+        assert compiled.html_content[0] == expected_html
+        assert compiled.css_content == expected_css
+    def test_compile_rule_namer(self):
+        """Test the `compile` method with a custom rule namer function."""
+        # Define a custom rule namer function
+        def custom_rule_namer(rules, index):
+            return f"custom_{index}_{list(rules[index].declarations.keys())[0]}"
+        # Compile a simple website with the custom rule namer
+        website = TestWebsite.SimpleWebsite()
+        compiled = website.compile(rule_namer=custom_rule_namer)
+        # Check the results
+        expected_html = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head>",
+            '        <link href="styles.css" rel="stylesheet">',
+            "    </head>",
+            "    <body>",
+            '        <htmlnode class="custom_1_padding">',
+            "            Text!",
+            "        </htmlnode>",
+            '        <htmlnode class="custom_0_margin">',
+            "            Another Text!",
+            "        </htmlnode>",
+            "    </body>",
+            "</html>"
+        ])
+        assert len(compiled.html_content) == 1
+        assert compiled.html_content[0] == expected_html
+        expected_css = "\n".join([
+            ".custom_0_margin {",
+            "    margin: 0;",
+            "}",
+            "",
+            ".custom_1_padding {",
+            "    padding: 0;",
+            "}"
+        ])
+        assert compiled.css_content == expected_css
+    def test_compile_kwargs(self):
+        website = TestWebsite.SimpleWebsite()
+        compiled = website.compile(replace_all_entities=True)
+        expected_html = "\n".join([
+            "<!DOCTYPE html>",
+            "<html>",
+            "    <head>",
+            '        <link href="styles.css" rel="stylesheet">',
+            "    </head>",
+            "    <body>",
+            '        <htmlnode class="r1">',
+            "            Text&excl;",
+            "        </htmlnode>",
+            '        <htmlnode class="r0">',
+            "            Another Text&excl;",
+            "        </htmlnode>",
+            "    </body>",
+            "</html>"
+        ])
+        expected_css = "\n".join([
+            ".r0 {",
+            "    margin: 0;",
+            "}",
+            "",
+            ".r1 {",
+            "    padding: 0;",
+            "}"
+        ])
+        assert len(compiled.html_content) == 1
+        assert compiled.html_content[0] == expected_html
+        assert compiled.css_content == expected_css

webwidgets-1.0.0/tests/widgets/__init__.py ADDED Viewed

@@ -0,0 +1,11 @@
+# =======================================================================
+#
+#  This file is part of WebWidgets, a Python package for designing web
+#  UIs.
+#
+#  You should have received a copy of the MIT License along with
+#  WebWidgets. If not, see <https://opensource.org/license/mit>.
+#
+#  Copyright(C) 2025, mlaasri
+#
+# =======================================================================

webwidgets 0.2.1__tar.gz → 1.0.0__tar.gz

webwidgets 0.2.1tar.gz → 1.0.0tar.gz