PEP 750 – Template Strings: lazy string formatting evaluation

https://peps.python.org/pep-0750/

by BiteCode_dev • 2 years ago

2 1 2 years ago

peps.python.org

zahlman• 2 years ago

This PEP supersedes PEP 501 (https://peps.python.org/pep-0501/) from 2015; there was new discussion of the idea in 2023 that I participated in as some of my earliest activity on the Python Discourse (https://discuss.python.org/t/pep-501-reopen-general-purpose-...). Since I'm familiar with the general idea, a summary:

Currently, Python has (among other ways) two different systems that handle {}-based string interpolation: you can make an ordinary string and call its `.format` method later to interpolate the values explicitly, or you can use an f-string. The advantage of f-strings, which justifies the implicit nature, is that they're far more convenient and avoid redundancy. But the disadvantage is that they don't allow for either deferring the interpolation or intercepting the interpolated values. The f-string is basically transformed, at compile time, into code that would assemble the string described; and that code runs immediately, using the current environment (all accessible variable scopes).

In the proposed new reality, a t-string is also transformed at compile time, but it transforms into an instance of some new library class which acts as a container for the parsed string contents. For example, something like

    t'Example {template!r} string with {2.00:g} placeholders'

turns into something like

    Template(
        'Example ',
        Interpolation(template, 'template', conv='r'),
        ' string with ',
        Interpolation(2.00, '2.00', format_spec='g'),
        ' placeholders'
    )

at compile time. (For comparison, the corresponding f-string would turn into something like

    'Example ' + repr(template) + ' string with ' + (2.00).__format__('g') + ' placeholders'

. Of course, these examples are only illustrative; the actual transformation occurs at an AST level, not a source code level. It also doesn't actually use those operators and function calls; f-strings have special support in the form of `FORMAT_VALUE` and `BUILD_STRING` opcodes.)

Then, user code can import from the standard library for the type names (it will probably also need `Interpolation` defined at runtime to do `isinstance` checks) and transform the `Template` into a string following whatever custom logic it likes. Or, indeed, into any other object; the usual dynamic typing rules apply. When the transformation function is called, the Template already embeds the variable values, so they don't need to be passed (unlike with the `.format` method), but no actual string assembly has been done yet (unlike with an f-string). So there is a complete separation of concerns between what is interpolated and how the interpolation is done, but still no need to specify the "what" explicitly (i.e. redundantly with the placeholder names) - and the default "how" is not privileged.

(Hopefully it's obvious why t-strings wouldn't be able to benefit from bytecode optimizations like f-strings do.)

As a personal observation, the kinds of compile-time transformation involved in both f-strings and the proposed t-strings could be seen as special cases of what the far-reaching "Syntactic Macros" PEP (https://peps.python.org/pep-0638/) hopes to offer (but hard-coded and not using a special macro syntax).

PEP 750 – Template Strings: lazy string formatting evaluation

Related Stories