tstr 0.1.0__py3-none-any.whl

tstr/__init__.py

@@ -0,0 +1,32 @@
+from ._template import TEMPLATE_STRING_SUPPORTED, Conversion, Interpolation, Template
+from ._utils import (
+    TemplateGenerationError,
+    bind,
+    binder,
+    convert,
+    converter,
+    f,
+    generate_template,
+    normalize,
+    normalize_str,
+    render,
+    t,
+)
+
+__all__ = [
+    "bind",
+    "binder",
+    "f",
+    "render",
+    "convert",
+    "converter",
+    "normalize",
+    "normalize_str",
+    "Template",
+    "Interpolation",
+    "Conversion",
+    "generate_template",
+    "t",
+    "TemplateGenerationError",
+    "TEMPLATE_STRING_SUPPORTED",
+]

tstr/_compat.py

@@ -0,0 +1,141 @@
+from __future__ import annotations
+
+import typing
+from itertools import zip_longest
+
+
+class Template:
+    __strings: tuple[str, ...]
+    __interpolations: tuple[Interpolation, ...]
+
+    @property
+    def strings(self) -> tuple[str, ...]:
+        """
+        A non-empty tuple of the string parts of the template,
+        with N+1 items, where N is the number of interpolations
+        in the template.
+        """
+        return self.__strings
+
+    @property
+    def interpolations(self) -> tuple[Interpolation, ...]:
+        """
+        A tuple of the interpolation parts of the template.
+        This will be an empty tuple if there are no interpolations.
+        """
+        return self.__interpolations
+
+    def __init__(self, *args: str | Interpolation) -> None:
+        """
+        Create a new Template instance.
+
+        Arguments can be provided in any order.
+        """
+        str_last_added = False
+        strings = []
+        interpolations = []
+        for item in args:
+            if isinstance(item, str):
+                if str_last_added:
+                    strings[-1] += item
+                else:
+                    strings.append(item)
+                str_last_added = True
+            elif isinstance(item, Interpolation):
+                if not str_last_added:
+                    strings.append("")
+                interpolations.append(item)
+                str_last_added = False
+            else:
+                raise TypeError(
+                    f"Template.__new__ *args need to be of type 'str' or 'Interpolation', got {type(item).__name__}"
+                )
+
+        if len(strings) == len(interpolations):
+            strings.append("")
+
+        self.__strings = tuple(strings)
+        self.__interpolations = tuple(interpolations)
+
+    @property
+    def values(self) -> tuple[object, ...]:
+        """
+        Return a tuple of the `value` attributes of each Interpolation
+        in the template.
+        This will be an empty tuple if there are no interpolations.
+        """
+        return tuple(interpolation.value for interpolation in self.interpolations)
+
+    def __iter__(self) -> typing.Iterator[str | Interpolation]:
+        """
+        Iterate over the string parts and interpolations in the template.
+
+        These may appear in any order. Empty strings will not be included.
+        """
+        for string, interpolation in zip_longest(self.strings, self.interpolations):
+            if string:
+                yield string
+            if interpolation:
+                yield interpolation
+
+    def __add__(self, other: str | Template) -> Template:
+        if isinstance(other, str):
+            return Template(*self, other)
+        elif isinstance(other, Template):
+            return Template(*self, *other)
+        else:
+            return NotImplemented
+
+    def __radd__(self, other: str | Template) -> Template:
+        if isinstance(other, str):
+            return Template(other, *self)
+        elif isinstance(other, Template):
+            return Template(*other, *self)
+        else:
+            return NotImplemented
+
+    def __repr__(self) -> str:
+        return f"Template(strings={self.strings!r}, interpolations={self.interpolations!r})"
+
+
+class Interpolation:
+    __match_args__ = ("value", "expression", "conversion", "format_spec")
+    __value: object
+    __expression: str
+    __conversion: typing.Literal["a", "r", "s"] | None
+    __format_spec: str
+
+    @property
+    def value(self) -> object:
+        return self.__value
+
+    @property
+    def expression(self) -> str:
+        return self.__expression
+
+    @property
+    def conversion(self) -> typing.Literal["a", "r", "s"] | None:
+        return self.__conversion
+
+    @property
+    def format_spec(self) -> str:
+        return self.__format_spec
+
+    def __init__(
+        self,
+        value: object,
+        expression: str,
+        conversion: typing.Literal["a", "r", "s"] | None = None,
+        format_spec: str = "",
+    ) -> None:
+        self.__value = value
+        if conversion not in (None, "a", "r", "s"):
+            raise ValueError(
+                f"Interpolation() argument 'conversion' must be one of 's', 'a' or 'r'"
+            )
+        self.__expression = expression
+        self.__conversion = conversion
+        self.__format_spec = format_spec
+
+    def __repr__(self) -> str:
+        return f"Interpolation({self.value!r}, {self.expression!r}, {self.conversion!r}, {self.format_spec!r})"

tstr/_html.py

@@ -0,0 +1,55 @@
+from html import escape
+
+from tstr import Interpolation, binder
+
+__all__ = ["html_safe"]
+
+
+@binder
+def html_safe(interpolation: Interpolation) -> str:
+    """
+    Escapes HTML special characters in interpolations for safe HTML rendering.
+
+    This function helps prevent XSS attacks by escaping any HTML special
+    characters in interpolated values. It's specifically designed for safely
+    including user-provided content in HTML templates.
+
+    Special behavior:
+        - When the 'r' conversion is used (e.g., {content!r}), the value is treated as
+          raw HTML and will NOT be escaped. This allows for intentional inclusion of
+          HTML markup when needed.
+        - Other conversion specifiers ('s', 'a') are not allowed to avoid confusion.
+
+    Args:
+        template (Template): The template to process.
+
+    Returns:
+        str: The HTML-escaped string, or unescaped if using the 'r' conversion.
+
+    Raises:
+        ValueError: If any conversion specifier other than 'r' is used.
+
+    Example:
+        ```python
+        from tstr._html import html_safe
+
+        # Unsafe user input that will be safely escaped
+        username = "<script>alert('XSS')</script>"
+        template = t"<div>Welcome, {username}!</div>"
+        result = html_safe(template)
+        assert result == "<div>Welcome, &lt;script&gt;alert(&#x27;XSS&#x27;)&lt;/script&gt;!</div>"
+
+        # Intentionally including raw HTML with the 'r' conversion
+        title_html = "<b>Important Notice</b>"
+        template = t"<h1>{title_html!r}</h1>"
+        result = html_safe(template)
+        assert result == "<h1><b>Important Notice</b></h1>"
+        ```
+    """
+    formatted = format(interpolation.value, interpolation.format_spec)
+    if interpolation.conversion == "r":
+        return formatted
+    elif interpolation.conversion:
+        raise ValueError("Conversion other than 'r' is prohibited.")
+    else:
+        return escape(formatted)

tstr/_sqlite.py

@@ -0,0 +1,37 @@
+import sqlite3
+
+from tstr import Template, normalize
+
+__all__ = ["execute"]
+
+
+def execute(cursor: sqlite3.Cursor, sql: Template) -> sqlite3.Cursor:
+    """
+    Executes SQL safely using template strings to prevent SQL injection.
+
+    ```python
+    # XXX: Using f-string (vulnerable to SQL injection):
+    cursor.execute(f"SELECT * FROM users WHERE name = '{user_input}'")
+
+    # Using template string (safe):
+    execute(cursor, t"SELECT * FROM users WHERE name = {user_input}")
+    ```
+
+    Args:
+        cursor (sqlite3.Cursor): The SQLite cursor to execute the SQL statement.
+        sql (Template): The SQL statement as a template string.
+
+    Returns:
+        sqlite3.Cursor: The cursor after executing the SQL statement.
+    """
+    assert isinstance(sql, Template), "SQL statement must be a template string."
+
+    query = []
+    params = []
+    for item in sql:
+        if isinstance(item, str):
+            query.append(item)
+        else:
+            query.append("?")
+            params.append(normalize(item))
+    return cursor.execute("".join(query), params)

tstr/_template.py

@@ -0,0 +1,15 @@
+import typing
+
+__all__ = ["Template", "Interpolation", "Conversion", "TEMPLATE_STRING_SUPPORTED"]
+
+type Conversion = typing.Literal["a", "r", "s"]
+
+try:
+    from string.templatelib import Interpolation, Template  # type: ignore
+
+    TEMPLATE_STRING_SUPPORTED = True
+except Exception:
+    # Fallback to compatible implementation if template strings are not supported
+    from ._compat import Interpolation, Template
+
+    TEMPLATE_STRING_SUPPORTED = False

tstr/_template.pyi

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import sys
+import typing
+
+__all__ = ["Template", "Interpolation", "Conversion"]
+
+type Conversion = typing.Literal["a", "r", "s"]
+
+if sys.version_info >= (3, 14):
+    TEMPLATE_STRING_SUPPORTED = True
+else:
+    TEMPLATE_STRING_SUPPORTED = False
+
+@typing.runtime_checkable
+class Template(typing.Protocol):
+    @property
+    def strings(self) -> tuple[str, ...]:
+        """
+        A non-empty tuple of the string parts of the template,
+        with N+1 items, where N is the number of interpolations
+        in the template.
+        """
+    @property
+    def interpolations(self) -> tuple[Interpolation, ...]:
+        """
+        A tuple of the interpolation parts of the template.
+        This will be an empty tuple if there are no interpolations.
+        """
+    def __new__(cls, *args: str | Interpolation):
+        """
+        Create a new Template instance.
+
+        Arguments can be provided in any order.
+        """
+    @property
+    def values(self) -> tuple[object, ...]:
+        """
+        Return a tuple of the `value` attributes of each Interpolation
+        in the template.
+        This will be an empty tuple if there are no interpolations.
+        """
+    def __iter__(self) -> typing.Iterator[str | Interpolation]:
+        """
+        Iterate over the string parts and interpolations in the template.
+
+        These may appear in any order. Empty strings will not be included.
+        """
+    def __add__(self, other: str | Template) -> Template: ...
+    def __radd__(self, other: str | Template) -> Template: ...
+
+@typing.runtime_checkable
+class Interpolation(typing.Protocol):
+    __match_args__ = ("value", "expression", "conversion", "format_spec")
+
+    @property
+    def value(self) -> object: ...
+    @property
+    def expression(self) -> str: ...
+    @property
+    def conversion(self) -> typing.Literal["a", "r", "s"] | None: ...
+    @property
+    def format_spec(self) -> str: ...
+    def __new__(
+        cls,
+        value: object,
+        expression: str,
+        conversion: typing.Literal["a", "r", "s"] | None = None,
+        format_spec: str = "",
+    ): ...

tstr/_utils.py

@@ -0,0 +1,385 @@
+import inspect
+import types
+import typing
+from string import Formatter
+
+from ._template import TEMPLATE_STRING_SUPPORTED, Conversion, Interpolation, Template
+
+__all__ = [
+    "bind",
+    "binder",
+    "f",
+    "render",
+    "convert",
+    "converter",
+    "normalize",
+    "normalize_str",
+    "generate_template",
+    "TemplateGenerationError",
+    "template_eq",
+]
+
+_formatter = Formatter()
+
+
+class TemplateGenerationError(Exception):
+    """
+    Exception raised when a template cannot be generated.
+    """
+
+
+def converter[T](conversion: Conversion) -> typing.Callable[[T], T | str]:
+    """
+    Returns a callable that converts a value based on conversion specifiers.
+
+    This function maps conversion specifiers to their corresponding conversion
+    functions: "a" returns `ascii`, "r" returns `repr`, and "s" returns `str`.
+
+    Args:
+        conversion (Conversion): The conversion specifier.
+
+    Returns:
+        Callable[[T], T | str]: A function that performs the specified conversion.
+
+    Raises:
+        ValueError: If the conversion specifier is not one of the allowed values.
+    """
+    if conversion == "a":
+        return ascii
+    elif conversion == "r":
+        return repr
+    elif conversion == "s":
+        return str
+    else:
+        raise ValueError(f"Invalid conversion: {conversion}")
+
+
+def convert[T](
+    value: T,
+    conversion: Conversion | None,
+) -> T | str:
+    """
+    Applies a conversion to a value, similar to how f-strings handle conversions.
+
+    Args:
+        value (T): The value to convert, typically from an Interpolation.value.
+        conversion (Conversion | None): The conversion specifier ('a', 'r', or 's'), or None.
+
+    Returns:
+        T | str: The value converted according to the specified conversion; if 'conversion' is None, returns the original value unchanged.
+    """
+    return converter(conversion)(value) if conversion else value
+
+
+def normalize_str(interpolation: Interpolation) -> str:
+    """
+    Normalizes a PEP 750 Interpolation to a formatted string.
+
+    This processes an Interpolation object similarly to how f-strings process
+    interpolated expressions: it applies any conversion and format specification.
+    Unlike normalize(), this always returns a string.
+
+    Args:
+        interpolation (Interpolation): The interpolation to normalize.
+
+    Returns:
+        str: The formatted string representation of the interpolation.
+    """
+    converted = convert(interpolation.value, interpolation.conversion)
+    return format(converted, interpolation.format_spec)
+
+
+def normalize(interpolation: Interpolation) -> str | object:
+    """
+    Normalizes a PEP 750 Interpolation, preserving its type when possible.
+
+    This is a more flexible version of normalize_str() that preserves the original
+    value's type when no conversion is specified.
+
+    If neither a conversion nor a format spec is specified, the original value
+    is returned without any modification, ensuring that the value's type is preserved.
+
+    Args:
+        interpolation (Interpolation): The interpolation to normalize.
+
+    Returns:
+        str | object: The normalized string if conversion or format spec is specified,
+                      otherwise the original value.
+    """
+    if interpolation.conversion or interpolation.format_spec:
+        return normalize_str(interpolation)
+    else:
+        return interpolation.value
+
+
+@typing.overload
+def bind(
+    template: Template,
+    binder: typing.Callable[[Interpolation], str],
+    *,
+    joiner: typing.Callable[[typing.Iterable[str]], str] = ...,
+) -> str: ...
+@typing.overload
+def bind[U](
+    template: Template,
+    binder: typing.Callable[[Interpolation], str],
+    *,
+    joiner: typing.Callable[[typing.Iterable[str]], U],
+) -> U: ...
+@typing.overload
+def bind[T, U](
+    template: Template,
+    binder: typing.Callable[[Interpolation], T],
+    *,
+    joiner: typing.Callable[[typing.Iterable[T | str]], U],
+) -> U: ...
+def bind(template: Template, binder, *, joiner="".join) -> typing.Any:
+    """
+    Binds a template by processing its interpolations using a binder function
+    and combining the results with a joiner function.
+
+    This function processes each `Interpolation` in the given template using the
+    provided `binder` function, and then combines the processed parts using the
+    `joiner` function. By default, the `joiner` concatenates the parts into a single
+    string.
+
+    Args:
+        template (Template): A template to process.
+        binder: A callable that transforms each Interpolation.
+        joiner: A callable to join the processed template parts.
+    """
+    return joiner(_bind_iterator(template, binder))
+
+
+@typing.overload
+def binder(
+    binder: typing.Callable[[Interpolation], str],
+    joiner: typing.Callable[[typing.Iterable[str]], str] = ...,
+) -> typing.Callable[[Template], str]: ...
+@typing.overload
+def binder[U](
+    binder: typing.Callable[[Interpolation], str],
+    joiner: typing.Callable[[typing.Iterable[str]], U],
+) -> typing.Callable[[Template], U]: ...
+@typing.overload
+def binder[T, U](
+    binder: typing.Callable[[Interpolation], T],
+    joiner: typing.Callable[[typing.Iterable[T | str]], U],
+) -> typing.Callable[[Template], U]: ...
+def binder(binder, joiner="".join) -> typing.Any:
+    """
+    Creates a reusable template processor function from a binder function.
+
+    This is a higher-order function that creates specialized template processors,
+    as described in the "Creating Reusable Binders" section of PEP 750.
+    Use this when you want to process multiple templates with the same transformation.
+
+    Additionally, this can be used as a decorator to create reusable template
+    processors in a concise and readable way.
+
+    Args:
+        binder: A function that transforms Interpolation objects.
+        joiner: A function to join the processed template parts. Defaults to "".join.
+
+    Returns:
+        Callable[[Template], Any]: A function that processes templates using the given binder.
+
+    Example:
+        ```python
+        @binder
+        def html_safe(interpolation: Interpolation) -> str:
+            # Example binder that escapes HTML in interpolations
+            return escape(normalize_str(interpolation))
+
+        username = "<script>alert('XSS')</script>"
+        template = t"Hello {username}!"
+        result = html_safe(template)
+        assert result == "Hello &lt;script&gt;alert(&#x27;XSS&#x27;)&lt;/script&gt;!"
+        ```
+    """
+    return lambda template: bind(template, binder, joiner=joiner)
+
+
+f = render = binder(normalize_str)
+"""
+Renders a template as a string, just like f-strings.
+
+Args:
+    template (Template): The template to render.
+
+Returns:
+    str: The rendered string.
+"""
+
+
+def template_eq(
+    template1: Template,
+    template2: Template,
+    /,
+    *,
+    compare_value: bool = True,
+    compare_expr: bool = True,
+) -> bool:
+    """
+    Compares two Template objects for equivalence.
+
+    This function checks whether two Template instances are equivalent by comparing
+    their string and interpolation parts.
+
+    Args:
+        template1 (Template): The first template to compare.
+        template2 (Template): The second template to compare.
+        compare_value (bool, optional): If False, the 'value' attribute of each interpolation is not compared. Defaults to True.
+        compare_expr (bool, optional): If False, the 'expression' attribute of each interpolation is not compared. Defaults to True.
+
+    Returns:
+        bool: True if the templates are considered equivalent based on the specified criteria, False otherwise.
+
+    Example:
+        ```python
+        name = "world"
+        template1 = t"Hello {name}!"
+        template2 = t"Hello {name}!"
+        assert template_eq(template1, template2)
+
+        # Compare structure but not values
+        name1 = "world"
+        name2 = "universe"
+        template1 = t"Hello {name1}!"
+        template2 = t"Hello {name2}!"
+        assert template_eq(template1, template2, compare_value=False)
+        assert not template_eq(template1, template2, compare_value=True)
+        ```
+    """
+    # Comparing strings also guarantees that the number of interpolations is equal.
+    if template1.strings != template2.strings:
+        return False
+    for i1, i2 in zip(template1.interpolations, template2.interpolations, strict=True):
+        if (
+            i1.conversion != i2.conversion
+            or i1.format_spec != i2.format_spec
+            or compare_expr and i1.expression != i2.expression
+            or compare_value and i1.value != i2.value
+        ):
+            return False
+    return True
+
+
+def _bind_iterator(template: Template, binder):
+    for item in template:
+        if isinstance(item, str):
+            yield item
+        else:
+            yield binder(item)
+
+
+def generate_template(
+    string: typing.LiteralString,
+    context: typing.Mapping[str, object] | None = None,
+    *,
+    globals: dict | None = None,
+    use_eval: bool | None = None,
+) -> Template:
+    """
+    Constructs a Template object from a string and a context.
+
+    This function provides an alternative to t-string syntax, especially useful for
+    older Python versions that don't support t-strings. It allows you to create
+    Template objects dynamically at runtime by parsing a string, evaluating expressions
+    found in the string against the provided context, and building a Template object.
+
+    Note: This is less safe than using the t-string syntax directly, as
+    expressions are evaluated at runtime. If an expression is not a simple
+    variable name in the context, it attempts to evaluate the expression
+    using eval by default (configurable with use_eval).
+
+    Args:
+        string (str): A string containing template to be parsed.
+        context (dict): A mapping of variable names to values that
+            will be used to evaluate expressions in the string. This parameter
+            functions similarly to the locals parameter in Python's eval function.
+        globals (dict, optional): Global variables to use for expression evaluation.
+        use_eval (bool, optional): If True, expressions that aren't simple variable names
+            will be evaluated using Python's eval function. If False, expressions must be
+            simple variable names in the context dictionary. Defaults to False if context
+            is provided, otherwise defaults to True.
+
+    Returns:
+        Template: A Template object constructed from the parsed string.
+
+    Raises:
+        TemplateGenerationError: If use_eval=False and a variable cannot be found in the context.
+
+    Example:
+        ```python
+        name = "world"
+        template = generate_template("Hello {name}!")
+        assert f(template) == "Hello world!"
+
+        # With explicit context
+        context = {"name": "universe"}
+        template = generate_template("Hello {name}!", context)
+        assert f(template) == "Hello universe!"
+        ```
+    """
+    if context is None:
+        if use_eval is None:
+            use_eval = False
+        if (frame := inspect.currentframe()) and (parent_frame := frame.f_back):
+            vars = parent_frame.f_locals
+        else:
+            vars = {}
+    else:
+        if use_eval is None:
+            use_eval = False
+        vars = context
+
+    parts = []
+    for value, expr, format_spec, conv in _formatter.parse(string):
+        parts.append(value)
+        if expr is not None:
+            try:
+                value = vars[expr]
+            except Exception:
+                if use_eval:
+                    value = eval(expr, globals=globals, locals=context)
+                else:
+                    raise TemplateGenerationError(f"'{expr}' is not defined or expression.")
+            parts.append(Interpolation(value, expr, conv, format_spec))  # type: ignore
+    return Template(*parts)  # type: ignore
+
+
+class _FrameVariables:
+    """
+    A class for accessing variables from the current frame and its parent frames (ancestors).
+
+    This class allows retrieving both local and non-local variables by traversing up the stack frame hierarchy,
+    enabling access to variables that are defined in parent scopes.
+    """
+
+    def __init__(self, frame: types.FrameType) -> None:
+        self._first_frame = frame
+        self._current_frame = frame
+        self._variables = frame.f_locals
+        self._reach_end = False
+
+    def __getitem__(self, key: str) -> object:
+        try:
+            return self._variables[key]
+        except KeyError:
+            if self._reach_end:
+                raise
+
+        self._retrieve_parent_frame()
+        return self[key]
+
+    def _retrieve_parent_frame(self) -> None:
+        parent_frame = self._current_frame.f_back
+        if parent_frame is None:
+            self._reach_end = True
+            return
+        self._current_frame = parent_frame
+        self._variables.update(parent_frame.f_locals)
+
+
+t = generate_template

tstr-0.1.0.dist-info/METADATA

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: tstr
+Version: 0.1.0
+Summary: Template string utilities and backports
+Project-URL: Repository, https://github.com/ilotoki0804/tstr
+Author-email: ilotoki0804 <ilotoki0804@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: backport,string,template,utility
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# tstr
+
+`tstr` is a Python library that provides convenient utility functions for working with [PEP 750 template strings](https://peps.python.org/pep-0750/). While template strings (`t"..."`) are powerful on their own, `tstr` makes them even easier to use by providing common processing patterns and utilities.
+
+For Python versions older than 3.14, `tstr` includes a backport implementation allowing you to use template strings functionality in earlier Python versions.
+
+## Installation
+
+```bash
+pip install tstr
+```
+
+## Requirements
+
+- Python 3.14+ (template strings were introduced in Python 3.14 via PEP 750)
+
+## Quick Start
+
+```python
+from tstr import f
+
+# Use template strings
+name = "world"
+template = t"Hello, {name}!"
+
+# Convert to a string (just like f-strings)
+result = f(template)  # "Hello, world!"
+```
+
+## Core Functions
+
+### Working with Template Strings
+
+- **`f(template)` / `evaluate(template)`**: Convert a template to a string (like f-strings)
+- **`normalize(interpolation)`**: Process an interpolation to get its value or string representation
+- **`normalize_str(interpolation)`**: Convert an interpolation to a formatted string
+
+### Template Processing
+
+- **`bind(template, binder, *, joiner="".join)`**: Apply a function to each interpolation in a template
+- **`binder(function, joiner="".join)`**: Create a reusable template processor function
+- **`converter(conversion)`**: Get a conversion function (ascii, repr, str) for a conversion specifier
+- **`convert(value, conversion)`**: Apply a conversion to a value
+
+## Examples
+
+### Basic Usage: Template to String
+
+```python
+from tstr import f, evaluate
+
+name = "world"
+template = t"Hello, {name}!"
+
+# Both functions do the same thing
+result1 = f(template)        # "Hello, world!"
+result2 = evaluate(template) # "Hello, world!"
+```
+
+### Creating Custom Template Processors
+
+```python
+from tstr import bind, normalize_str
+
+def html_escape(text):
+    return text.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
+
+def safe_html(template):
+    # Apply HTML escaping to each interpolation
+    return bind(template, lambda i: html_escape(normalize_str(i)))
+
+user_content = "<script>alert('XSS attack')</script>"
+template = t"<div>{user_content}</div>"
+safe_output = safe_html(template)
+# "<div>&lt;script&gt;alert('XSS attack')&lt;/script&gt;</div>"
+```
+
+### Using Binders for Reusable Processors
+
+```python
+from tstr import binder, normalize_str
+
+# Create a custom template processor
+uppercase = binder(lambda i: normalize_str(i).upper())
+
+# Use it on multiple templates
+name = "world"
+place = "Python"
+template1 = t"Hello, {name}!"
+template2 = t"Welcome to {place}!"
+
+result1 = uppercase(template1)  # "Hello, WORLD!"
+result2 = uppercase(template2)  # "Welcome to PYTHON!"
+```
+
+### Advanced Template Comparison
+
+```python
+from tstr import template_equivalent
+
+name = "World"
+template1 = t"Hello {name}"
+template2 = t"Hello {name}"
+
+# Compare templates with full equality check
+assert template_equivalent(template1, template2)
+
+# Compare only structure, not values
+template3 = t"Hello {name}"
+name = "Python"
+template4 = t"Hello {name}" 
+assert template_equivalent(template3, template4, compare_value=False)
+```
+
+## Why Use Template Strings?
+
+Template strings allow you to work with both the literal string parts and interpolated values before they're combined. This enables:
+
+1. **Security**: Sanitize user input before rendering (prevent XSS, SQL injection)
+2. **Custom formatting**: Format values based on their types or context
+3. **Domain-specific languages**: Build HTML, SQL, or other languages safely
+4. **Structural analysis**: Examine template structure for validation or optimization
+
+## Documentation
+
+For more detailed documentation, see the [API Reference](https://tstr.readthedocs.io/).
+
+## License
+
+Apache License 2.0

tstr-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+tstr/__init__.py,sha256=a_xcHwtQBclzWZo2hn2tAKiuXwaOXdUDCn6Boyn3hU4,559
+tstr/_compat.py,sha256=Gizkr2G1y-60nqbdoBrRnvYxvUx3U5eGmKm9KoKZhcY,4446
+tstr/_html.py,sha256=iHuw6EqUvJwkFJJzSmApvOlA8S1_kIQ4Y1VhFqAs71A,1936
+tstr/_sqlite.py,sha256=9gE6QOp5-A4MB02YK9lrA302IktpCXDKcvT6cMBlHiI,1071
+tstr/_template.py,sha256=oaaF7gIXFBfArc89VzUOO5cmaQs51DVovHNT1xq7jwc,454
+tstr/_template.pyi,sha256=HraiYGXxfPwgryReRO-54KaJ14_vkrpxTU0Y2qe6qoA,2129
+tstr/_utils.py,sha256=eBu9OSEp_fjnL3ABjT0THPx4-g2u7CKtlieqwKkpSLw,12901
+tstr-0.1.0.dist-info/METADATA,sha256=_zAD_oErEBmLMU0jeNWegEBcSXorLkzO_Ps8SF-oE0g,4394
+tstr-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+tstr-0.1.0.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+tstr-0.1.0.dist-info/RECORD,,

tstr-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

tstr-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.