htmy 0.3.4__tar.gz → 0.3.6__tar.gz

{htmy-0.3.4 → htmy-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: htmy
-Version: 0.3.4
+Version: 0.3.6
 Summary: Async, pure-Python rendering engine.
 License: MIT
 Author: Peter Volf
@@ -295,6 +295,12 @@ If a component executes a potentially "long-running" synchronous call, it is str
 
 In all other cases, it's best to use sync components.
 
+## Framework integrations
+
+FastAPI:
+
+- [FastHX](https://github.com/volfpeter/fasthx)
+
 ## Why
 
 At one end of the spectrum, there are the complete application frameworks that combine the server (Python) and client (JavaScript) applications with the entire state management and synchronization into a single Python (an in some cases an additional JavaScript) package. Some of the most popular examples are: [Reflex](https://github.com/reflex-dev/reflex), [NiceGUI](https://github.com/zauberzeug/nicegui/), [ReactPy](https://github.com/reactive-python/reactpy), and [FastUI](https://github.com/pydantic/FastUI).

{htmy-0.3.4 → htmy-0.3.6}/README.md

@@ -276,6 +276,12 @@ If a component executes a potentially "long-running" synchronous call, it is str
 
 In all other cases, it's best to use sync components.
 
+## Framework integrations
+
+FastAPI:
+
+- [FastHX](https://github.com/volfpeter/fasthx)
+
 ## Why
 
 At one end of the spectrum, there are the complete application frameworks that combine the server (Python) and client (JavaScript) applications with the entire state management and synchronization into a single Python (an in some cases an additional JavaScript) package. Some of the most popular examples are: [Reflex](https://github.com/reflex-dev/reflex), [NiceGUI](https://github.com/zauberzeug/nicegui/), [ReactPy](https://github.com/reactive-python/reactpy), and [FastUI](https://github.com/pydantic/FastUI).

{htmy-0.3.4 → htmy-0.3.6}/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-0.3.4 → htmy-0.3.6}/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-0.3.4 → htmy-0.3.6}/htmy/renderer.py

@@ -5,7 +5,7 @@ from collections import ChainMap
 from collections.abc import Awaitable, Callable, Iterable
 
 from .core import ErrorBoundary, xml_format_string
-from .typing import Component, ComponentType, Context, ContextProvider, HTMYComponentType
+from .typing import Component, ComponentType, Context
 
 
 class HTMY:
@@ -82,15 +82,19 @@ class HTMY:
         Returns:
             The rendered string.
         """
-        child_context = context
-        if isinstance(component, ContextProvider):
-            extra_context = component.htmy_context()
-            if isinstance(extra_context, Awaitable):
-                extra_context = await extra_context
+        if isinstance(component, str):
+            return self._string_formatter(component)
+        else:
+            child_context: Context = context
+            if hasattr(component, "htmy_context"):  # isinstance() is too expensive.
+                extra_context: Context | Awaitable[Context] = component.htmy_context()
+                if isinstance(extra_context, Awaitable):
+                    extra_context = await extra_context
 
-            child_context = ChainMap(extra_context, context)
+                if len(extra_context):
+                    # Context must not be mutated, so we can ignore that ChainMap expext mutable mappings.
+                    child_context = ChainMap(extra_context, context)  # type: ignore[arg-type]
 
-        if isinstance(component, HTMYComponentType):
             try:
                 children = component.htmy(child_context)
                 if isinstance(children, Awaitable):
@@ -102,7 +106,3 @@ class HTMY:
                     return await self._render_one(component.fallback_component(e), context)
 
                 raise e
-        elif isinstance(component, str):
-            return self._string_formatter(component)
-        else:
-            raise TypeError("Unknown component type.")

{htmy-0.3.4 → htmy-0.3.6}/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.4 → htmy-0.3.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "htmy"
-version = "0.3.4"
+version = "0.3.6"
 description = "Async, pure-Python rendering engine."
 authors = ["Peter Volf <do.volfp@gmail.com>"]
 license = "MIT"