Skip to content

Various template string utilities, with backports for older versions of Python.

License

Notifications You must be signed in to change notification settings

ilotoki0804/tstr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tstr - PEP 750 Template String Utilities & Backports

PyPI Version Python Version License Tests Coverage Status

tstr provides utilities for working with PEP 750 template strings, along with robust backports for older Python versions.

This library streamlines template string usage by offering practical helpers and common processing patterns. For Python versions prior to 3.14, tstr seamlessly backports template string functionality.

Installation

Install tstr via pip:

pip install tstr

Features

  • render (alias: f): Render a template to a string, mimicking f-string behavior.
  • generate_template (alias: t): Create a Template object from a string and context. This function is especially useful on Python versions that do not support template strings natively.
  • bind: Apply a function to all interpolations and join all the parts.
  • binder: Decorator to create template processors from an interpolation processor.
  • normalize / normalize_str: Apply conversion and format to value.
  • convert: Apply conversion to a value.
  • template_eq: Check if two templates are equivalent.
  • interpolation_replace: Create a new Interpolation by selectively replacing attributes of an existing one.

This library also provides several useful extensions where template strings can be effectively utilized. These extensions are available in the tstr.ext submodule, and below is a list with brief descriptions:

  • ext.render_html: Render templates with HTML escaping.
  • ext.execute: Safely execute SQL with templates, preventing SQL injection attacks.
  • ext.logging: Enable Python's logging module to accept template strings.

For more details, see the API documentation.

Compatibility

tstr automatically detects native template string support (PEP 750):

  • Python 3.14+: Uses native template strings.
  • Python 3.10–3.13: Uses a compatible backport.

Use the TEMPLATE_STRING_SUPPORTED constant to check if template strings are natively supported in your Python version.

For details on how the compatible backport of template string works and what similarities and differences it has with native template strings, see the compatible template strings documentation.

Contributing

This project welcomes contributions of all kinds from anyone willing to help improve it! Whether you're fixing a typo in documentation, reporting a bug, proposing a new feature, or implementing code changes - every contribution matters and is highly appreciated.

Releases

  • 0.2.0: Rename html_render to render_html, add _logging module, fix various bugs and improve documentation
  • 0.1.1.post1: Initial release

License

This library is licensed under the Apache License 2.0.

About

Various template string utilities, with backports for older versions of Python.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages