String interpolation

In computer programming, string interpolation (or variable interpolation, variable substitution, or variable expansion) is the process of evaluating a string literal containing one or more placeholders, yielding a result in which the placeholders are replaced with their corresponding values. It is a form of simple template processing^[1] or, in formal terms, a form of quasi-quotation (or logic substitution interpretation). The placeholder may be a variable name, or in some languages an arbitrary expression, in either case evaluated in the current context.

String interpolation is an alternative to building string via concatenation, which requires repeat quoting and unquoting;^[2] or substituting into a printf format string, where the variable is far from where it is used. Compare: <syntaxhighlight lang="ruby"> apples = 4 puts "I have #{apples} apples." # string interpolation puts "I have " + String(apples) + " apples." # string concatenation puts "I have %d apples." % apples # format string </syntaxhighlight>

Two types of literal expression are usually offered: one with interpolation enabled, the other without. Non-interpolated strings may also escape sequences, in which case they are termed a raw string, though in other cases this is separate, yielding three classes of raw string, non-interpolated (but escaped) string, interpolated (and escaped) string. For example, in Unix shells, single-quoted strings are raw, while double-quoted strings are interpolated. Placeholders are usually represented by a bare or a named sigil (typically $ or %), e.g. $apples or %apples, or with braces, e.g. {apples}, sometimes both, e.g. ${apples}. In some cases additional formatting specifiers can be used (as in printf), e.g. {apples:3}, and in some cases the formatting specifiers themselves can be interpolated, e.g. {apples:width}. Expansion of the string usually occurs at run time.

Language support for string interpolation varies widely. Some languages do not offer string interpolation, instead using concatenation, simple formatting functions, or template libraries. String interpolation is common in many programming languages which make heavy use of string representations of data, such as Apache Groovy, Julia, Kotlin, Perl, PHP, Python, Ruby, Scala, Swift, Tcl and most Unix shells.

Algorithms

There are two main types of variable-expanding algorithms for variable interpolation:^[3]

Replace and expand placeholders: creating a new string from the original one, by find–replace operations. Find variable reference (placeholder), replace it by its variable value. This algorithm offers no cache strategy.
Split and join string: splitting the string into an array, merging it with the corresponding array of values, then joining items by concatenation. The split string can be cached for reuse.

Security issues

String interpolation, like string concatenation, may lead to security problems. If user input data is improperly escaped or filtered, the system will be exposed to SQL injection, script injection, XML external entity (XXE) injection, and cross-site scripting (XSS) attacks.^[4]

An SQL injection example:

query = "<syntaxhighlight lang="sql" class="" style="" inline="1">SELECT x, y, z FROM Table WHERE id='$id'</syntaxhighlight> "

If $id is replaced with "'; <syntaxhighlight lang="sql" class="" style="" inline="1">DELETE FROM Table; SELECT * FROM Table WHERE id='</syntaxhighlight>", executing this query will wipe out all the data in Table.

Examples

ABAP

<syntaxhighlight lang="abap"> DATA(apples) = 4. WRITE |I have { apples } apples|. </syntaxhighlight>The output will be:<syntaxhighlight lang="output"> I have 4 apples </syntaxhighlight>

Bash

<syntaxhighlight lang="bash"> apples=4 echo "I have $apples apples"

or

echo "I have ${apples} apples" </syntaxhighlight> The output will be: <syntaxhighlight lang="output">I have 4 apples</syntaxhighlight>

Boo

<syntaxhighlight lang="boo"> apples = 4 print("I have $(apples) apples")

or

print("I have {0} apples" % apples) </syntaxhighlight> The output will be: <syntaxhighlight lang="output">I have 4 apples</syntaxhighlight>

C#

<syntaxhighlight lang="csharp"> var apples = 4; var bananas = 3;

Console.WriteLine($"I have {apples} apples"); Console.WriteLine($"I have {apples + bananas} fruits"); </syntaxhighlight>^[5]

The output will be: <syntaxhighlight lang="output"> I have 4 apples I have 7 fruits </syntaxhighlight>

ColdFusion Markup Language

ColdFusion Markup Language (CFML) script syntax: <syntaxhighlight lang="cfc"> apples = 4; writeOutput("I have #apples# apples");</syntaxhighlight>

Tag syntax: <syntaxhighlight lang="cfm"> <cfset apples = 4> <cfoutput>I have #apples# apples</cfoutput></syntaxhighlight>

The output will be:

I have 4 apples

CoffeeScript

<syntaxhighlight lang="coffeescript"> apples = 4 console.log "I have #{apples} apples" </syntaxhighlight> The output will be: <syntaxhighlight lang="output">I have 4 apples</syntaxhighlight>

Dart

<syntaxhighlight lang="dart"> int apples = 4, bananas = 3; print('I have $apples apples.'); print('I have ${apples+bananas} fruits.'); </syntaxhighlight> The output will be: <syntaxhighlight lang="output">I have 4 apples. I have 7 fruits.</syntaxhighlight>

Go

As of 2022^[update], Go does not have string interpolation. There have been some proposals for string interpolation in the next version of the language, Go 2.^[6]^[7] Instead, Go uses printf format strings in the fmt.Sprintf function, string concatenation, or template libraries like text/template.

Groovy

In groovy, interpolated strings are known as GStrings:^[8] <syntaxhighlight lang="groovy"> def quality = "superhero" final age = 52 def sentence = "A developer is a $quality if he is ${age <= 42 ? 'young' : 'seasoned'}" println sentence </syntaxhighlight> The output will be: <syntaxhighlight lang="output">A developer is a superhero if he is seasoned</syntaxhighlight>

Haxe

<syntaxhighlight lang="haxe"> var apples = 4; var bananas = 3; trace('I have $apples apples.'); trace('I have ${apples+bananas} fruits.'); </syntaxhighlight> The output will be:^[9] <syntaxhighlight lang="output"> I have 4 apples. I have 7 fruits. </syntaxhighlight>

Java

Java had interpolated strings as a preview feature in Java 21 and Java 22. You could use the constant STR of java.lang.StringTemplate directly.<syntaxhighlight lang="java" line="1"> enum Stage{test,qa,prod} record Deploy(UUID image, Stage stage){} var deploy=new Deploy(UUID.randomUUID(), Stage.test) STR."Installing \{deploy.image()} on Stage \{deploy.stage()} ..." var deploy=new Deploy(UUID.randomUUID(), Stage.prod) STR."Installing \{deploy.image()} on Stage \{deploy.stage()} ..." </syntaxhighlight>

They were removed in Java 23 due to design issues.^[10]

JavaScript

JavaScript, as of the ECMAScript 2015 (ES6) standard, supports string interpolation using backticks ``. This feature is called template literals.^[11] Here is an example: <syntaxhighlight lang="javascript"> const apples = 4; const bananas = 3; console.log(`I have ${apples} apples`); console.log(`I have ${apples + bananas} fruits`); </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples I have 7 fruits </syntaxhighlight>

Template literals can also be used for multi-line strings: <syntaxhighlight lang="javascript"> console.log(`This is the first line of text. This is the second line of text.`); </syntaxhighlight>

The output will be: <syntaxhighlight lang="output"> This is the first line of text. This is the second line of text. </syntaxhighlight>

Julia

<syntaxhighlight lang="julia"> apples = 4 bananas = 3 print("I have $apples apples and $bananas bananas, making $(apples + bananas) pieces of fruit in total.") </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples and 3 bananas, making 7 pieces of fruit in total. </syntaxhighlight>

Kotlin

<syntaxhighlight lang="kotlin"> val quality = "superhero" val apples = 4 val bananas = 3 val sentence = "A developer is a $quality. I have ${apples + bananas} fruits" println(sentence) </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> A developer is a superhero. I have 7 fruits </syntaxhighlight>

Nemerle

<syntaxhighlight lang="boo"> def apples = 4; def bananas = 3; Console.WriteLine($"I have $apples apples."); Console.WriteLine($"I have $(apples + bananas) fruit.");</syntaxhighlight> It also supports advanced formatting features, such as: <syntaxhighlight lang="boo">def fruit = ["apple", "banana"]; Console.WriteLine($<#I have ..$(fruit; "\n"; f => f + "s")#>);</syntaxhighlight> The output will be: <syntaxhighlight lang="output">apples bananas</syntaxhighlight>

Nim

Nim provides string interpolation via the strutils module. Formatted string literals inspired by Python F-string are provided via the strformat module, the strformat macro verifies that the format string is well-formed and well-typed, and then are expanded into Nim source code at compile-time. <syntaxhighlight lang="nim"> import strutils, strformat var apples = 4 var bananas = 3 echo "I have $1 apples".format(apples) echo fmt"I have {apples} apples" echo fmt"I have {apples + bananas} fruits"

Multi-line

echo fmt""" I have {apples} apples"""

Debug the formatting

echo fmt"I have {apples=} apples"

Custom openChar and closeChar characters

echo fmt("I have (apples) {apples}", '(', ')')

Backslash inside the formatted string literal

echo fmt"""{ "yep\nope" }""" </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples I have 4 apples I have 7 fruits I have 4 apples I have apples=4 apples I have 4 {apples} yep ope </syntaxhighlight>

Nix

<syntaxhighlight lang="nix"> let numberOfApples = "4"; in "I have ${numberOfApples} apples" </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples </syntaxhighlight>

ParaSail

<syntaxhighlight lang="parasail"> const Apples := 4 const Bananas := 3 Println ("I have `(Apples) apples.\n") Println ("I have `(Apples+Bananas) fruits.\n") </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples. I have 7 fruits. </syntaxhighlight>

Perl

<syntaxhighlight lang="perl"> my $apples = 4; my $bananas = 3; print "I have $apples apples.\n"; print "I have @{[$apples+$bananas]} fruit.\n"; # Uses the Perl array (@) interpolation. </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples. I have 7 fruit.</syntaxhighlight>

PHP

<syntaxhighlight lang="php"> <?php $apples = 5; $bananas = 3; echo "There are $apples apples and $bananas bananas.\n"; echo "I have {$apples} apples and {$bananas} bananas."; </syntaxhighlight>The output will be: <syntaxhighlight lang="output">There are 5 apples and 3 bananas. I have 5 apples and 3 bananas.</syntaxhighlight>

Python

Python supports string interpolation as of version 3.6, referred to as "formatted string literals".^[12]^[13]^[14] Such a literal begins with an f or F before the opening quote, and uses braces for placeholders: <syntaxhighlight lang="python"> apples = 4 bananas = 3 print(f'I have {apples} apples and {bananas} bananas') </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples and 3 bananas</syntaxhighlight>

Ruby / Crystal

<syntaxhighlight lang="ruby"> apples = 4 puts "I have #{apples} apples"

Format string applications for comparison:

puts "I have %s apples" % apples puts "I have %{a} apples" % {a: apples} </syntaxhighlight>

The output will be: <syntaxhighlight lang="output">I have 4 apples</syntaxhighlight>

Rust

Rust does not have general string interpolation, but provides similar functionality via macros, referred to as "Captured identifiers in format strings", introduced in version 1.58.0, released 2022-01-13.^[15]

Rust provides formatting via the std::fmt module, which is interfaced with through various macros such as format!, write!, and print!. These macros are converted into Rust source code at compile-time, whereby each argument interacts with a formatter. The formatter supports positional parameters, named parameters, argument types, defining various formatting traits, and capturing identifiers from the environment.

<syntaxhighlight lang="rust"> let (apples, bananas) = (4, 3); // println! captures the identifiers when formatting: the string itself isn't interpolated by Rust. println!("There are {apples} apples and {bananas} bananas."); </syntaxhighlight> The output will be: <syntaxhighlight lang="output"> There are 4 apples and 3 bananas. </syntaxhighlight>

Scala

Scala 2.10+ provides a general facility to allow arbitrary processing of a string literal, and supports string interpolation using the included s and f string interpolators. It is also possible to write custom ones or override the standard ones.

The f interpolator is a compiler macro that rewrites a format string with embedded expressions as an invocation of String.format. It verifies that the format string is well-formed and well-typed.

The standard interpolators

Scala 2.10+'s string interpolation allows embedding variable references directly in processed string literals. Here is an example: <syntaxhighlight lang="scala"> val apples = 4 val bananas = 3 //before Scala 2.10 printf("I have %d apples\n", apples) println("I have %d apples" format apples) //Scala 2.10+ println(s"I have $apples apples") println(s"I have ${apples + bananas} fruits") println(f"I have $apples%d apples") </syntaxhighlight>

The output will be:<syntaxhighlight lang="output">I have 4 apples</syntaxhighlight>

Sciter (tiscript)

In Sciter any function with name starting from $ is considered as interpolating function and so interpolation is customizable and context sensitive: <syntaxhighlight lang="javascript"> var apples = 4 var bananas = 3 var domElement = ...;

domElement.$content(

I have {apples} apples

); domElement.$append(

I have {apples + bananas} fruits

);

</syntaxhighlight>

Where <syntaxhighlight lang="javascript">domElement.$content(

I have {apples} apples

);</syntaxhighlight> gets compiled to this: <syntaxhighlight lang="javascript">domElement.html = "

I have " + apples.toHtmlString() + " apples

";</syntaxhighlight>

Snobol

  apples = 4 ; bananas = 3
  Output = "I have " apples " apples."
  Output = "I have "  (apples + bananas) " fruits."

</syntaxhighlight> The output will be: <syntaxhighlight lang="output"> I have 4 apples. I have 7 fruits. </syntaxhighlight>

Swift

In Swift, a new String value can be created from a mix of constants, variables, literals, and expressions by including their values inside a string literal.^[16] Each item inserted into the string literal is wrapped in a pair of parentheses, prefixed by a backslash.

<syntaxhighlight lang="fsharp"> let apples = 4 print("I have \(apples) apples") </syntaxhighlight>The output will be: <syntaxhighlight lang="output">I have 4 apples</syntaxhighlight>

Tcl

The Tool Command Language has always supported string interpolation in all quote-delimited strings.

<syntaxhighlight lang="tcl"> set apples 4 puts "I have $apples apples." </syntaxhighlight> The output will be: <syntaxhighlight lang="output">I have 4 apples.</syntaxhighlight>

In order to actually format - and not simply replace - the values, there is a formatting function.

<syntaxhighlight lang="tcl"> set apples 4 puts [format "I have %d apples." $apples] </syntaxhighlight>

TypeScript

As of version 1.4, TypeScript supports string interpolation using backticks ``. Here is an example: <syntaxhighlight lang="typescript"> var apples: number = 4; console.log(`I have ${apples} apples`); </syntaxhighlight> The output will be: <syntaxhighlight lang="output">I have 4 apples</syntaxhighlight> The console.log function can be used as a printf function. The above example can be rewritten, thusly: <syntaxhighlight lang="typescript"> var apples: number = 4; console.log("I have %d apples", apples); </syntaxhighlight> The output remains the same.

Visual Basic

As of Visual Basic 14, string interpolation is supported in Visual Basic.^[17]

<syntaxhighlight lang="vbnet"> name = "Tom" Console.WriteLine($"Hello, {name}") </syntaxhighlight>

The output will be: <syntaxhighlight lang="output">Hello, Tom</syntaxhighlight>

Notes

^ "Enforcing Strict Model-View Separation in Template Engines", T. Parr (2004), WWW2004 conference.
^ "Interpolation in Perl". This is much tidier than repeat uses of the '.' concatenation operator.
^ "smallest-template-system/Simplest algorithms", an online tutorial for placeholder-template-systems.
^ "Secure String Interpolation". google-caja.googlecode.com. Archived from the original on 2012-10-19.
^ "Strings - C# Programming Guide". 15 March 2024.
^ "proposal: Go 2: string interpolation #34174". GitHub.
^ "proposal: Go 2: string interpolation evaluating to string and list of expressions #50554". GitHub.
^ "The Apache Groovy programming language - Syntax". groovy-lang.org. Retrieved 2021-06-20.
^ "Haxe - Manual - String interpolation". Haxe - The Cross-platform Toolkit. Retrieved 2017-09-12.
^ https://docs.oracle.com/en/java/javase/23/migrate/significant-changes-jdk-release.html
^ "Template literals (Template strings) - JavaScript | MDN". 31 May 2024.
^ "The Python Tutorial: 7.1.1. Formatted String Literals".
^ "The Python Language Reference: 2.4.3. Formatted string literals".
^ "PEP 498 -- Literal String Interpolation".
^ "Announcing Rust 1.58.0: Captured identifiers in format strings". 2022-01-13.
^ "Strings and Characters — The Swift Programming Language (Swift 5.5)". docs.swift.org. Retrieved 2021-06-20.
^ KathleenDollard. "Interpolated Strings - Visual Basic". docs.microsoft.com. Retrieved 2021-06-20.

[1] "Enforcing Strict Model-View Separation in Template Engines", T. Parr (2004), WWW2004 conference.

[2] "Interpolation in Perl". This is much tidier than repeat uses of the '.' concatenation operator.

[3] "smallest-template-system/Simplest algorithms", an online tutorial for placeholder-template-systems.

[4] "Secure String Interpolation". google-caja.googlecode.com. Archived from the original on 2012-10-19.

[5] "Strings - C# Programming Guide". 15 March 2024.

[6] "proposal: Go 2: string interpolation #34174". GitHub.

[7] "proposal: Go 2: string interpolation evaluating to string and list of expressions #50554". GitHub.

[8] "The Apache Groovy programming language - Syntax". groovy-lang.org. Retrieved 2021-06-20.

[9] "Haxe - Manual - String interpolation". Haxe - The Cross-platform Toolkit. Retrieved 2017-09-12.

[10] ttps://docs.oracle.com/en/java/javase/23/migrate/significant-changes-jdk-release.html

[11] "Template literals (Template strings) - JavaScript | MDN". 31 May 2024.

[12] "The Python Tutorial: 7.1.1. Formatted String Literals".

[13] "The Python Language Reference: 2.4.3. Formatted string literals".

[14] "PEP 498 -- Literal String Interpolation".

[15] "Announcing Rust 1.58.0: Captured identifiers in format strings". 2022-01-13.

[16] "Strings and Characters — The Swift Programming Language (Swift 5.5)". docs.swift.org. Retrieved 2021-06-20.

[17] KathleenDollard. "Interpolated Strings - Visual Basic". docs.microsoft.com. Retrieved 2021-06-20.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]

[15]

[16]

[17]