对字符串使用 locals() 和 format() 方法：有什么注意事项吗？

Question

关于使用以下模式是否有任何缺点、注意事项或不良做法警告？

def buildString(user, name = 'john', age=22):
    userId = user.getUserId()
    return "Name: {name}, age: {age}, userid:{userId}".format(**locals())

我有一个非常重复的字符串生成代码要编写并且很想使用它，但是使用 locals() 的一些事情让我感到不舒服。这是否有任何意外行为的危险？

编辑：上下文

我发现自己经常写这样的东西：

"{name} {age} {userId} {etc}...".format(name=name, age=age, userId=userId, etc=etc)

Answer 1

现在有一种官方方法可以做到这一点，从 Python 3.6.0 开始：formatted string literals。

它是这样工作的：

f'normal string text {local_variable_name}'

例如而不是这些：

"hello %(name) you are %(age) years old" % locals()
"hello {name} you are {age} years old".format(**locals())
"hello {name} you are {age} years old".format(name=name, age=age)

这样做：

f"hello {name} you are {age} years old"

这是官方的例子：

>>> 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'

参考：

• Python 3.6 What's New
• PEP 498
• Lexical analysis description

Answer 2

如果格式字符串不是用户提供的，这种用法是可以的。

format 优于使用旧的 % 进行字符串替换。
locals 是 Python 内置的，它的行为将是可靠的。

我认为 locals 完全符合您的需要。
只是不要修改本地人的字典，我会说你有一个很好的解决方案。

如果格式字符串是用户提供的，那么您很容易受到各种不良的注入攻击。

Answer 3

Pre Python 3.6 答案

这已经很老了，但是如果您发现自己使用.format，我在传入**locals 时遇到的一个警告是，如果您没有在任何地方定义该变量，它将中断。在大多数现代 IDE 中，明确说明传入的变量将避免这种情况。

foo = "bar"
"{foo} and {baz} are pair programming".format(**locals())
<exception occurs>