如何用Python实现字符串插值

原文来自: How to Implement String Interpolation in Python - DZone Web Dev,本文是在自行理解之后的翻译,粗浅之处,望请谅解。

字符串插值是将字符串中的占位符替换为局域变量的过程。许多编程语言都可以做到,比如 Scala:

// Scale 2.10+
var name = "John";
println(s"My name is $name")
>>> My name is John

Perl:

my $name = "John";
print "My name is $name";
>>> My name is John

CoffeeScript:

name = "John"
console.log "My name is #{name}"
>>> My name is John

… 还有很多。

乍看之下,似乎不大可能使用 Python 实现字符串插值,但实际上,我们只需要两行代码就可以实现。

首先,让我们从基础开始说起。通常我们构建一个复杂的 Python 字符串时都会使用 format 函数:

print "Hi, I am {} and I am {} years old".format(name, age)
>>> Hi, I am John and I am 26 years old

可以看出,format 的实现比字符串连接看起来整洁许多:

print "Hi, I am " + name + " and I am " + str(age) + " years old"
Hi, I am John and I am 26 years old

但如果通过这种方式使用 format 函数,输出的内容就取决于参数的位置顺序:

print "Hi, I am {} and I am {} years old".format(age, name)
Hi, I am 26 and I am John years old

为了避免这种情况,我们可以构造键值对形式的参数序列传给 format 函数,如下:

print "Hi, I am {name} and I am {age} years old".format(name="John", age=26)
Hi, I am John and I am 26 years old
print "Hi, I am {name} and I am {age} years old".format(age=26, name="John")
Hi, I am John and I am 26 years old

这里,为实现字符串插值,我们不得不传入将所有变量传入 format 函数,但是这依然没有达到我们想要的效果,因为 nameage 并不是局域变量。那么,format 函数可以在某种程度上访问到局域变量吗?

答案是可以的,使用 locals 函数我们能够获得存储着所有局域变量对象的字典:

name = "John"
age = 26
locals()
>>> {
 ...
 'age': 26,
 'name': 'John',
 ...
}

现在,我们可以将这个字典传给 format 函数了。不幸的是,我们不能像这样调用 s.format(locals()) :

print "Hi, I am {name} and I am {age} years old".format(locals())
---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)
<ipython-input-5-0fb983071eb8> in <module>()
----> 1 print "Hi, I am {name} and I am {age} years old".format(locals())
KeyError: 'name'

这是因为 locals 函数返回的是一个字典,而 format 函数期望的是键值对参数序列。
幸运的是,我们可以使用 ** 操作符将字典转换为键值对参数序列。如下,假设我们有一个期望键值对序列作为参数的函数:

def foo(arg1=None, arg2=None):
    print "arg1 = " + str(arg1)
    print "arg2 = " + str(arg2)

那么,我们就可以将存储于字典中的参数进行解包传入了:

d = {
    'arg1': 1,
    'arg2': 42
}
foo(**d)
>>> arg1 = 1
arg2 = 42

现在,使用这项技巧,我们就可以完成字符串插值的初版了,它大概长成这样:

print "Hi, I am {name} and I am {age} years old".format(**locals())
Hi, I am John and I am 26 years old

以上代码确实可以达到我们的需求,但看起来既笨重又不雅观。因为在进行字符串插值的时候,我们每次都不得不写上长长的一串 format(\*\*locals()) 。如果能够写一个函数来完成这个过程会好很多,像这样:

# Can we implement inter() function in Python?
print inter("Hi, I am {name} and I am {age} years old")
>>> Hi, I am John and I am 26 years old

你可能觉得这不科学,因为如果我们将完成字符串插值的代码移动到另一个函数中,那么它不就无法访问原本作用域中的局域变量了吗:

name = "John"
print inter("My name is {name}")
...
def inter(s):
  # How can we access "name" variable from here?
  return s.format(...)

然而,这是有可能的。Python 提供了 sys.\_getframe 方法,借用它的便利,我们可以方便地监测到用于保存当前局域变量的 frame 对象:

import sys
def foo():
     foo_var = 'foo'
     bar()
 def bar():
     # sys._getframe(0) would return frame for function "bar"
     # so we need to to access 1-st frame
     # to get local variables from "foo" function
     previous_frame = sys._getframe(1)
     previous_frame_locals = previous_frame.f_locals
     print previous_frame_locals['foo_var']
foo()
>>> foo

稍作解释:
f_localsframe 的一个属性,它用于保存对应作用域的局域对象字典,因此可以通过 f_locals[‘foo_var’] 获取到函数 foo 的局域变量 foo_var
关于framef_locals,可以参考python inspect模块解析 - 2.9. 栈帧(frame) 或者 Python程序的执行原理 - PyFrameObject 部分。

现在的工作就只剩将获得的 frame 数据与函数 format 结合起来了。下面就给出实现 Python 字符串插值的两行代码,请尽情使用吧:

def inter(s):
    return s.format(**sys._getframe(1).f_locals)

## example
name = "John"
age = 26
print inter("Hi, I am {name} and I am {age} years old")
>>> Hi, I am John and I am 26 years old
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,753评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,668评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,090评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,010评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,054评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,806评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,484评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,380评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,873评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,021评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,158评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,838评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,499评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,044评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,159评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,449评论 3 374
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,136评论 2 356

推荐阅读更多精彩内容