python's ".format" function

Question

Recently, I found ''.format function very useful because it can improve readability a lot comparing to the % formatting. Trying to achieve simple string formatting:

data = {'year':2012, 'month':'april', 'location': 'q2dm1'}

year = 2012
month = 'april'
location = 'q2dm1'
a = "year: {year}, month: {month}, location: {location}"
print a.format(data)
print a.format(year=year, month=month, location=location)
print a.format(year, month, location)

Whilst two first prints do format as I expect (yes, something=something looks ugly, but that's an example only), the last one would raise KeyError: 'year'. Is there any trick in python to create dictionary so it will automatically fill keys and values, for example somefunc(year, month, location) will output {'year':year, 'month': month, 'location': location}?

I'm pretty new to python and couldn't find any info on this topic, however a trick like this would improve and shrink my current code drastically.

Thanks in advance and pardon my English.

okm · Accepted Answer · 2012-04-15 08:01:34Z

6

The first print should be

print a.format(**data)

Also, if you are finding some shortcuts, you could write one like, no big difference.

def trans(year, month, location):
    return dict(year=year, month=month, location=location)

answered Apr 15, 2012 at 8:01

okm

23.9k5 gold badges86 silver badges92 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

duke_nukem Over a year ago

Seems there's no way to shrink this repeating code:) Function is good and it was what i did, actually, but later i found it hard to sustain because with lots of arguments i needed to change code in several places, which turned out to be even worse than actually creating dict by hands.

okm Over a year ago

@duke_nukem yes it depends on your actual usage. The code is fine and the format api is clear enough. If you what to achieve something like format(*args, **kwargs), it could be done also, but I don't think it could make things easier.

Community · Accepted Answer · 2017-05-23 12:24:16Z

3

data = {'year':2012, 'month':'april', 'location': 'q2dm1'}
a = "year: {year}, month: {month}, location: {location}"

print a.format(**data)

..is what you are looking for. It's functionally identical to doing .format(year=data['year'], ...), or the other examples you gave.

The double-asterix thing is a hard thing to search for, so it's usually referred to as "kwargs". Here's a good SO question on this syntax

edited May 23, 2017 at 12:24

CommunityBot

11 silver badge

answered Apr 15, 2012 at 13:03

dbr

171k69 gold badges284 silver badges348 bronze badges

Comments

ThiefMaster · Accepted Answer · 2012-04-15 09:33:36Z

1

You can use the dict() callable:

dict(year=yeah, month=month, location=location)

When passing keyword arguments it creates a dict containing the elements you specified as kwargs.

If you do not want to specify the argument names, use the positional style of .format():

>>> a = 'year {0} month {1} location {2}'
>>> print a.format(2012, 'april', 'abcd')
year 2012 month april location abcd

However, if you try to do something similar to what compact() in PHP does (create a dict mapping variable names to its values without specifying name and variable separately), please don't. It just results in ugly unreadable code and would require nasty hacks anyway.

edited Apr 15, 2012 at 9:33

answered Apr 15, 2012 at 7:53

ThiefMaster

320k85 gold badges608 silver badges648 bronze badges

6 Comments

duke_nukem Over a year ago

Yes, i'm aware of dict() but i'm trying to avoid unnecessary code and shrink it down a bit. .format can accept your option without dict() by the way. Thank you.

duke_nukem Over a year ago

Thanks, it's close to what i need, however with 10-12 arguments it becomes pretty hard to navigate through indices.

ThiefMaster Over a year ago

Well in this case you are supposed to use the dict syntax. However, depending on what you want to do, consider using a real template engine such as jinja2.

duke_nukem Over a year ago

Thanks for the template direction.

user719958 Over a year ago

Also, just adding, dict is not a function. dict is a type.

|

Marcin · Accepted Answer · 2012-04-15 12:35:16Z

1

You could pass locals():

a.format(**locals())

Of course, this has issues: you will have to pass everything in locals, and it can be difficult to understand the effect of renaming or removing a variable.

A better way would be:

a.format(**{k:v for k,v in locals() if k in ('year', 'month')})
# or; note that if you move the lambda expression elsewhere, you will get a different result
a.format(**(lambda ld = locals(): {k:ld[k] for k in ('year', 'month')})())

But this is not any more concise, unless you wrap it up with a function (which must of course take a dict parameter).

edited Apr 15, 2012 at 12:35

answered Apr 15, 2012 at 9:54

Marcin

50.1k18 gold badges137 silver badges207 bronze badges

Comments

quasoft · Accepted Answer · 2017-01-29 17:29:12Z

As of Python 3.6, you can also use the new Formatted string literals (f-strings), which you can use with variables:

year = 2012
month = 'april'
location = 'q2dm1'
a = f"year: {year}, month: {month}, location: {location}"
print(a)

or a dictionary:

data = {'year': 2012, 'month': 'april', 'location': 'q2dm1'}
a = f"year: {data['year']}, month: {data['month']}, location: {data['location']}"
print(a)

Note the f prefix before the string literal.

PEP 498: Formatted string literals:

Formatted string literals are prefixed with 'f' and are similar to the format strings accepted by str.format(). They contain replacement fields surrounded by curly braces. The replacement fields are expressions, which are evaluated at run time, and then formatted using the format() protocol:
>>>
>>> name = "Fred"
>>> f"He said his name is {name}."
'He said his name is Fred.'
>>> width = 10
>>> precision = 4
>>> value = decimal.Decimal("12.34567")
>>> f"result: {value:{width}.{precision}}"  # nested fields
'result:      12.35'
...

Collectives™ on Stack Overflow

python's ".format" function

5 Answers 5

2 Comments

Comments

6 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

2 Comments

Comments

6 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related