String formatting options: pros and cons

Question

These are two very popular ways of formatting a string in Python. One is using a dict:

>>> 'I will be %(years)i on %(month)s %(day)i' % {'years': 21, 'month': 'January', 'day': 23}
'I will be 21 on January 23'

And the other one using a simple tuple:

>>> 'I will be %i on %s %i' % (21, 'January', 23)
'I will be 21 on January 23'

The first one is way more readable, but the second one is faster to write. I actually use them indistinctly.

What are the pros and cons of each one? regarding performance, readability, code optimization (is one of them transformed to the other?) and anything else you would think is useful to share.

Answer 1

Why format() is more flexible than % string operations

I think you should really stick to format() method of str, because it is the preferred way to format strings and will probably replace string formatting operation in the future.

Furthermore, it has some really good features, that can also combine position-based formatting with keyword-based one:

>>> string = 'I will be {} years and {} months on {month} {day}'
>>> some_date = {'month': 'January', 'day': '1st'}
>>> diff = [3, 11] # years, months
>>> string.format(*diff, **some_date)
'I will be 3 years and 11 months on January 1st'

even the following will work:

>>> string = 'On {month} {day} it will be {1} months, {0} years'
>>> string.format(*diff, **some_date)
'On January 1st it will be 11 months, 3 years'

There is also one other reason in favor of format(). Because it is a method, it can be passed as a callback like in the following example:

>>> data = [(1, 2), ('a', 'b'), (5, 'ABC')]
>>> formatter = 'First is "{0[0]}", then comes "{0[1]}"'.format
>>> for item in map(formatter, data):
    print item


First is "1", then comes "2"
First is "a", then comes "b"
First is "5", then comes "ABC"

Isn't it a lot more flexible than string formatting operation?

See more examples on documentation page for comparison between % operations and .format() method.

Comparing tuple-based % string formatting with dictionary-based

Generally there are three ways of invoking % string operations (yes, three, not two) like that:

base_string % values

and they differ by the type of values (which is a consequence of what is the content of base_string):

• it can be a tuple, then they are replaced one by one, in the order they are appearing in tuple,

  >>> 'Three first values are: %f, %f and %f' % (3.14, 2.71, 1)
  'Three first values are: 3.140000, 2.710000 and 1.000000'
  

• it can be a dict (dictionary), then they are replaced based on the keywords,

  >>> 'My name is %(name)s, I am %(age)s years old' % {'name':'John','age':98}
  'My name is John, I am 98 years old'
  

• it can be a single value, if the base_string contains single place where the value should be inserted:

  >>> 'This is a string: %s' % 'abc'
  'This is a string: abc'
  

There are obvious differences between them and these ways cannot be combined (in contrary to format() method which is able to combine some features, as mentioned above).

But there is something that is specific only to dictionary-based string formatting operation and is rather unavailable in remaining three formatting operations' types. This is ability to replace specificators with actual variable names in a simple manner:

>>> name = 'John'
>>> surname = 'Smith'
>>> age = 87
# some code goes here
>>> 'My name is %(surname)s, %(name)s %(surname)s. I am %(age)i.' % locals()
'My name is Smith, John Smith. I am 87.'

Just for the record: of course the above could be easily replaced by using format() by unpacking the dictionary like that:

>>> 'My name is {surname}, {name} {surname}. I am {age}.'.format(**locals())
'My name is Smith, John Smith. I am 87.'

Does anyone else have an idea what could be a feature specific to one type of string formatting operation, but not to the other? It could be quite interesting to hear about it.

Answer 2

I'm not exactly answering your question, but just thought it'd be nice to throw format into your mix.

I personally prefer the syntax of format to both:

'I will be {years} on {month} {day}'.format(years=19, month='January', day=23)

If I want something compact, I just write:

'I will be {} on {} {}'.format(19, 'January', 23)

And format plays nicely with objects:

class Birthday:
  def __init__(self, age, month, day):
    self.age = age
    self.month = month
    self.day = day

print 'I will be {b.age} on {b.month} {b.day}'.format(b = Birthday(19, 'January', 23))

Answer 3

I am not answering the question but just explaining the idea I came up in my TIScript.

I've introduced so called "stringizer" functions: any function with name starting from '$' is a stringizer. Compiler treats '$name(' and ')' as quotes of string literal combined with function call.

Example, this:

$print(I will be {b.age} on {b.month} {b.day});

is actually compiled into

$print("I will be ", b.age, " on ",b.month," ",b.day);

where even arguments are always literal strings and odd ones are expressions. This way it is possible to define custom stringizers that use different formatting/argument processing.

For example Element.$html(Hello <b>{who}</b>); will apply HTML escape on expressions. And this Element.$(option[value={12}]); will do select in jQuery style.

Pretty convenient and flexible.

I am not sure is it possible to do something like this in Python without changing its compiler. Consider just as an idea.