0%

Python:f-string 格式化对象

一个对象在默认情况下,通过 f"{my_color}" 格式化输出,可能会得到这样的字符串
<f-string-demo.Color object at 0x000002DF77D14CB0>——默认的 __format__() 方法返回。

f-string 的完整格式是:

1
f ' <text> { <expression> <optional !s, !r, or !a> <optional : format specifier> } <text> ... '

除去需要格式化的表达式本身,花括号中还包含两项可选内容:转换标志符和格式说明符(Format Specifier)。

  • 转换标志符(3个), !s!r!a
  • 格式说明符,: 后的部分,指定如何格式化变量的值

下面我们讨论格式化一个对象时的行为。

使用转换标志符等价或近似于调用该对象的某个方法。

  • !s <=> __str__()
  • !r <=> __repr__()
  • !a 要复杂一点,近似于调用 ascii(object.__repr__())

格式说明符是整体作为参数 format_spec 传给对象的 __format__() 方法的。这需要自行定义该方法以解析格式说明符,否则 __format__() 默认调用 __repr__()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
import unittest  


class MyTestCase(unittest.TestCase):
@staticmethod
def test_r():
my_color = Color(199, 237, 204)
print(f"{my_color!r}") # 调用 __repr__()
print(f"{my_color!s}") # 调用 __str__()
print(f"{my_color!a}") # 调用 __repr__(),将非 ASCII 字符转义为 ASCII 转义序列
print(ascii(my_color.__repr__())) # 跟 !a 有差异,结果会用引号括起来
print(f"{my_color}") # 调用 __format__(),默认分支
print(f"{my_color:web}") # 调用 __format__(),format_spec == web 分支


class Color:
def __init__(self, red: int = 255, green: int = 255, blue: int = 255):
self.red = red
self.green = green
self.blue = blue

def __repr__(self):
return f"红: {self.red}, 绿: {self.green}, 蓝: {self.blue}"

def __str__(self):
return f"({self.red}, {self.green}, {self.blue})"

def __format__(self, format_spec):
if format_spec == "web":
return f"#{self.red:02X}{self.green:02X}{self.blue:02X}"
else:
return f"Red: {self.red}, Green: {self.green}, Blue: {self.blue}"


if __name__ == '__main__':
unittest.main()