htmy 0.3.5__py3-none-any.whl → 0.3.6__py3-none-any.whl

htmy/core.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import abc
 import asyncio
 import enum
-from collections.abc import Callable, Container
+from collections.abc import Awaitable, Callable, Container
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, ClassVar, Generic, TypedDict, cast, overload
 from xml.sax.saxutils import escape as xml_escape
@@ -21,6 +21,7 @@ from .typing import (
     PropertyValue,
     SyncFunctionComponent,
     T,
+    TextProcessor,
     is_component_sequence,
 )
 from .utils import join_components
@@ -130,21 +131,34 @@ class Snippet:
     Base component that can load its content from a file.
     """
 
-    __slots__ = ("_path_or_text",)
+    __slots__ = ("_path_or_text", "_text_processor")
 
-    def __init__(self, path_or_text: Text | str | Path) -> None:
+    def __init__(
+        self,
+        path_or_text: Text | str | Path,
+        *,
+        text_processor: TextProcessor | None = None,
+    ) -> None:
         """
         Initialization.
 
         Arguments:
             path_or_text: The path from where the content should be loaded or a `Text`
                 instance if this value should be rendered directly.
+            text_processor: An optional text processors that can be used to process the text
+                content before rendering. It can be used for example for token replacement or
+                string formatting.
         """
         self._path_or_text = path_or_text
+        self._text_processor = text_processor
 
     async def htmy(self, context: Context) -> Component:
         """Renders the component."""
         text = await self._get_text_content()
+        if self._text_processor is not None:
+            processed = self._text_processor(text, context)
+            text = (await processed) if isinstance(processed, Awaitable) else processed
+
         return self._render_text(text, context)
 
     async def _get_text_content(self) -> str:

htmy/md/core.py

@@ -5,6 +5,7 @@ from typing import TYPE_CHECKING, ClassVar
 from markdown import Markdown
 
 from htmy.core import ContextAware, SafeStr, Snippet, Text
+from htmy.typing import TextProcessor
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -90,6 +91,7 @@ class MD(Snippet):
         *,
         converter: Callable[[str], Component] | None = None,
         renderer: MarkdownRenderFunction | None = None,
+        text_processor: TextProcessor | None = None,
     ) -> None:
         """
         Initialization.
@@ -100,8 +102,11 @@ class MD(Snippet):
                 into an HTMY component.
             renderer: Function that get the parsed and converted content and the metadata (if it exists)
                 and turns them into an HTMY component.
+            text_processor: An optional text processors that can be used to process the text
+                content before rendering. It can be used for example for token replacement or
+                string formatting.
         """
-        super().__init__(path_or_text)
+        super().__init__(path_or_text, text_processor=text_processor)
         self._converter: Callable[[str], Component] = SafeStr if converter is None else converter
         self._renderer = renderer
 

htmy/typing.py

@@ -103,3 +103,9 @@ class AsyncContextProvider(Protocol):
 
 ContextProvider: TypeAlias = SyncContextProvider | AsyncContextProvider
 """Context provider type."""
+
+
+# -- Text processors
+
+TextProcessor: TypeAlias = Callable[[str, Context], str | Coroutine[Any, Any, str]]
+"""Callable type that expects a string and a context, and returns a processed string."""

{htmy-0.3.5.dist-info → htmy-0.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: htmy
-Version: 0.3.5
+Version: 0.3.6
 Summary: Async, pure-Python rendering engine.
 License: MIT
 Author: Peter Volf

{htmy-0.3.5.dist-info → htmy-0.3.6.dist-info}/RECORD

@@ -1,17 +1,17 @@
 htmy/__init__.py,sha256=My_Dmh9JNQpQekTO6CEbdbV7Ux7MD9Pz-L2M3KMZjGQ,1835
-htmy/core.py,sha256=JZNryJU1VCAVBf1wzkaa9bD3LiepT-Eu28XydfbWpOw,18735
+htmy/core.py,sha256=kdIE9s7mE-mphPraZvl5h7RL9NBVOYaRWsWsA0PpphM,19332
 htmy/etree.py,sha256=zZkKY82t5fX85unS9oHuG6KEBsJY_iz6E7SJto8lSVQ,3097
 htmy/html.py,sha256=pxmE-KU5OgwNp6MyxOfdS0Ohpzu2RNYCeGGFlHLDGUM,20940
 htmy/i18n.py,sha256=brNazQjObBFfbnViZCpcnxa0qgxQbJfX7xJAH-MqTW8,5124
 htmy/io.py,sha256=iebJOZp7L0kZ9SWdqMatKtW5VGRIkEd-eD0_vTAldH8,41
 htmy/md/__init__.py,sha256=lxBJnYplkDuxYuiese6My9KYp1DeGdzo70iUdYTvMnE,334
-htmy/md/core.py,sha256=-EKucDFKMUtGgs9k_q9134oXY2GXtdKX1KOJXG4YmKc,3342
+htmy/md/core.py,sha256=5fLEihxjBivknZUwiR13gc924K2_jnthv9xnSDsTfow,3686
 htmy/md/typing.py,sha256=LF-AEvo7FCW2KumyR5l55rsXizV2E4AHVLKFf6lApgM,762
 htmy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 htmy/renderer.py,sha256=vCYqq83RaEtlXKDGWB6LgKjoE1TSfMfB5TW1lJWHE5c,3829
-htmy/typing.py,sha256=iUZQjMU-DHMV1Mv-ugW26eSPlrFO-KVhWfkLod7dig4,2937
+htmy/typing.py,sha256=-_N9xE9bh0OvP2LRedh3OeuOGlJcipxm0Aul73IKN7E,3134
 htmy/utils.py,sha256=7_CyA39l2m6jzDqparPKkKgRB2wiGuBZXbiPgiZOXKA,1093
-htmy-0.3.5.dist-info/LICENSE,sha256=rFtoGU_3c_rlacXgOZapTHfMErN-JFPT5Bq_col4bqI,1067
-htmy-0.3.5.dist-info/METADATA,sha256=emcRbV2rYZ_RP4LqKGjzv3WBdadUpyQREdujGyycXt0,16347
-htmy-0.3.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-htmy-0.3.5.dist-info/RECORD,,
+htmy-0.3.6.dist-info/LICENSE,sha256=rFtoGU_3c_rlacXgOZapTHfMErN-JFPT5Bq_col4bqI,1067
+htmy-0.3.6.dist-info/METADATA,sha256=M0UqpgexbJ0963aacW3pVvd_puJu99S72yrmIrL4Pus,16347
+htmy-0.3.6.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+htmy-0.3.6.dist-info/RECORD,,