2.15 字符串中插入變量

問題

你想創(chuàng)建一個內(nèi)嵌變量的字符串，變量被它的值所表示的字符串替換掉。

解決方案

Python并沒有對在字符串中簡單替換變量值提供直接的支持。但是通過使用字符串的 format() 方法來解決這個問題。比如：

>>> s = '{name} has {n} messages.'
>>> s.format(name='Guido', n=37)
'Guido has 37 messages.'
>>>

或者，如果要被替換的變量能在變量域中找到，那么你可以結(jié)合使用 format_map() 和 vars() 。就像下面這樣：

>>> name = 'Guido'
>>> n = 37
>>> s.format_map(vars())
'Guido has 37 messages.'
>>>

vars() 還有一個有意思的特性就是它也適用于對象實例。比如：

>>> class Info:
...     def __init__(self, name, n):
...         self.name = name
...         self.n = n
...
>>> a = Info('Guido',37)
>>> s.format_map(vars(a))
'Guido has 37 messages.'
>>>

format 和 format_map() 的一個缺陷就是它們并不能很好的處理變量缺失的情況，比如：

>>> s.format(name='Guido')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'n'
>>>

一種避免這種錯誤的方法是另外定義一個含有 __missing__() 方法的字典對象，就像下面這樣：

class safesub(dict):
"""防止key找不到"""
def __missing__(self, key):
    return '{' + key + '}'

現(xiàn)在你可以利用這個類包裝輸入后傳遞給 format_map() ：

>>> del n # Make sure n is undefined
>>> s.format_map(safesub(vars()))
'Guido has {n} messages.'
>>>

如果你發(fā)現(xiàn)自己在代碼中頻繁的執(zhí)行這些步驟，你可以將變量替換步驟用一個工具函數(shù)封裝起來。就像下面這樣：

import sys

def sub(text):
    return text.format_map(safesub(sys._getframe(1).f_locals))

現(xiàn)在你可以像下面這樣寫了：

>>> name = 'Guido'
>>> n = 37
>>> print(sub('Hello {name}'))
Hello Guido
>>> print(sub('You have {n} messages.'))
You have 37 messages.
>>> print(sub('Your favorite color is {color}'))
Your favorite color is {color}
>>>

討論

多年以來由于Python缺乏對變量替換的內(nèi)置支持而導(dǎo)致了各種不同的解決方案。作為本節(jié)中展示的一個可能的解決方案，你可以有時候會看到像下面這樣的字符串格式化代碼：

>>> name = 'Guido'
>>> n = 37
>>> '%(name) has %(n) messages.' % vars()
'Guido has 37 messages.'
>>>

你可能還會看到字符串模板的使用：

>>> import string
>>> s = string.Template('$name has $n messages.')
>>> s.substitute(vars())
'Guido has 37 messages.'
>>>

然而，format() 和 format_map() 相比較上面這些方案而已更加先進(jìn)，因此應(yīng)該被優(yōu)先選擇。使用 format() 方法還有一個好處就是你可以獲得對字符串格式化的所有支持(對齊，填充，數(shù)字格式化等待)，而這些特性是使用像模板字符串之類的方案不可能獲得的。

本機還部分介紹了一些高級特性。映射或者字典類中鮮為人知的 __missing__() 方法可以讓你定義如何處理缺失的值。在SafeSub類中，這個方法被定義為對缺失的值返回一個占位符。你可以發(fā)現(xiàn)缺失的值會出現(xiàn)在結(jié)果字符串中(在調(diào)試的時候可能很有用)，而不是產(chǎn)生一個KeyError異常。

sub() 函數(shù)使用 sys._getframe(1) 返回調(diào)用者的棧幀?？梢詮闹性L問屬性 f_locals 來獲得局部變量。毫無疑問絕大部分情況下在代碼中去直接操作棧幀應(yīng)該是不推薦的。但是，對于像字符串替換工具函數(shù)而言它是非常有用的。另外，值得注意的是 f_locals 是一個復(fù)制調(diào)用函數(shù)的本地變量的字典。盡管你可以改變 f_locals 的內(nèi)容，但是這個修改對于后面的變量訪問沒有任何影響。所以，雖說訪問一個幀棧看上去很邪惡，但是對它的任何操作不會覆蓋和改變調(diào)用者本地變量的值。