字符串中插入變量

問題

你想創建一個內嵌變量的字符串，變量被它的值所表示的字符串替換掉。

解法

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

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

或者，如果要被替換的變量能在變量域中找到，那么你可以結合使用 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 + '}'

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

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

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

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

現在你可以像下面這樣寫了：

>>> 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 缺乏對變量替換的內置支持而導致了各種不同的解決方案。作為本節中展示的一個可能的解決方案，你可以有時候會看到像下面這樣的字符串格式化代碼：

>>> 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() 相比較上面這些方案而已更加先進，因此應該被優先選擇。使用 format() 方法還有一個好處就是你可以獲得對字符串格式化的所有支持 (對齊，填充，數字格式化等待)，而這些特性是使用像模板字符串之類的方案不可能獲得的。

映射或者字典類中鮮為人知的__missing__() 方法可以讓你定義如何處理缺失的值。在 SafeSub 類中，這個方法被定義為對缺失的值返回一個占位符。你可以發現缺失的值會出現在結果字符串中 (在調試的時候可能很有用)，而不是產生一個 KeyError 異常。

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

總結

以上是生活随笔為你收集整理的《Python Cookbook 3rd》笔记（2.15）：字符串中插入变量的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。