Python str.format_map() 字符格式映射

str.format_map() 是 Python 中字符串格式化的一种方法。它是在字符串上调用的方法，用于使用映射对象来格式化字符串。这个方法的主要目的是替换字符串中的占位符，这些占位符由映射对象提供。

示例

让我们来看一个简单的例子：

# 定义一个字典作为映射对象
person = {'name': 'John', 'age': 30}

# 使用 format_map() 格式化字符串
"My name is {name} and I am {age} years old.".format_map(person)
# 打印结果
# My name is John and I am 30 years old.

在这个例子中，format_map() 方法用字典 person 中的键值对替换了字符串中的占位符 {name} 和 {age}。

这里的映射对象可以是任何实现了 __getitem__ 方法的对象，比如字典、自定义类等。format_map() 方法会根据映射对象中的键来查找对应的值，并替换字符串中的占位符。

需要注意的是，如果字符串中包含未在映射对象中找到的占位符，会引发 KeyError。为了避免这种情况，可以使用 str.format() 方法，它允许在格式字符串中使用多个参数，并且不会引发 KeyError。

# 使用 str.format() 方法
"My name is {} and I am {} years old.".format(person['name'], person['age'])

总的来说，str.format_map() 提供了一种通过映射对象来格式化字符串的便捷方法，尤其适用于需要根据动态数据生成格式化字符串的情况。

语法

类似于 str.format(**mapping)，不同之处在于 mapping 会被直接使用而不是复制到一个 dict。 适宜使用此方法的一个例子是当 mapping 为 dict 的子类的情况：

class Default(dict):
    def __missing__(self, key):
        return key

'{name} was born in {country}'.format_map(Default(name='Guido'))
# 'Guido was born in country'

这是 3.2 新版功能。

区别

str.format() 和 str.format_map() 都是用于格式化字符串的方法，它们之间的主要区别在于提供格式化信息的方式和对缺失键的处理。

提供格式化信息的方式

str.format()： 使用位置参数或关键字参数来提供格式化信息。在格式字符串中使用占位符 {}，然后通过 str.format() 方法中的参数替换这些占位符。

name = 'John'
age = 30
"My name is {} and I am {} years old.".format(name, age)

str.format_map()： 使用一个映射对象来提供格式化信息。在格式字符串中使用占位符 {key}，然后通过 format_map() 方法中的映射对象替换这些占位符。

person = {'name': 'John', 'age': 30}
"My name is {name} and I am {age} years old.".format_map(person)

对缺失键的处理

str.format()： 如果在格式化字符串中的占位符找不到对应的参数，会引发 IndexError 或 KeyError，具体取决于是使用位置参数还是关键字参数。

# 位置参数
"My name is {} and I am {} years old.".format(name)
# 会引发 IndexError
# 关键字参数
sentence = "My name is {name} and I am {age} years old.".format(name=name, height=175)
# 会引发 KeyError

str.format_map()： 如果在映射对象中找不到对应的键，不会引发错误，而是保留占位符未替换。

person = {'name': 'John'}
"My name is {name} and I am {age} years old.".format_map(person)
# 不会引发错误，输出结果中 {age} 保留未替换

总体来说，str.format() 更灵活，可以通过位置参数或关键字参数提供格式化信息，但在缺失参数时可能会引发错误。而 str.format_map() 则更适用于通过映射对象提供格式化信息的情况，且对于缺失键的处理更宽容。选择使用哪个方法取决于具体的使用场景和需求。

参考

• https://docs.python.org/zh-cn/3/library/stdtypes.html#str.format_map

更新时间：2023-11-30 09:28:08 标签：python 字符 格式 映射