考虑这个类:
class foo(object):
pass
默认的字符串表示形式是这样的:
>>> str(foo)
"<class '__main__.foo'>"
如何使此显示自定义字符串?
参见如何使用print()打印类的实例?有关类实例的相应问题。
事实上,这个问题实际上是那个问题的一个特例——因为在Python中,类本身也是属于它们自己类的对象——但如何应用这个建议并不直接明显,因为默认的“类的类”是预定义的。
考虑这个类:
class foo(object):
pass
默认的字符串表示形式是这样的:
>>> str(foo)
"<class '__main__.foo'>"
如何使此显示自定义字符串?
参见如何使用print()打印类的实例?有关类实例的相应问题。
事实上,这个问题实际上是那个问题的一个特例——因为在Python中,类本身也是属于它们自己类的对象——但如何应用这个建议并不直接明显,因为默认的“类的类”是预定义的。
当前回答
另一个答案是:
装饰 类型(在ide中保持自动补全) 从v3.10起生效
import typing
class ClassReprMeta(type):
def __repr__(self):
attrs_str = ", ".join(
f"{key}={getattr(self, key)}"
for key in dir(self)
if not key.startswith("_")
)
return f"{self.__name__}({attrs_str})"
T = typing.TypeVar("T")
def printable_class(cls: T) -> T:
"""Decorator to make a class object printable"""
return ClassReprMeta(cls.__name__, cls.__bases__, dict(cls.__dict__))
@printable_class
class CONFIG:
FIRST = 1
SECOND = 2
print(CONFIG) # CONFIG(FIRST=1, SECOND=2)
其他回答
Ignacio Vazquez-Abrams认可的答案是非常正确的。然而,它来自Python 2代。当前Python 3的更新如下:
class MC(type):
def __repr__(self):
return 'Wahaha!'
class C(object, metaclass=MC):
pass
print(C)
如果你想让代码在Python 2和Python 3中运行,这六个模块已经涵盖了你:
from __future__ import print_function
from six import with_metaclass
class MC(type):
def __repr__(self):
return 'Wahaha!'
class C(with_metaclass(MC)):
pass
print(C)
最后,如果你有一个类,你想有一个自定义静态repr,上面的基于类的方法很有效。但是,如果您有多个元类,则必须为每个元类生成类似于MC的元类,这可能会很烦人。在这种情况下,更进一步地进行元编程并创建一个元类工厂会让事情变得更清晰:
from __future__ import print_function
from six import with_metaclass
def custom_class_repr(name):
"""
Factory that returns custom metaclass with a class ``__repr__`` that
returns ``name``.
"""
return type('whatever', (type,), {'__repr__': lambda self: name})
class C(with_metaclass(custom_class_repr('Wahaha!'))): pass
class D(with_metaclass(custom_class_repr('Booyah!'))): pass
class E(with_metaclass(custom_class_repr('Gotcha!'))): pass
print(C, D, E)
打印:
Wahaha! Booyah! Gotcha!
元编程并不是你每天都需要的东西——但是当你需要它的时候,它真的很合适!
如果你必须在__repr__或__str__之间选择,请选择第一个,因为默认实现__str__在未定义时调用__repr__。
自定义Vector3示例:
class Vector3(object):
def __init__(self, args):
self.x = args[0]
self.y = args[1]
self.z = args[2]
def __repr__(self):
return "Vector3([{0},{1},{2}])".format(self.x, self.y, self.z)
def __str__(self):
return "x: {0}, y: {1}, z: {2}".format(self.x, self.y, self.z)
在这个例子中,repr再次返回一个可以直接使用/执行的字符串,而str作为调试输出更有用。
v = Vector3([1,2,3])
print repr(v) #Vector3([1,2,3])
print str(v) #x:1, y:2, z:3
在类的元类中实现__str__()或__repr__()。
class MC(type):
def __repr__(self):
return 'Wahaha!'
class C(object):
__metaclass__ = MC
print(C)
使用__str__如果你指的是可读的字符串,使用__repr__表示明确的表示。
编辑:Python 3版本
class MC(type):
def __repr__(self):
return 'Wahaha!'
class C(object, metaclass=MC):
pass
print(C)
另一个答案是:
装饰 类型(在ide中保持自动补全) 从v3.10起生效
import typing
class ClassReprMeta(type):
def __repr__(self):
attrs_str = ", ".join(
f"{key}={getattr(self, key)}"
for key in dir(self)
if not key.startswith("_")
)
return f"{self.__name__}({attrs_str})"
T = typing.TypeVar("T")
def printable_class(cls: T) -> T:
"""Decorator to make a class object printable"""
return ClassReprMeta(cls.__name__, cls.__bases__, dict(cls.__dict__))
@printable_class
class CONFIG:
FIRST = 1
SECOND = 2
print(CONFIG) # CONFIG(FIRST=1, SECOND=2)
因为你需要一个元类来做这件事,但是你需要元类本身有一个参数,你可以用一个元类来通过词法作用域捕获名字。
我发现这比一些替代方案更容易阅读/遵循。
class type_: pass
def create_type(name):
# we do this so that we can print the class type out
# otherwise we must instantiate it to get a proper print out
class type_metaclass(type):
def __repr__(self):
return f'<{name}>'
class actual_type(type_, metaclass=type_metaclass):
pass
return actual_type
my_type = create_type('my_type')
print(my_type)
# prints "<my_type>"