Attempt to fix rendering of manually-added spaces, but break a bunch of other stuff in the process

Author: MaddyGuthridge

pyhtml/__tag_base.py

@@ -121,7 +121,12 @@ def _escape_children(self) -> bool:
         """
         return True
 
-    def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
+    def _render(
+        self,
+        indent: str,
+        options: FullRenderOptions,
+        skip_indent: bool = False,
+    ) -> list[str]:
         """
         Renders tag and its children to a list of strings where each string is
         a single line of output.
@@ -132,6 +137,8 @@ def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
             string to use for indentation
         options : FullOptions
             rendering options
+        skip_indent : bool
+            whether to skip indentation for this element
 
         Returns
         -------
@@ -148,8 +155,10 @@ def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
             )
         )
 
+        indent_str = "" if skip_indent else indent
+
         # Tag and attributes
-        opening = f"{indent}<{self._get_tag_name()}"
+        opening = f"{indent_str}<{self._get_tag_name()}"
 
         # Add pre-content
         if (pre := self._get_tag_pre_content()) is not None:
@@ -169,15 +178,17 @@ def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
             children = util.render_children(
                 self.children,
                 self._escape_children(),
-                "" if indent_increase is None else indent + indent_increase,
+                ""
+                if indent_increase is None
+                else indent + indent_increase,
                 options,
             )
             closing = f"</{self._get_tag_name()}>"
             if options.spacing == "\n":
                 return [
                     opening,
                     *children,
-                    f"{indent}{closing}",
+                    f"{indent_str}{closing}",
                 ]
             else:
                 # Children must have at least one line, since we would have
@@ -190,7 +201,7 @@ def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
                 # Add the closing tag onto the end
                 return [
                     *out[:-1],
-                    out[-1] + options.spacing + closing,
+                    indent_str + out[-1] + options.spacing + closing,
                 ]
 
     def render(self) -> str:
@@ -217,11 +228,17 @@ def __init__(
         # Self-closing tags don't allow children
         super().__init__(*options, **attributes)
 
-    def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
+    def _render(
+        self,
+        indent: str,
+        options: FullRenderOptions,
+        skip_indent: bool = False,
+    ) -> list[str]:
         """
         Renders tag and its children to a list of strings where each string is
         a single line of output
         """
+        indent_str = "" if skip_indent else indent
         attributes = util.filter_attributes(
             util.dict_union(
                 self._get_default_attributes(self.attributes),
@@ -230,11 +247,11 @@ def _render(self, indent: str, options: FullRenderOptions) -> list[str]:
         )
         if len(attributes):
             return [
-                f"{indent}<{self._get_tag_name()} "
+                f"{indent_str}<{self._get_tag_name()} "
                 f"{util.render_tag_attributes(attributes)}/>"
             ]
         else:
-            return [f"{indent}<{self._get_tag_name()}/>"]
+            return [f"{indent_str}<{self._get_tag_name()}/>"]
 
 
 @deprecated(

pyhtml/__util.py

@@ -101,17 +101,21 @@ def render_inline_element(
     """
     from .__tag_base import Tag
 
+    skip_indent = options.spacing is not None and "\n" not in options.spacing
+
     if isinstance(ele, Tag):
-        return ele._render(indent, options)
+        return ele._render(indent, options, skip_indent)
     elif isinstance(ele, type) and issubclass(ele, Tag):
         e = ele()
-        return e._render(indent, options)
+        return e._render(indent, options, skip_indent)
     else:
         # Remove newlines from strings when inline rendering
         if escape_strings:
-            return increase_indent([escape_string(str(ele))], indent)
+            return increase_indent(
+                [escape_string(str(ele))], "" if skip_indent else indent
+            )
         else:
-            return increase_indent([str(ele)], indent)
+            return increase_indent([str(ele)], "" if skip_indent else indent)
 
 
 def render_children(
@@ -135,7 +139,6 @@ def render_children(
         else:
             # Custom spacing
             if len(rendered) == 0:
-                rendered_child[0] = rendered_child[0].strip()
                 rendered = rendered_child
             else:
                 *r_head, r_tail = rendered
@@ -145,8 +148,8 @@ def render_children(
                 # Join it all nicely
                 rendered = [
                     *r_head,
-                    # Remove leading whitespace caused by indentation rules
-                    r_tail + options.spacing + c_head.lstrip(),
+                    # Join using spacing as separator
+                    r_tail + options.spacing + c_head,
                     *c_tail,
                 ]
     return rendered

tests/render_options_test.py

@@ -77,6 +77,25 @@ def test_mixed_spacing():
     )
 
 
+def test_spacing_str():
+    doc = p.body(
+        p.div(
+            p.RenderOptions(spacing=" "),
+            p.span(p.RenderOptions(spacing="\n"), "hi"),
+        ),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body>",
+            "  <div> <span>",
+            "    hi",
+            "  </span> </div>",
+            "</body>",
+        ]
+    )
+
+
 def test_spacing_inner_newline():
     doc = p.body(
         p.div(
@@ -121,6 +140,11 @@ def test_indent_and_spacing_inner_newline():
     )
 
 
-def test_default_render_options():
+def test_default_render_options_paragraph():
     doc = p.p("Paragraph")
     assert str(doc) == "<p>Paragraph</p>"
+
+
+def test_extra_space_is_respected_in_paragraphs():
+    doc = p.p(" Paragraph ")
+    assert str(doc) == "<p> Paragraph </p>"

tests/whitespace_sensitive_test.py

@@ -21,7 +21,8 @@ def test_textarea():
 
 
 def test_indentation_ignored():
-    assert str(p.body(p.pre("hello\nworld"))) == '\n'.join([
+    doc = p.body(p.pre("hello\nworld"))
+    assert str(doc) == '\n'.join([
         "<body>",
         "  <pre>hello",
         "world</pre>",