html-tstring 0.1.1__tar.gz → 0.1.2__tar.gz

{html_tstring-0.1.1 → html_tstring-0.1.2}/.gitignore

@@ -8,3 +8,6 @@ wheels/
 
 # Virtual environments
 .venv
+
+# Coverage
+.coverage

{html_tstring-0.1.1 → html_tstring-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: html-tstring
-Version: 0.1.1
+Version: 0.1.2
 Summary: A 🤘 rockin' t-string HTML templating system for Python 3.14.
 Project-URL: Homepage, https://github.com/t-strings/html-tstring
 Project-URL: Changelog, https://github.com/t-strings/html-tstring/releases
@@ -110,7 +110,6 @@ Boolean attributes are supported too. Just use a boolean value in the attribute
 
 ```python
 form_button = html(t"<button disabled={True} hidden={False}>Submit</button>")
-print(form_button)
 # <button disabled>Submit</button>
 ```
 
@@ -310,13 +309,15 @@ Because attributes are passed as keyword arguments, you can explicitly provide t
 ```python
 from typing import Any
 
-def Link(*, href: str, text: str, **props: Any) -> Template:
-    return t'<a href="{href}" {props}>{text}</a>'
+def Link(*, href: str, text: str, data_value: int, **attrs: Any) -> Template:
+    return t'<a href="{href}" {attrs}>{text}: {data_value}</a>'
 
-result = html(t'<{Link} href="https://example.com" text="Example" target="_blank" />')
-# <a href="https://example.com" target="_blank">Example</a>
+result = html(t'<{Link} href="https://example.com" text="Example" data-value={42} target="_blank" />')
+# <a href="https://example.com" target="_blank">Example: 42</a>
 ```
 
+Note that attributes with hyphens (like `data-value`) are converted to underscores (`data_value`) in the function signature.
+
 In addition to returning a `Template` directly, component functions may also return any `Node` type found in [`html_tstring.nodes`](https://github.com/t-strings/html-tstring/blob/main/html_tstring/nodes.py). This allows you to build more complex components that manipulate the HTML structure programmatically.
 
 #### SVG Support

{html_tstring-0.1.1 → html_tstring-0.1.2}/README.md

@@ -85,7 +85,6 @@ Boolean attributes are supported too. Just use a boolean value in the attribute
 
 ```python
 form_button = html(t"<button disabled={True} hidden={False}>Submit</button>")
-print(form_button)
 # <button disabled>Submit</button>
 ```
 
@@ -285,13 +284,15 @@ Because attributes are passed as keyword arguments, you can explicitly provide t
 ```python
 from typing import Any
 
-def Link(*, href: str, text: str, **props: Any) -> Template:
-    return t'<a href="{href}" {props}>{text}</a>'
+def Link(*, href: str, text: str, data_value: int, **attrs: Any) -> Template:
+    return t'<a href="{href}" {attrs}>{text}: {data_value}</a>'
 
-result = html(t'<{Link} href="https://example.com" text="Example" target="_blank" />')
-# <a href="https://example.com" target="_blank">Example</a>
+result = html(t'<{Link} href="https://example.com" text="Example" data-value={42} target="_blank" />')
+# <a href="https://example.com" target="_blank">Example: 42</a>
 ```
 
+Note that attributes with hyphens (like `data-value`) are converted to underscores (`data_value`) in the function signature.
+
 In addition to returning a `Template` directly, component functions may also return any `Node` type found in [`html_tstring.nodes`](https://github.com/t-strings/html-tstring/blob/main/html_tstring/nodes.py). This allows you to build more complex components that manipulate the HTML structure programmatically.
 
 #### SVG Support

{html_tstring-0.1.1 → html_tstring-0.1.2}/html_tstring/parser.py

@@ -95,6 +95,7 @@ class NodeParser(HTMLParser):
 
     def get_node(self) -> Node:
         """Get the Node tree parsed from the input HTML."""
+        # CONSIDER: Should we invert things and offer streaming parsing?
         assert not self.stack, "Did you forget to call close()?"
         if len(self.root.children) > 1:
             # The parse structure results in multiple root elements, so we

{html_tstring-0.1.1 → html_tstring-0.1.2}/html_tstring/processor.py

@@ -83,18 +83,16 @@ def _instrument(
         yield s
         # There are always count-1 placeholders between count strings.
         if i < count - 1:
+            placeholder = _placeholder(i)
+
             # Special case for component callables: if the interpolation
             # is a callable, we need to make sure that any matching closing
             # tag uses the same placeholder.
             callable_id = callable_ids[i]
-            if callable_id is not None:
-                # This interpolation is a callable, so we need to make sure
-                # that any matching closing tag uses the same placeholder.
-                if callable_id not in callable_placeholders:
-                    callable_placeholders[callable_id] = _placeholder(i)
-                yield callable_placeholders[callable_id]
-            else:
-                yield _placeholder(i)
+            if callable_id:
+                placeholder = callable_placeholders.setdefault(callable_id, placeholder)
+
+            yield placeholder
 
 
 @lru_cache()
@@ -187,7 +185,9 @@ def _substitute_style_attr(value: object) -> t.Iterable[tuple[str, str | None]]:
         yield ("style", str(value))
 
 
-def _substitute_spread_attrs(value: object) -> t.Iterable[tuple[str, str | None]]:
+def _substitute_spread_attrs(
+    value: object,
+) -> t.Iterable[tuple[str, object | None]]:
     """
     Substitute a spread attribute based on the interpolated value.
 
@@ -214,7 +214,7 @@ CUSTOM_ATTR_HANDLERS = {
 def _substitute_attr(
     key: str,
     value: object,
-) -> t.Iterable[tuple[str, str | None]]:
+) -> t.Iterable[tuple[str, object | None]]:
     """
     Substitute a single attribute based on its key and the interpolated value.
 
@@ -230,21 +230,19 @@ def _substitute_attr(
 
     # General handling for all other attributes:
     match value:
-        case str():
-            yield (key, value)
         case True:
             yield (key, None)
         case False | None:
             pass
         case _:
-            yield (key, str(value))
+            yield (key, value)
 
 
 def _substitute_attrs(
     attrs: dict[str, str | None], interpolations: tuple[Interpolation, ...]
-) -> dict[str, str | None]:
+) -> dict[str, object | None]:
     """Substitute placeholders in attributes based on the corresponding interpolations."""
-    new_attrs: dict[str, str | None] = {}
+    new_attrs: dict[str, object | None] = {}
     for key, value in attrs.items():
         if value and value.startswith(_PLACEHOLDER_PREFIX):
             index = _placholder_index(value)
@@ -299,14 +297,20 @@ def _node_from_value(value: object) -> Node:
             children = [_node_from_value(v) for v in value]
             return Fragment(children=children)
         case HasHTMLDunder():
+            # CONSIDER: could we return a lazy Text?
             return Text(Markup(value.__html__()))
         case _:
+            # CONSIDER: could we return a lazy Text?
             return Text(str(value))
 
 
+type ComponentReturn = Node | Template | str | HasHTMLDunder
+type ComponentCallable = t.Callable[..., ComponentReturn | t.Iterable[ComponentReturn]]
+
+
 def _invoke_component(
     tag: str,
-    new_attrs: dict[str, str | None],
+    new_attrs: dict[str, object | None],
     new_children: list[Node],
     interpolations: tuple[Interpolation, ...],
 ) -> Node:
@@ -314,12 +318,16 @@ def _invoke_component(
     index = _placholder_index(tag)
     interpolation = interpolations[index]
     value = format_interpolation(interpolation)
+    # TODO: consider use of signature() or other approaches to validation.
     if not callable(value):
         raise TypeError(
             f"Expected a callable for component invocation, got {type(value).__name__}"
         )
+    # Replace attr names hyphens with underscores for Python kwargs
+    kwargs = {k.replace("-", "_"): v for k, v in new_attrs.items()}
+
     # Call the component and return the resulting node
-    result = value(*new_children, **new_attrs)
+    result = value(*new_children, **kwargs)
     match result:
         case Node():
             return result
@@ -336,6 +344,11 @@ def _invoke_component(
             )
 
 
+def _stringify_attrs(attrs: dict[str, object | None]) -> dict[str, str | None]:
+    """Convert all attribute values to strings, preserving None values."""
+    return {k: str(v) if v is not None else None for k, v in attrs.items()}
+
+
 def _substitute_node(p_node: Node, interpolations: tuple[Interpolation, ...]) -> Node:
     """Substitute placeholders in a node based on the corresponding interpolations."""
     match p_node:
@@ -350,6 +363,7 @@ def _substitute_node(p_node: Node, interpolations: tuple[Interpolation, ...]) ->
             if tag.startswith(_PLACEHOLDER_PREFIX):
                 return _invoke_component(tag, new_attrs, new_children, interpolations)
             else:
+                new_attrs = _stringify_attrs(new_attrs)
                 return Element(tag=tag, attrs=new_attrs, children=new_children)
         case Fragment(children=children):
             new_children = _substitute_and_flatten_children(children, interpolations)

{html_tstring-0.1.1 → html_tstring-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "html-tstring"
-version = "0.1.1"
+version = "0.1.2"
 description = "A 🤘 rockin' t-string HTML templating system for Python 3.14."
 readme = "README.md"
 requires-python = ">=3.14"
@@ -34,6 +34,7 @@ CI = "https://github.com/t-strings/html-tstring/actions"
 dev = [
   "pyright>=1.1.404",
   "pytest>=8.4.1",
+  "pytest-cov>=6.3.0",
   "pytest-watcher>=0.4.3",
   "ruff>=0.12.11",
 ]