一日一技：字符串Format忽略缺失的字段

2023-02-28

data url resp

在一些大型项目的开发中，我们需要创建很多字符串模板，然后在需要的时候填入对应的信息。例如：复制template_1='缺少参数：{field_name}'template_2='网页请求失败，url:{url}，状态码：{status}，返回信息：{resp}'template_3='其他未知错误：

在一些大型项目的开发中，我们需要创建很多字符串模板，然后在需要的时候填入对应的信息。例如：

template_1 = '缺少参数：{field_name}'
template_2 = '网页请求失败，url: {url}，状态码：{status}，返回信息：{resp}'
template_3 = '其他未知错误：{e}'1.
2.
3.

当我们代码中遇到异常时，用字典的形式，返回格式化字符串所需要的字段，然后在一个专门的函数中统一组装报错信息，例如：

def make_request(url):
    resp = requests.get(url)
    if resp.status != 200:
        err_msg_field = {'url': url, 'status': status, 'resp': resp.text}
        raise RequestFail(err_msg_field=err_msg_field)
    return resp.json()
 
try:
    result = make_request(url)
except RequestFail as e:
    msg = template_2.format(**e.err_msg_field)
    ...用日志或者其他方式输出报错信息...
except Exception as e:
    msg = template_3.format(e=e)1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.

但.format有一个问题：参数中的字段可以比字符串实际需要的多，但不能少。例如：

也可以直接使用字典来传入：

如果字符串模板里面需要某个key，但是.format传入的参数又没有这个key，代码就会报错。

当项目代码规模变大以后，很容易出现传入的字典缺少值的情况。有没有办法让Python在遇到.format参数缺值的时候，自动忽略呢？

如果你使用Python 3，那么可以使用.format_map配合defaultdict来实现：

from collections import defaultdict
template_2 = '网页请求失败，url: {url}，状态码：{status}，返回信息：{resp}'
data = defaultdict(str, {'url': 'https://www.kingname.info', 'status': 500})
msg = template_2.format_map(data)
print(msg)1.
2.
3.
4.
5.

运行效果如下图所示：

如果你使用的是Python 2，那么可以这样写：

from collections import defaultdict
import string
string.Formatter().vformat
template_2 = '网页请求失败，url: {url}，状态码：{status}，返回信息：{resp}'
data = defaultdict(str, {'url': 'https://www.kingname.info', 'status': 500})
msg = string.Formatter().vformat(template_2, (), data)
print msg1.
2.
3.
4.
5.
6.
7.