Python 中更改类的字符串表示形式
使用 __str__() 方法更改类的字符串表示形式。 __str__() 方法由 str(object) 和内置的 format() 和 print() 函数调用，并返回对象的非正式字符串表示形式。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __str__(self):
return f'Employee name: {self.name}'
emp = Employee('Alice', 100)
print(emp) # 👉️ Employee name: Alice
我们在类上定义了 __str__() 方法来改变它的字符串表示。
__str__()方法由str(object)和内置的format()和print()函数调用，并返回对象的非正式字符串表示形式。
print() 函数返回 __str__() 方法的输出。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __str__(self):
return f'Employee name: {self.name}'
emp = Employee('Alice', 100)
print(emp) # 👉️ Employee name: Alice
确保从 __str__() 方法返回一个字符串，否则会引发 TypeError。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __str__(self):
# 👇️ returned integer but must be string
return self.salary
emp = Employee('Alice', 100)
# ⛔️ TypeError: __str__ returned non-string (type int)
print(emp)
如果需要返回整数，请使用 str() 类将其转换为字符串。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __str__(self):
# 👇️ convert integer to string
return str(self.salary)
emp = Employee('Alice', 100)
print(emp) # 👉️ 100
如果我们在格式化字符串文字中或使用 str.format() 方法使用对象，则会调用 __str__() 方法。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __str__(self):
return str(self.salary)
emp = Employee('Alice', 100)
result = f'Salary: {emp}'
print(result) # 👉️ Salary: 100
__str__() 方法应返回一个字符串，该字符串是对象的人类可读表示形式。
还有一个 __repr__() 方法可以以类似的方式使用。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __repr__(self):
return self.name
emp = Employee('Alice', 100)
print(emp) # 👉️ Alice
print(repr(emp)) # 👉️ Alice
__repr__方法由repr()函数调用，通常用于获取可用于使用eval()函数重建对象的字符串。
如果该类没有定义 __str__() 方法，但定义了 __repr__() ，则使用 __repr__() 的输出。
class Employee():
def __init__(self, name, salary):
self.name = name
self.salary = salary
def __repr__(self):
return self.name
emp = Employee('Alice', 100)
result = f'Employee name: {emp}'
print(result) # 👉️ Employee name: Alice
说明 __str__() 和 __repr__() 之间区别的一个好方法是使用 datetime 模块。
import datetime
# 👇️ using __str__()
print(datetime.datetime.now()) # 👉️ 2022-09-04 16:47:40.839871
# 👇️ using __repr__()
# 👉️ datetime.datetime(2022, 9, 4, 16, 47, 57, 981219)
print(repr(datetime.datetime.now()))
result = eval('datetime.datetime(2022, 9, 4, 16, 47, 57, 981219)')
print(result) # 👉️ 2022-09-04 16:47:57.981219
当我们使用 print() 函数时，datetime 类中的 __str__() 方法被调用并返回日期和时间的人类可读表示。
当我们使用
repr()函数时，类的__repr__()方法被调用并返回一个字符串，该字符串可用于重新创建对象的相同状态。
我们将字符串传递给 eval() 函数并创建了一个具有相同状态的日期时间对象。
请注意，以这种方式实现__repr__()方法并不总是必要或可能的。
大多数时候让 __str__() 方法返回一个人类可读的字符串就足够了。
