parthtamu/rag-code-assistant
0
1<!DOCTYPE html>2 3<html lang="en" data-content_root="../">4 <head>5 <meta charset="utf-8" />6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />7<meta property="og:title" content="string.templatelib — Support for template string literals" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/string.templatelib.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="Source code: Lib/string/templatelib.py Template strings: Template strings are a mechanism for custom string processing. They have the full flexibility of Python’s f-strings, but return a Template i..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_string.templatelib_68927d59.png" />15<meta property="og:image:alt" content="Source code: Lib/string/templatelib.py Template strings: Template strings are a mechanism for custom string processing. They have the full flexibility of Python’s f-strings, but return a Template i..." />16<meta name="description" content="Source code: Lib/string/templatelib.py Template strings: Template strings are a mechanism for custom string processing. They have the full flexibility of Python’s f-strings, but return a Template i..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>string.templatelib — Support for template string literals — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="re — Regular expression operations" href="re.html" />43 <link rel="prev" title="string — Common string operations" href="string.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/string.templatelib.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h3><a href="../contents.html">Table of Contents</a></h3>106 <ul>107<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">string.templatelib</span></code> — Support for template string literals</a><ul>108<li><a class="reference internal" href="#template-strings">Template strings</a></li>109<li><a class="reference internal" href="#types">Types</a></li>110<li><a class="reference internal" href="#helper-functions">Helper functions</a></li>111</ul>112</li>113</ul>114 115 </div>116 <div>117 <h4>Previous topic</h4>118 <p class="topless"><a href="string.html"119 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">string</span></code> — Common string operations</a></p>120 </div>121 <div>122 <h4>Next topic</h4>123 <p class="topless"><a href="re.html"124 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code> — Regular expression operations</a></p>125 </div>126 <script>127 document.addEventListener('DOMContentLoaded', () => {128 const title = document.querySelector('meta[property="og:title"]').content;129 const elements = document.querySelectorAll('.improvepage');130 const pageurl = window.location.href.split('?')[0];131 elements.forEach(element => {132 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));133 url.searchParams.set('pagetitle', title);134 url.searchParams.set('pageurl', pageurl);135 url.searchParams.set('pagesource', "library/string.templatelib.rst");136 element.href = url.toString();137 });138 });139 </script>140 <div role="note" aria-label="source link">141 <h3>This page</h3>142 <ul class="this-page-menu">143 <li><a href="../bugs.html">Report a bug</a></li>144 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>145 <li>146 <a href="https://github.com/python/cpython/blob/main/Doc/library/string.templatelib.rst?plain=1"147 rel="nofollow">Show source148 </a>149 </li>150 151 </ul>152 </div>153 </nav>154 </div>155</div>156 157 158 <div class="related" role="navigation" aria-label="Related">159 <h3>Navigation</h3>160 <ul>161 <li class="right" style="margin-right: 10px">162 <a href="../genindex.html" title="General Index"163 accesskey="I">index</a></li>164 <li class="right" >165 <a href="../py-modindex.html" title="Python Module Index"166 >modules</a> |</li>167 <li class="right" >168 <a href="re.html" title="re — Regular expression operations"169 accesskey="N">next</a> |</li>170 <li class="right" >171 <a href="string.html" title="string — Common string operations"172 accesskey="P">previous</a> |</li>173 174 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>175 <li><a href="https://www.python.org/">Python</a> »</li>176 <li class="switchers">177 <div class="language_switcher_placeholder"></div>178 <div class="version_switcher_placeholder"></div>179 </li>180 <li>181 182 </li>183 <li id="cpython-language-and-version">184 <a href="../index.html">3.15.0a6 Documentation</a> »185 </li>186 187 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>188 <li class="nav-item nav-item-2"><a href="text.html" accesskey="U">Text Processing Services</a> »</li>189 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">string.templatelib</span></code> — Support for template string literals</a></li>190 <li class="right">191 192 193 <div class="inline-search" role="search">194 <form class="inline-search" action="../search.html" method="get">195 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">196 <input type="submit" value="Go">197 </form>198 </div>199 |200 </li>201 <li class="right">202<label class="theme-selector-label">203 Theme204 <select class="theme-selector" oninput="activateTheme(this.value)">205 <option value="auto" selected>Auto</option>206 <option value="light">Light</option>207 <option value="dark">Dark</option>208 </select>209</label> |</li>210 211 </ul>212 </div> 213 214 <div class="document">215 <div class="documentwrapper">216 <div class="bodywrapper">217 <div class="body" role="main">218 219 <section id="module-string.templatelib">220<span id="string-templatelib-support-for-template-string-literals"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">string.templatelib</span></code> — Support for template string literals<a class="headerlink" href="#module-string.templatelib" title="Link to this heading">¶</a></h1>221<p><strong>Source code:</strong> <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/main/Lib/string/templatelib.py">Lib/string/templatelib.py</a></p>222<hr class="docutils" />223<div class="admonition seealso">224<p class="admonition-title">See also</p>225<ul class="simple">226<li><p><a class="reference internal" href="../reference/lexical_analysis.html#f-strings"><span class="std std-ref">Format strings</span></a></p></li>227<li><p><a class="reference internal" href="../reference/lexical_analysis.html#t-strings"><span class="std std-ref">Template string literal (t-string) syntax</span></a></p></li>228<li><p><span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0750/"><strong>PEP 750</strong></a></p></li>229</ul>230</div>231<section id="template-strings">232<span id="id1"></span><h2>Template strings<a class="headerlink" href="#template-strings" title="Link to this heading">¶</a></h2>233<div class="versionadded">234<p><span class="versionmodified added">Added in version 3.14.</span></p>235</div>236<p>Template strings are a mechanism for custom string processing.237They have the full flexibility of Python’s <a class="reference internal" href="../reference/lexical_analysis.html#f-strings"><span class="std std-ref">f-strings</span></a>,238but return a <a class="reference internal" href="#string.templatelib.Template" title="string.templatelib.Template"><code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code></a> instance that gives access239to the static and interpolated (in curly brackets) parts of a string240<em>before</em> they are combined.</p>241<p>To write a t-string, use a <code class="docutils literal notranslate"><span class="pre">'t'</span></code> prefix instead of an <code class="docutils literal notranslate"><span class="pre">'f'</span></code>, like so:</p>242<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pi</span> <span class="o">=</span> <span class="mf">3.14</span>243<span class="gp">>>> </span><span class="n">t</span><span class="s1">'t-strings are new in Python </span><span class="si">{pi!s}</span><span class="s1">!'</span>244<span class="go">Template(</span>245<span class="go"> strings=('t-strings are new in Python ', '!'),</span>246<span class="go"> interpolations=(Interpolation(3.14, 'pi', 's', ''),)</span>247<span class="go">)</span>248</pre></div>249</div>250</section>251<section id="types">252<h2>Types<a class="headerlink" href="#types" title="Link to this heading">¶</a></h2>253<dl class="py class">254<dt class="sig sig-object py" id="string.templatelib.Template">255<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">string.templatelib.</span></span><span class="sig-name descname"><span class="pre">Template</span></span><a class="headerlink" href="#string.templatelib.Template" title="Link to this definition">¶</a></dt>256<dd><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> class describes the contents of a template string.257It is immutable, meaning that attributes of a template cannot be reassigned.</p>258<p>The most common way to create a <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> instance is to use the259<a class="reference internal" href="../reference/lexical_analysis.html#t-strings"><span class="std std-ref">template string literal syntax</span></a>.260This syntax is identical to that of <a class="reference internal" href="../reference/lexical_analysis.html#f-strings"><span class="std std-ref">f-strings</span></a>,261except that it uses a <code class="docutils literal notranslate"><span class="pre">t</span></code> prefix in place of an <code class="docutils literal notranslate"><span class="pre">f</span></code>:</p>262<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Red Leicester'</span>263<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s2">"We're fresh out of </span><span class="si">{cheese}</span><span class="s2">, sir."</span>264<span class="gp">>>> </span><span class="nb">type</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>265<span class="go"><class 'string.templatelib.Template'></span>266</pre></div>267</div>268<p>Templates are stored as sequences of literal <a class="reference internal" href="#string.templatelib.Template.strings" title="string.templatelib.Template.strings"><code class="xref py py-attr docutils literal notranslate"><span class="pre">strings</span></code></a>269and dynamic <a class="reference internal" href="#string.templatelib.Template.interpolations" title="string.templatelib.Template.interpolations"><code class="xref py py-attr docutils literal notranslate"><span class="pre">interpolations</span></code></a>.270A <a class="reference internal" href="#string.templatelib.Template.values" title="string.templatelib.Template.values"><code class="xref py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> attribute holds the values of the interpolations:</p>271<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>272<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'Ah! We do have </span><span class="si">{cheese}</span><span class="s1">.'</span>273<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">strings</span>274<span class="go">('Ah! We do have ', '.')</span>275<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">interpolations</span>276<span class="go">(Interpolation('Camembert', ...),)</span>277<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">values</span>278<span class="go">('Camembert',)</span>279</pre></div>280</div>281<p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">strings</span></code> tuple has one more element than <code class="xref py py-attr docutils literal notranslate"><span class="pre">interpolations</span></code>282and <code class="xref py py-attr docutils literal notranslate"><span class="pre">values</span></code>; the interpolations “belong” between the strings.283This may be easier to understand when tuples are aligned</p>284<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template</span><span class="o">.</span><span class="n">strings</span><span class="p">:</span> <span class="p">(</span><span class="s1">'Ah! We do have '</span><span class="p">,</span> <span class="s1">'.'</span><span class="p">)</span>285<span class="n">template</span><span class="o">.</span><span class="n">values</span><span class="p">:</span> <span class="p">(</span> <span class="s1">'Camembert'</span><span class="p">,</span> <span class="p">)</span>286</pre></div>287</div>288<p class="rubric">Attributes</p>289<dl class="py attribute">290<dt class="sig sig-object py" id="string.templatelib.Template.strings">291<span class="sig-name descname"><span class="pre">strings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="stdtypes.html#tuple" title="tuple"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="stdtypes.html#str" title="str"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#string.templatelib.Template.strings" title="Link to this definition">¶</a></dt>292<dd><p>A <a class="reference internal" href="stdtypes.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> of the static strings in the template.</p>293<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>294<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'Ah! We do have </span><span class="si">{cheese}</span><span class="s1">.'</span>295<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">strings</span>296<span class="go">('Ah! We do have ', '.')</span>297</pre></div>298</div>299<p>Empty strings <em>are</em> included in the tuple:</p>300<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">response</span> <span class="o">=</span> <span class="s1">'We do have '</span>301<span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>302<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'Ah! </span><span class="si">{response}{cheese}</span><span class="s1">.'</span>303<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">strings</span>304<span class="go">('Ah! ', '', '.')</span>305</pre></div>306</div>307<p>The <code class="docutils literal notranslate"><span class="pre">strings</span></code> tuple is never empty, and always contains one more308string than the <code class="docutils literal notranslate"><span class="pre">interpolations</span></code> and <code class="docutils literal notranslate"><span class="pre">values</span></code> tuples:</p>309<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">t</span><span class="s1">''</span><span class="o">.</span><span class="n">strings</span>310<span class="go">('',)</span>311<span class="gp">>>> </span><span class="n">t</span><span class="s1">''</span><span class="o">.</span><span class="n">values</span>312<span class="go">()</span>313<span class="gp">>>> </span><span class="n">t</span><span class="s1">'{'</span><span class="n">cheese</span><span class="s1">'}'</span><span class="o">.</span><span class="n">strings</span>314<span class="go">('', '')</span>315<span class="gp">>>> </span><span class="n">t</span><span class="s1">'{'</span><span class="n">cheese</span><span class="s1">'}'</span><span class="o">.</span><span class="n">values</span>316<span class="go">('cheese',)</span>317</pre></div>318</div>319</dd></dl>320 321<dl class="py attribute">322<dt class="sig sig-object py" id="string.templatelib.Template.interpolations">323<span class="sig-name descname"><span class="pre">interpolations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="stdtypes.html#tuple" title="tuple"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#string.templatelib.Interpolation" title="string.templatelib.Interpolation"><span class="pre">Interpolation</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#string.templatelib.Template.interpolations" title="Link to this definition">¶</a></dt>324<dd><p>A <a class="reference internal" href="stdtypes.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> of the interpolations in the template.</p>325<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>326<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'Ah! We do have </span><span class="si">{cheese}</span><span class="s1">.'</span>327<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">interpolations</span>328<span class="go">(Interpolation('Camembert', 'cheese', None, ''),)</span>329</pre></div>330</div>331<p>The <code class="docutils literal notranslate"><span class="pre">interpolations</span></code> tuple may be empty and always contains one fewer332values than the <code class="docutils literal notranslate"><span class="pre">strings</span></code> tuple:</p>333<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">t</span><span class="s1">'Red Leicester'</span><span class="o">.</span><span class="n">interpolations</span>334<span class="go">()</span>335</pre></div>336</div>337</dd></dl>338 339<dl class="py attribute">340<dt class="sig sig-object py" id="string.templatelib.Template.values">341<span class="sig-name descname"><span class="pre">values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="stdtypes.html#tuple" title="tuple"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="functions.html#object" title="object"><span class="pre">object</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#string.templatelib.Template.values" title="Link to this definition">¶</a></dt>342<dd><p>A tuple of all interpolated values in the template.</p>343<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>344<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'Ah! We do have </span><span class="si">{cheese}</span><span class="s1">.'</span>345<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">values</span>346<span class="go">('Camembert',)</span>347</pre></div>348</div>349<p>The <code class="docutils literal notranslate"><span class="pre">values</span></code> tuple always has the same length as the350<code class="docutils literal notranslate"><span class="pre">interpolations</span></code> tuple. It is always equivalent to351<code class="docutils literal notranslate"><span class="pre">tuple(i.value</span> <span class="pre">for</span> <span class="pre">i</span> <span class="pre">in</span> <span class="pre">template.interpolations)</span></code>.</p>352</dd></dl>353 354<p class="rubric">Methods</p>355<dl class="py method">356<dt class="sig sig-object py" id="string.templatelib.Template.__new__">357<span class="sig-name descname"><span class="pre">__new__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="stdtypes.html#str" title="str"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#string.templatelib.Interpolation" title="string.templatelib.Interpolation"><span class="pre">Interpolation</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#string.templatelib.Template.__new__" title="Link to this definition">¶</a></dt>358<dd><p>While literal syntax is the most common way to create a <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code>,359it is also possible to create them directly using the constructor:</p>360<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">string.templatelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Interpolation</span><span class="p">,</span> <span class="n">Template</span>361<span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>362<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span>363<span class="gp">... </span> <span class="s1">'Ah! We do have '</span><span class="p">,</span> <span class="n">Interpolation</span><span class="p">(</span><span class="n">cheese</span><span class="p">,</span> <span class="s1">'cheese'</span><span class="p">),</span> <span class="s1">'.'</span>364<span class="gp">... </span><span class="p">)</span>365<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>366<span class="go">['Ah! We do have ', Interpolation('Camembert', 'cheese', None, ''), '.']</span>367</pre></div>368</div>369<p>If multiple strings are passed consecutively, they will be concatenated370into a single value in the <a class="reference internal" href="#string.templatelib.Template.strings" title="string.templatelib.Template.strings"><code class="xref py py-attr docutils literal notranslate"><span class="pre">strings</span></code></a> attribute. For example,371the following code creates a <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> with a single final string:</p>372<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">string.templatelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Template</span>373<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span><span class="s1">'Ah! We do have '</span><span class="p">,</span> <span class="s1">'Camembert'</span><span class="p">,</span> <span class="s1">'.'</span><span class="p">)</span>374<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">strings</span>375<span class="go">('Ah! We do have Camembert.',)</span>376</pre></div>377</div>378<p>If multiple interpolations are passed consecutively, they will be treated379as separate interpolations and an empty string will be inserted between them.380For example, the following code creates a template with empty placeholders381in the <a class="reference internal" href="#string.templatelib.Template.strings" title="string.templatelib.Template.strings"><code class="xref py py-attr docutils literal notranslate"><span class="pre">strings</span></code></a> attribute:</p>382<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">string.templatelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Interpolation</span><span class="p">,</span> <span class="n">Template</span>383<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span>384<span class="gp">... </span> <span class="n">Interpolation</span><span class="p">(</span><span class="s1">'Camembert'</span><span class="p">,</span> <span class="s1">'cheese'</span><span class="p">),</span>385<span class="gp">... </span> <span class="n">Interpolation</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="s1">'punctuation'</span><span class="p">),</span>386<span class="gp">... </span><span class="p">)</span>387<span class="gp">>>> </span><span class="n">template</span><span class="o">.</span><span class="n">strings</span>388<span class="go">('', '', '')</span>389</pre></div>390</div>391</dd></dl>392 393<dl class="describe">394<dt class="sig sig-object">395<span class="sig-name descname"><span class="pre">iter(template)</span></span></dt>396<dd><p>Iterate over the template, yielding each non-empty string and397<a class="reference internal" href="#string.templatelib.Interpolation" title="string.templatelib.Interpolation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interpolation</span></code></a> in the correct order:</p>398<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>399<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">t</span><span class="s1">'Ah! We do have </span><span class="si">{cheese}</span><span class="s1">.'</span><span class="p">)</span>400<span class="go">['Ah! We do have ', Interpolation('Camembert', 'cheese', None, ''), '.']</span>401</pre></div>402</div>403<div class="admonition caution">404<p class="admonition-title">Caution</p>405<p>Empty strings are <strong>not</strong> included in the iteration:</p>406<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">response</span> <span class="o">=</span> <span class="s1">'We do have '</span>407<span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>408<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">t</span><span class="s1">'Ah! </span><span class="si">{response}{cheese}</span><span class="s1">.'</span><span class="p">)</span>409<span class="go">['Ah! ',</span>410<span class="go"> Interpolation('We do have ', 'response', None, ''),</span>411<span class="go"> Interpolation('Camembert', 'cheese', None, ''),</span>412<span class="go"> '.']</span>413</pre></div>414</div>415</div>416</dd></dl>417 418<dl class="describe">419<dt class="sig sig-object">420<span class="sig-name descname"><span class="pre">template</span> <span class="pre">+</span> <span class="pre">other</span></span></dt>421<dt class="sig sig-object">422<span class="sig-name descname"><span class="pre">template</span> <span class="pre">+=</span> <span class="pre">other</span></span></dt>423<dd><p>Concatenate this template with another, returning a new424<code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> instance:</p>425<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>426<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">t</span><span class="s1">'Ah! '</span> <span class="o">+</span> <span class="n">t</span><span class="s1">'We do have </span><span class="si">{cheese}</span><span class="s1">.'</span><span class="p">)</span>427<span class="go">['Ah! We do have ', Interpolation('Camembert', 'cheese', None, ''), '.']</span>428</pre></div>429</div>430<p>Concatenating a <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> and a <code class="docutils literal notranslate"><span class="pre">str</span></code> is <strong>not</strong> supported.431This is because it is unclear whether the string should be treated as432a static string or an interpolation.433If you want to concatenate a <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> with a string,434you should either wrap the string directly in a <code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code>435(to treat it as a static string)436or use an <code class="xref py py-class docutils literal notranslate"><span class="pre">Interpolation</span></code> (to treat it as dynamic):</p>437<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">string.templatelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Interpolation</span><span class="p">,</span> <span class="n">Template</span>438<span class="gp">>>> </span><span class="n">template</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'Ah! '</span>439<span class="gp">>>> </span><span class="c1"># Treat 'We do have ' as a static string</span>440<span class="gp">>>> </span><span class="n">template</span> <span class="o">+=</span> <span class="n">Template</span><span class="p">(</span><span class="s1">'We do have '</span><span class="p">)</span>441<span class="gp">>>> </span><span class="c1"># Treat cheese as an interpolation</span>442<span class="gp">>>> </span><span class="n">cheese</span> <span class="o">=</span> <span class="s1">'Camembert'</span>443<span class="gp">>>> </span><span class="n">template</span> <span class="o">+=</span> <span class="n">Template</span><span class="p">(</span><span class="n">Interpolation</span><span class="p">(</span><span class="n">cheese</span><span class="p">,</span> <span class="s1">'cheese'</span><span class="p">))</span>444<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>445<span class="go">['Ah! We do have ', Interpolation('Camembert', 'cheese', None, '')]</span>446</pre></div>447</div>448</dd></dl>449 450</dd></dl>451 452<dl class="py class">453<dt class="sig sig-object py" id="string.templatelib.Interpolation">454<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">string.templatelib.</span></span><span class="sig-name descname"><span class="pre">Interpolation</span></span><a class="headerlink" href="#string.templatelib.Interpolation" title="Link to this definition">¶</a></dt>455<dd><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">Interpolation</span></code> type represents an expression inside a template string.456It is immutable, meaning that attributes of an interpolation cannot be reassigned.</p>457<p>Interpolations support pattern matching, allowing you to match against458their attributes with the <a class="reference internal" href="../reference/compound_stmts.html#match"><span class="std std-ref">match statement</span></a>:</p>459<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">string.templatelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Interpolation</span>460<span class="gp">>>> </span><span class="n">interpolation</span> <span class="o">=</span> <span class="n">t</span><span class="s1">'{1. + 2.:.2f}'</span><span class="o">.</span><span class="n">interpolations</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>461<span class="gp">>>> </span><span class="n">interpolation</span>462<span class="go">Interpolation(3.0, '1. + 2.', None, '.2f')</span>463<span class="gp">>>> </span><span class="k">match</span> <span class="n">interpolation</span><span class="p">:</span>464<span class="gp">... </span> <span class="k">case</span> <span class="n">Interpolation</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">conversion</span><span class="p">,</span> <span class="n">format_spec</span><span class="p">):</span>465<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">conversion</span><span class="p">,</span> <span class="n">format_spec</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">' | '</span><span class="p">)</span>466<span class="gp">...</span>467<span class="go">3.0 | 1. + 2. | None | .2f</span>468</pre></div>469</div>470<p class="rubric">Attributes</p>471<dl class="py attribute">472<dt class="sig sig-object py" id="string.templatelib.Interpolation.value">473<span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="functions.html#object" title="object"><span class="pre">object</span></a></em><a class="headerlink" href="#string.templatelib.Interpolation.value" title="Link to this definition">¶</a></dt>474<dd><p>The evaluated value of the interpolation.</p>475<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">t</span><span class="s1">'{1 + 2}'</span><span class="o">.</span><span class="n">interpolations</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">value</span>476<span class="go">3</span>477</pre></div>478</div>479</dd></dl>480 481<dl class="py attribute">482<dt class="sig sig-object py" id="string.templatelib.Interpolation.expression">483<span class="sig-name descname"><span class="pre">expression</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="stdtypes.html#str" title="str"><span class="pre">str</span></a></em><a class="headerlink" href="#string.templatelib.Interpolation.expression" title="Link to this definition">¶</a></dt>484<dd><p>For interpolations created by t-string literals, <code class="xref py py-attr docutils literal notranslate"><span class="pre">expression</span></code>485is the expression text found inside the curly brackets (<code class="docutils literal notranslate"><span class="pre">{</span></code> & <code class="docutils literal notranslate"><span class="pre">}</span></code>),486including any whitespace, excluding the curly brackets themselves,487and ending before the first <code class="docutils literal notranslate"><span class="pre">!</span></code>, <code class="docutils literal notranslate"><span class="pre">:</span></code>, or <code class="docutils literal notranslate"><span class="pre">=</span></code> if any is present.488For manually created interpolations, <code class="xref py py-attr docutils literal notranslate"><span class="pre">expression</span></code> is the arbitrary489string provided when constructing the interpolation instance.</p>490<p>We recommend using valid Python expressions or the empty string for the491<code class="docutils literal notranslate"><span class="pre">expression</span></code> field of manually created <code class="xref py py-class docutils literal notranslate"><span class="pre">Interpolation</span></code>492instances, although this is not enforced at runtime.</p>493<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">t</span><span class="s1">'{1 + 2}'</span><span class="o">.</span><span class="n">interpolations</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">expression</span>494<span class="go">'1 + 2'</span>495</pre></div>496</div>497</dd></dl>498 499<dl class="py attribute">500<dt class="sig sig-object py" id="string.templatelib.Interpolation.conversion">501<span class="sig-name descname"><span class="pre">conversion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="typing.html#typing.Literal" title="typing.Literal"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'a'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'r'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'s'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="constants.html#None" title="None"><span class="pre">None</span></a></em><a class="headerlink" href="#string.templatelib.Interpolation.conversion" title="Link to this definition">¶</a></dt>502<dd><p>The conversion to apply to the value, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>503<p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">conversion</span></code> is the optional conversion to apply504to the value:</p>505<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">t</span><span class="s1">'{1 + 2!a}'</span><span class="o">.</span><span class="n">interpolations</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">conversion</span>506<span class="go">'a'</span>507</pre></div>508</div>509<div class="admonition note">510<p class="admonition-title">Note</p>511<p>Unlike f-strings, where conversions are applied automatically,512the expected behavior with t-strings is that code that <em>processes</em> the513<code class="xref py py-class docutils literal notranslate"><span class="pre">Template</span></code> will decide how to interpret and whether to apply514the <code class="xref py py-attr docutils literal notranslate"><span class="pre">conversion</span></code>.515For convenience, the <a class="reference internal" href="#string.templatelib.convert" title="string.templatelib.convert"><code class="xref py py-func docutils literal notranslate"><span class="pre">convert()</span></code></a> function can be used to mimic516f-string conversion semantics.</p>517</div>518</dd></dl>519 520<dl class="py attribute">521<dt class="sig sig-object py" id="string.templatelib.Interpolation.format_spec">522<span class="sig-name descname"><span class="pre">format_spec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="stdtypes.html#str" title="str"><span class="pre">str</span></a></em><a class="headerlink" href="#string.templatelib.Interpolation.format_spec" title="Link to this definition">¶</a></dt>523<dd><p>The format specification to apply to the value.</p>524<p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">format_spec</span></code> is an optional, arbitrary string525used as the format specification to present the value:</p>526<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">t</span><span class="s1">'{1 + 2:.2f}'</span><span class="o">.</span><span class="n">interpolations</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">format_spec</span>527<span class="go">'.2f'</span>528</pre></div>529</div>530<div class="admonition note">531<p class="admonition-title">Note</p>532<p>Unlike f-strings, where format specifications are applied automatically533via the <a class="reference internal" href="functions.html#format" title="format"><code class="xref py py-func docutils literal notranslate"><span class="pre">format()</span></code></a> protocol, the expected behavior with534t-strings is that code that <em>processes</em> the interpolation will535decide how to interpret and whether to apply the format specification.536As a result, <code class="xref py py-attr docutils literal notranslate"><span class="pre">format_spec</span></code> values in interpolations537can be arbitrary strings,538including those that do not conform to the <code class="xref py py-func docutils literal notranslate"><span class="pre">format()</span></code> protocol.</p>539</div>540</dd></dl>541 542<p class="rubric">Methods</p>543<dl class="py method">544<dt class="sig sig-object py" id="string.templatelib.Interpolation.__new__">545<span class="sig-name descname"><span class="pre">__new__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="functions.html#object" title="object"><span class="pre">object</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">expression</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="stdtypes.html#str" title="str"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">conversion</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="typing.html#typing.Literal" title="typing.Literal"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'a'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'r'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'s'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="constants.html#None" title="None"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format_spec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="stdtypes.html#str" title="str"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#string.templatelib.Interpolation.__new__" title="Link to this definition">¶</a></dt>546<dd><p>Create a new <code class="xref py py-class docutils literal notranslate"><span class="pre">Interpolation</span></code> object from component parts.</p>547<dl class="field-list simple">548<dt class="field-odd">Parameters<span class="colon">:</span></dt>549<dd class="field-odd"><ul class="simple">550<li><p><strong>value</strong> – The evaluated, in-scope result of the interpolation.</p></li>551<li><p><strong>expression</strong> – The text of a valid Python expression,552or an empty string.</p></li>553<li><p><strong>conversion</strong> – The <a class="reference internal" href="string.html#formatstrings"><span class="std std-ref">conversion</span></a> to be used,554one of <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">'a'</span></code>, <code class="docutils literal notranslate"><span class="pre">'r'</span></code>, or <code class="docutils literal notranslate"><span class="pre">'s'</span></code>.</p></li>555<li><p><strong>format_spec</strong> – An optional, arbitrary string used as the556<a class="reference internal" href="string.html#formatspec"><span class="std std-ref">format specification</span></a> to present the value.</p></li>557</ul>558</dd>559</dl>560</dd></dl>561 562</dd></dl>563 564</section>565<section id="helper-functions">566<h2>Helper functions<a class="headerlink" href="#helper-functions" title="Link to this heading">¶</a></h2>567<dl class="py function">568<dt class="sig sig-object py" id="string.templatelib.convert">569<span class="sig-prename descclassname"><span class="pre">string.templatelib.</span></span><span class="sig-name descname"><span class="pre">convert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">conversion</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#string.templatelib.convert" title="Link to this definition">¶</a></dt>570<dd><p>Applies formatted string literal <a class="reference internal" href="string.html#formatstrings-conversion"><span class="std std-ref">conversion</span></a>571semantics to the given object <em>obj</em>.572This is frequently useful for custom template string processing logic.</p>573<p>Three conversion flags are currently supported:</p>574<ul class="simple">575<li><p><code class="docutils literal notranslate"><span class="pre">'s'</span></code> which calls <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate"><span class="pre">str()</span></code></a> on the value (like <code class="docutils literal notranslate"><span class="pre">!s</span></code>),</p></li>576<li><p><code class="docutils literal notranslate"><span class="pre">'r'</span></code> which calls <a class="reference internal" href="functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code></a> (like <code class="docutils literal notranslate"><span class="pre">!r</span></code>), and</p></li>577<li><p><code class="docutils literal notranslate"><span class="pre">'a'</span></code> which calls <a class="reference internal" href="functions.html#ascii" title="ascii"><code class="xref py py-func docutils literal notranslate"><span class="pre">ascii()</span></code></a> (like <code class="docutils literal notranslate"><span class="pre">!a</span></code>).</p></li>578</ul>579<p>If the conversion flag is <code class="docutils literal notranslate"><span class="pre">None</span></code>, <em>obj</em> is returned unchanged.</p>580</dd></dl>581 582</section>583</section>584 585 586 <div class="clearer"></div>587 </div>588 </div>589 </div>590 <div class="sphinxsidebar" role="navigation" aria-label="Main">591 <div class="sphinxsidebarwrapper">592 <div>593 <h3><a href="../contents.html">Table of Contents</a></h3>594 <ul>595<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">string.templatelib</span></code> — Support for template string literals</a><ul>596<li><a class="reference internal" href="#template-strings">Template strings</a></li>597<li><a class="reference internal" href="#types">Types</a></li>598<li><a class="reference internal" href="#helper-functions">Helper functions</a></li>599</ul>600</li>601</ul>602 603 </div>604 <div>605 <h4>Previous topic</h4>606 <p class="topless"><a href="string.html"607 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">string</span></code> — Common string operations</a></p>608 </div>609 <div>610 <h4>Next topic</h4>611 <p class="topless"><a href="re.html"612 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code> — Regular expression operations</a></p>613 </div>614 <script>615 document.addEventListener('DOMContentLoaded', () => {616 const title = document.querySelector('meta[property="og:title"]').content;617 const elements = document.querySelectorAll('.improvepage');618 const pageurl = window.location.href.split('?')[0];619 elements.forEach(element => {620 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));621 url.searchParams.set('pagetitle', title);622 url.searchParams.set('pageurl', pageurl);623 url.searchParams.set('pagesource', "library/string.templatelib.rst");624 element.href = url.toString();625 });626 });627 </script>628 <div role="note" aria-label="source link">629 <h3>This page</h3>630 <ul class="this-page-menu">631 <li><a href="../bugs.html">Report a bug</a></li>632 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>633 <li>634 <a href="https://github.com/python/cpython/blob/main/Doc/library/string.templatelib.rst?plain=1"635 rel="nofollow">Show source636 </a>637 </li>638 639 </ul>640 </div>641 </div>642<div id="sidebarbutton" title="Collapse sidebar">643<span>«</span>644</div>645 646 </div>647 <div class="clearer"></div>648 </div> 649 <div class="related" role="navigation" aria-label="Related">650 <h3>Navigation</h3>651 <ul>652 <li class="right" style="margin-right: 10px">653 <a href="../genindex.html" title="General Index"654 >index</a></li>655 <li class="right" >656 <a href="../py-modindex.html" title="Python Module Index"657 >modules</a> |</li>658 <li class="right" >659 <a href="re.html" title="re — Regular expression operations"660 >next</a> |</li>661 <li class="right" >662 <a href="string.html" title="string — Common string operations"663 >previous</a> |</li>664 665 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>666 <li><a href="https://www.python.org/">Python</a> »</li>667 <li class="switchers">668 <div class="language_switcher_placeholder"></div>669 <div class="version_switcher_placeholder"></div>670 </li>671 <li>672 673 </li>674 <li id="cpython-language-and-version">675 <a href="../index.html">3.15.0a6 Documentation</a> »676 </li>677 678 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>679 <li class="nav-item nav-item-2"><a href="text.html" >Text Processing Services</a> »</li>680 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">string.templatelib</span></code> — Support for template string literals</a></li>681 <li class="right">682 683 684 <div class="inline-search" role="search">685 <form class="inline-search" action="../search.html" method="get">686 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">687 <input type="submit" value="Go">688 </form>689 </div>690 |691 </li>692 <li class="right">693<label class="theme-selector-label">694 Theme695 <select class="theme-selector" oninput="activateTheme(this.value)">696 <option value="auto" selected>Auto</option>697 <option value="light">Light</option>698 <option value="dark">Dark</option>699 </select>700</label> |</li>701 702 </ul>703 </div> 704 <div class="footer">705 © <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.706 <br>707 This page is licensed under the Python Software Foundation License Version 2.708 <br>709 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.710 <br>711 712 See <a href="/license.html">History and License</a> for more information.<br>713 714 715 <br>716 717 The Python Software Foundation is a non-profit corporation.718<a href="https://www.python.org/psf/donations/">Please donate.</a>719<br>720 <br>721 Last updated on Mar 10, 2026 (08:58 UTC).722 723 <a href="/bugs.html">Found a bug</a>?724 725 <br>726 727 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.728 </div>729 730 </body>731</html>