Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Interpolated string formatting issue

Tags:

c#

.net

c#-6.0

I have stumbled upon one issue with interpolated strings for a several times now.

Consider the following case:

double number = 123.4567;
var str = $"{{{number:F2}}}"; //I want to get "{123.45}"
Console.WriteLine(str); // Will print "{F2}"

A little surprising at first but once you realize how the curly brackets are paired it makes sense. Two following curly brackets are an escape sequence for a single curly in the interpolated string. So the opening bracket of the interpolated expression is paired with the last curly in the string.

     ___pair____
    |           |
$"{{{number:F2}}}";

Now you could do the following to break the escape sequence:

var str = $"{{{number:F2} }}"; // This will be "{123.45 }"

Notice the space character this approach adds to the output. (Not ideal)

My question:

Lets say I want to use a single interpolated string to get exactly the output "{123.45}"

Is this at all possible without doing something hackish like the following?

var s = $"{{{number:F2}{'}'}";
like image 311
Filip Minx Avatar asked May 28 '18 17:05

Filip Minx


2 Answers

This is an expected behavior of string interpolation. It is mentioned at this Microsoft document. The below content is from Microsoft link only.

Opening and closing braces are interpreted as starting and ending a format item. Consequently, you must use an escape sequence to display a literal opening brace or closing brace. Specify two opening braces ("{{") in the fixed text to display one opening brace ("{"), or two closing braces ("}}") to display one closing brace ("}"). Braces in a format item are interpreted sequentially in the order they are encountered. Interpreting nested braces is not supported.

The way escaped braces are interpreted can lead to unexpected results. For example, consider the format item "{{{0:D}}}", which is intended to display an opening brace, a numeric value formatted as a decimal number, and a closing brace. However, the format item is actually interpreted in the following manner:

  • The first two opening braces ("{{") are escaped and yield one opening brace.
  • The next three characters ("{0:") are interpreted as the start of a format item.
  • The next character ("D") would be interpreted as the Decimal standard numeric format specifier, but the next two escaped braces ("}}") yield a single brace. Because the resulting string ("D}") is not a standard numeric format specifier, the resulting string is interpreted as a custom format string that means display the literal string "D}".
  • The last brace ("}") is interpreted as the end of the format item.
  • The final result that is displayed is the literal string, "{D}". The numeric value that was to be formatted is not displayed.

One way to write your code to avoid misinterpreting escaped braces and format items is to format the braces and format item separately. That is, in the first format operation display a literal opening brace, in the next operation display the result of the format item, then in the final operation display a literal closing brace. The following example illustrates this approach.

int value = 6324;
string output = string.Format("{0}{1:D}{2}", 
                             "{", value, "}");
Console.WriteLine(output);
// The example displays the following output:
//       {6324}  
like image 159
user1672994 Avatar answered Sep 20 '22 12:09

user1672994


Assuming that it is not required to use a named format string, you can use:

var s = $"{{{number:#.#0}}}";
like image 21
pfx Avatar answered Sep 17 '22 12:09

pfx