htmy 0.7.4__py3-none-any.whl → 0.8.0__py3-none-any.whl

htmy/etree.py

@@ -1,23 +1,37 @@
 from __future__ import annotations
 
-import xml.etree.ElementTree as ET
-from collections.abc import Callable, Generator
 from typing import TYPE_CHECKING, ClassVar
 from xml.sax.saxutils import unescape
 
-if TYPE_CHECKING:
-    from collections.abc import Mapping
-    from xml.etree.ElementTree import Element
-
-    from htmy.typing import ComponentType, Properties
-
+try:
+    from lxml.etree import _Element as Element
+    from lxml.etree import tostring as etree_to_string
+    from lxml.html import fragment_fromstring as etree_from_string
+except ImportError:
+    from xml.etree.ElementTree import Element  # type: ignore[assignment]
+    from xml.etree.ElementTree import fromstring as etree_from_string  # type: ignore[assignment]
+    from xml.etree.ElementTree import tostring as etree_to_string  # type: ignore[no-redef]
 
+from htmy import ComponentType, Properties
 from htmy.core import Fragment, SafeStr, WildcardTag
 
+if TYPE_CHECKING:
+    from collections.abc import Callable, Generator, Mapping
+
 
 class ETreeConverter:
     """
     Utility for converting XML strings to custom components.
+
+    By default the converter uses the standard library's `xml.etree.ElementTree`
+    module for string to element tree, and element tree to string conversion,
+    but if `lxml` is installed, it will be used instead.
+
+    Installing `lxml` is recommended for better performance and additional features,
+    like performance and support for broken HTML fragments. **Important:** `lxml` is
+    far more lenient and flexible than the standard library, so having it installed is
+    not only a performance boost, but it may also slightly change the element conversion
+    behavior in certain edge-cases!
     """
 
     __slots__ = ("_rules",)
@@ -43,15 +57,15 @@ class ETreeConverter:
             return SafeStr(element)
 
         element = f"<{self._htmy_fragment}>{element}</{self._htmy_fragment}>"
-        return self.convert_element(ET.fromstring(element))  # noqa: S314 # Only use from XML strings from a trusted source.
+        return self.convert_element(etree_from_string(element))  # noqa: S314 # Only use XML strings from a trusted source.
 
     def convert_element(self, element: Element) -> ComponentType:
         """Converts the given `Element` to a component."""
         rules = self._rules
         if len(rules) == 0:
-            return SafeStr(ET.tostring(element))
+            return SafeStr(etree_to_string(element, encoding="unicode"))
 
-        tag: str = element.tag
+        tag: str = element.tag  # type: ignore[assignment]
         component = Fragment if tag == self._htmy_fragment else rules.get(tag)
         children = self._convert_children(element)
         properties = self._convert_properties(element)

{htmy-0.7.4.dist-info → htmy-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: htmy
-Version: 0.7.4
+Version: 0.8.0
 Summary: Async, pure-Python server-side rendering engine.
 License: MIT
 Author: Peter Volf
@@ -12,9 +12,11 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: lxml
 Requires-Dist: anyio (>=4.6.2.post1,<5.0.0)
 Requires-Dist: async-lru (>=2.0.4,<3.0.0)
-Requires-Dist: markdown (>=3.7,<4.0)
+Requires-Dist: lxml (>=6.0.0) ; extra == "lxml"
+Requires-Dist: markdown (>=3.8,<4.0)
 Description-Content-Type: text/markdown
 
 ![Tests](https://github.com/volfpeter/htmy/actions/workflows/tests.yml/badge.svg)
@@ -47,6 +49,20 @@ Unleash your creativity with the full power and Python, without the hassle of le
 - Automatic and customizable **property-name conversion** from snake case to kebab case.
 - **Fully-typed**.
 
+## Testimonials
+
+"Thank you for your work on `fasthx`, as well as `htmy`! I've never had an easier time developing with another stack." ([ref](https://github.com/volfpeter/fasthx/discussions/77))
+
+"One of the main parts of the `FastAPI` -> `fasthx` -> `htmy` integration I'm falling in love with is its explicitness, and not too much magic happening." ([ref](https://github.com/volfpeter/fasthx/issues/54))
+
+"Thank you for your work on `htmy` and `fasthx`, both have been very pleasant to use, and the APIs are both intuitive and simple. Great work." ([ref](https://github.com/volfpeter/fasthx/issues/54))
+
+"I love that the language-embedded HTML generation library approach is becoming more popular." ([ref](https://www.reddit.com/r/programming/comments/1h1a0dx/comment/lzd3phw))
+
+"Neat approach and it naturally solves the partial templates problem 👍" ([ref](https://www.reddit.com/r/Python/comments/1gp3mww/comment/lwqj4fc))
+
+"Great API design!" ([ref](https://www.reddit.com/r/Python/comments/1gp3mww/comment/lwpdyq9))
+
 ## Support
 
 Consider supporting the development and maintenance of the project through [sponsoring](https://buymeacoffee.com/volfpeter), or reach out for [consulting](https://www.volfp.com/contact?subject=Consulting%20-%20HTMY) so you can get the most out of the library.
@@ -59,6 +75,10 @@ The package is available on PyPI and can be installed with:
 $ pip install htmy
 ```
 
+The package has the following optional dependencies:
+
+- `lxml` *(recommended)*: When installed, it is prioritized over `xml.etree.ElementTree` and provides more secure, faster, and more flexible HTML and XML processing. It is used, for example, for Markdown processing. Install with: `pip install "htmy[lxml]"`.
+
 ## Concepts
 
 The entire library -- from the rendering engine itself to the built-in components -- is built around a few simple protocols and a handful of simple utility classes. This means that you can easily customize, extend, or replace basically everything in the library. Yes, even the rendering engine. The remaining parts will keep working as expected.

{htmy-0.7.4.dist-info → htmy-0.8.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 htmy/__init__.py,sha256=Us5P9Y6ZSp38poIz88bsAh2Hxuze5jE3V_uMtMyuH-E,1880
 htmy/core.py,sha256=mvNbxTRS8HNnjMSwe4NEJdL1KF19pJImF4Ciip6837I,15484
-htmy/etree.py,sha256=yKxom__AdsJY-Q1kbU0sdTMr0ZF5dMSVBKxayntNFyQ,3062
+htmy/etree.py,sha256=3znZCYQ5xbNqyXYSYFkUh6M22QLWMYWhTNjUcgpjCLc,4051
 htmy/function_component.py,sha256=iSp5cGrErmIsc-VfNq053_J2m-Nuu_k2xK9UxvEnlw8,12431
 htmy/html.py,sha256=dXYLYmyW1VR4mesib2iBLLdqMBAP3y4JmeGFZs6RLgI,21077
 htmy/i18n.py,sha256=Kobvm9mFoNcJas52KQbheiRIzJF1Ad1azOhtfm_k0BE,5123
@@ -15,7 +15,7 @@ htmy/renderer/default.py,sha256=G6K5YptvH9QvEvMQZdLPtgUblO_zTv4Eo6TETHZDlX8,1086
 htmy/snippet.py,sha256=9-ltfs4rugv6kFNzAY0PYNP3YI3xvJG8lkxEnYcCYWw,10538
 htmy/typing.py,sha256=0spTpz_JWql2yy_lSlRx0uqgXar7fxwyBqWeIzltvKU,3111
 htmy/utils.py,sha256=Kp0j9G8CBeRiyFGmz-CoDiLtXHfpvHzlTVsWeDhIebM,1935
-htmy-0.7.4.dist-info/LICENSE,sha256=rFtoGU_3c_rlacXgOZapTHfMErN-JFPT5Bq_col4bqI,1067
-htmy-0.7.4.dist-info/METADATA,sha256=wG-PRcvuIxfTlxdI2TbOGSPE5c5x6xZ3zR5LMABxe7E,18714
-htmy-0.7.4.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-htmy-0.7.4.dist-info/RECORD,,
+htmy-0.8.0.dist-info/LICENSE,sha256=rFtoGU_3c_rlacXgOZapTHfMErN-JFPT5Bq_col4bqI,1067
+htmy-0.8.0.dist-info/METADATA,sha256=bJLl5E0h85GOmvrmukpKHtxfiwQjwPQum2l1e0fCrWw,20123
+htmy-0.8.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+htmy-0.8.0.dist-info/RECORD,,

{htmy-0.7.4.dist-info → htmy-0.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any