HOWTO · Python
在 Python 中将字符串转换为变量名
在本文中,我们将讨论在 Python 中将字符串值转换为变量名的各种方法。
本页内容
Python 不会把字符串的值当作普通变量赋值语句左侧的名称来使用。要在运行时创建或访问一个名称,需要选择应该持有它的命名空间:模块级变量用 globals(),检查局部名称用 locals(),执行生成的源代码用 exec(),对象属性用 setattr();而当这些名称本质上是数据时,则应使用字典。
注意:动态变量名会隐藏依赖关系、污染命名空间,并且在代码读取一个从未创建的名称时会抛出
NameError。对于生产环境软件来说,它们很少是最佳选择;除非确实需要一个真正的全局变量或对象属性,否则应优先使用字典。
在 Python 中使用 globals() 和 locals() 将字符串转换为变量名
内置的 globals() 函数返回当前全局符号表对应的字典。该字典将每个全局变量的名称映射到它的值。在模块作用域中,通过这个字典写入一个新的键,就会创建一个以该字符串为名的真正的全局变量。
运行下面的示例:
本节中的代码以及显示的标签或输出仍为英文。
def create_global_variable(name, value):
globals()[name] = value
variable_name = "dynamicGlobalVar"
variable_value = 10
create_global_variable(variable_name, variable_value)
print(dynamicGlobalVar)
10
该函数接收 "dynamicGlobalVar" 作为 name 参数,并把 10 存储到全局符号表中这个键的下面。后面的表达式 dynamicGlobalVar 之所以有效,是因为模块现在拥有了一个同名的全局变量。当源代码要按名称访问该变量时,字符串必须是合法的 Python 标识符;否则应通过 globals()[name] 来检索它。
全局名称必须先创建,然后才能读取。如果事先没有把 dynamicGlobalVar 加入全局符号表,最后一行就会抛出 NameError。在实际代码中,写入时最好使用 variable_name 这样的变量来传值,而不是在程序各处直接嵌入未经检查的字符串。
使用 locals() 访问局部变量
locals() 函数返回表示当前局部符号表的映射。在函数内部,它可以用于查找保存在字符串中的局部名称:
def demonstrate_locals():
temp_var = "Dynamic Content"
name = "temp_var"
return locals().get(name)
print(demonstrate_locals())
Dynamic Content
这里的 locals().get(name) 在函数运行期间解析 "temp_var",并返回已存在的局部变量的值。使用 .get() 比直接对映射取下标更安全,因为当请求的名称不存在时它会返回 None。
不要依赖 locals()[name] = value 来创建函数内的局部变量。Python 实现被允许对局部变量进行优化,对返回映射的写入并不保证会更新解释器真正的局部绑定。应把 locals() 主要当作查找和检查工具;当程序需要一个可写入的动态名称时,请使用 globals()、setattr() 或字典。
在 Python 中使用 exec() 将字符串转换为变量名
exec() 函数执行以字符串形式提供的 Python 源代码。如果该字符串包含一条赋值语句,执行它就会在当前执行上下文中创建相应的变量。
本节中的代码以及显示的标签或输出仍为英文。
variable_name = "dynamicVar"
value = 42
exec(f"{variable_name} = {value}")
print(dynamicVar)
42
这段 f-string 会构建出源文本 dynamicVar = 42,然后由 exec() 执行这条赋值语句。在模块层级,执行结果是得到一个名为 dynamicVar 的新全局变量。当需要插入非数值类型的值时,应使用 repr() 或等效的格式化方式,使生成的源代码中包含合法的 Python 字面量。
exec() 之所以强大,是因为字符串中可以包含的不仅仅是一条赋值语句:它可以执行循环、导入、函数定义或任意调用。但这种强大也正是它最主要的风险。绝对不要把用户可控或其他不可信的文本传给 exec();即使只是一个恶意的名称或值片段,也可能执行有害代码。与 locals() 类似,exec() 也不能保证更新经过优化的函数局部变量,因此这种技术在模块作用域中或显式的命名空间字典里使用最为清晰可靠。
在 Python 中使用 setattr() 将字符串转换为变量名
当所需的"变量"实际上是对象、类或模块上的一个属性时,setattr() 就是直接可用的工具。它接受一个对象、一个字符串形式的属性名,以及要赋予的值。
本节中的代码以及显示的标签或输出仍为英文。
class Settings:
pass
settings = Settings()
attribute_name = "theme"
attribute_value = "dark"
setattr(settings, attribute_name, attribute_value)
print(settings.theme)
dark
这次调用等价于 settings.theme = "dark",只是属性名在运行时来自 attribute_name。它适用于配置对象、记录、插件钩子,以及其他已经在设计中使用命名空间对象的场景。
setattr() 并不会创建普通的模块级或函数级变量;它更新的是目标对象的属性命名空间。可以使用 getattr(settings, attribute_name) 动态读取该值,或者在需要回退值时使用 getattr(settings, attribute_name, default_value)。
在 Python 中使用字典代替动态变量名
当程序需要把值存储在只有运行时才知道的名称下时,字典通常是最清晰的方案。字符串仍然是一个键,因此动态名称的集合保持显式可见,也便于检查。
本节中的代码以及显示的标签或输出仍为英文。
dynamic_vars = {}
var_name = "temperature"
var_value = 23
dynamic_vars[var_name] = var_value
print(dynamic_vars["temperature"])
23
这建立的关联与一个名为 temperature、值为 23 的变量相同,但不会向 Python 命名空间中添加名称。键可以被列出、传给其他函数、序列化或删除,而不需要在 globals() 中搜寻意料之外的条目。
字典键也不受 Python 标识符规则的限制,因此像 "daily total" 这样的名称也可以作为数据使用。可以用 dynamic_vars[var_name] 访问必需的键;如果缺失的键应当产生回退值而不是失败,则使用 dynamic_vars.get(var_name)。这样可以避免处理 NameError,因为程序是在查询一个数据结构,而不是在解析源代码级别的变量。
结论
Python 提供了多种把运行时的字符串变成可用名称的方法。globals() 可以通过全局符号表创建一个真正的模块级变量。locals() 可以查找局部名称,但作为写入机制并不可靠。exec() 可以执行动态生成的赋值语句,不过它带来的安全和可读性风险最大。当动态名称属于某个对象或模块时,setattr() 是合适的选择。
对于大多数程序来说,字典是最安全、最易维护的选择。它把动态名称保留为数据,避免污染 Python 命名空间,并让缺失名称时的行为变得明确。只有当设计确实需要时,才应使用真正的动态变量或属性。