Question

Python有一台漂亮的打印机（pprint(...)）。我想让我的课程相当可打印。如果我提供某个界面，那么漂亮的打印会以更好的方式打印我的实例吗？

8.11部分中的Python文档显示了不同的示例，但没有示例如何使用户定义的类具有可打印性。

那么我的课程需要提供哪种界面？
还有其他（可能更好的）格式化程序吗？

使用案例

我想打印ConfigParser的内容，为此我创建了一个名为ExtendenConfigParser的扩展版本。所以我可以添加更多功能或添加匹配的漂亮打印界面。

Answer 1

pprint不寻找任何钩子。 pprint.PrettyPrinter使用调度模式代替;关于类class.__repr__引用的一系列方法。

您可以继承pprint.PrettyPrinter来教授您的课程：

class YourPrettyPrinter(pprint.PrettyPrinter):
    _dispatch = pprint.PrettyPrinter.copy()

    def _pprint_yourtype(self, object, stream, indent, allowance, context, level):
        stream.write('YourType(')
        self._format(object.foo, stream, indent, allowance + 1,
                     context, level)
        self._format(object.bar, stream, indent, allowance + 1,
                     context, level)
        stream.write(')')

    _dispatch[YourType.__repr__] = _pprint_yourtype

然后直接使用该类来打印包含YourType个实例的数据。请注意，这取决于具有自己的自定义__repr__方法的类型！

您还可以将函数直接插入PrettyPrinter._dispatch字典; self已明确传入。这可能是第三方库的更好选择：

from pprint import PrettyPrinter

if isinstance(getattr(PrettyPrinter, '_dispatch'), dict):
     # assume the dispatch table method still works
     def pprint_ExtendedConfigParser(printer, object, stream, indent, allowance, context, level):
         # pretty print it!
     PrettyPrinter._dispactch[ExtendedConfigParser.__repr__] = pprint_ExtendedConfigParser

请参阅pprint module source code了解其他调度方法的编写方式。

与往常一样，像_dispatch这样的单下划线名称是内部实现细节，可以在将来的版本中进行更改。但是，这是你在这里的最佳选择。

Answer 2

如果您要全力以赴，不妨超类 pprint 以接受一个钩子，那么您只需编写一次所有代码。

在您使用 pp = pprint.PrettyPrinter(indent=4).pprint 实例化 pprint 帮助程序之后定义类的情况下，它也会更好地工作（我的一个坏习惯）。

然后您可以使用这些方法之一选择加入任何课程[双关语]

[编辑]：经过一些自我使用后，我发现了一个更简单的替代解决方案， __pprint_repr__。与其尝试创建自己的 pprint 函数，只需定义 __pprint_repr__ 方法并返回一个标准的 Python 对象。如果您有一个复杂的类，您可以将多个对象分组到一个 dict 中。

[edit #2]：我还意识到将所有 _format 变量传递给 __pprint_repr__ 函数会很有用，因为这可以让你做非常酷的事情——比如 show如果您的项目在列表中（缩进 > 0），则为压缩输出，如果它是唯一的对象（缩进 == 0），则为完整输出

这也意味着该解决方案兼容 Python 2.7，而不仅仅是 Python ~> 3.3

class my_object(object):

    # produce pprint compatible object, easy as pie!
    def __pprint_repr__(self, **kwargs):
        return self.__dict__
    
    # make a multi-level object, easy as cheese-cake!
    def __pprint_repr__(self, **kwargs):
        _indent = kwargs['indent']
        if _indent:
            return self._toText()
        return { self._toText(): self.__dict__ }

    # to take total control (python 3) (requires __repr__ be defined)
    def __pprint__(self, object, stream, indent, allowance, context, level):
        stream.write('my_object(\n')
        self._format(object._data, stream, indent, allowance + 1, context, level)
        stream.write(')')
        pass

子类化本身很简单——在 Python 3.7 和 2.7 中测试过：

        if _pprint_repr:
            return PrettyPrinter._format(self, _pprint_repr(object, stream=stream, 
                indent=indent, allowance=allowance, context=context, level=level), 
                    stream, indent, allowance, context, level)

        # else check for alternate _pprint method (if supported ~ python 3.3)
        if getattr(PrettyPrinter, '_dispatch', None):
            _repr = type(object).__repr__
            _pprint = getattr(type(object), '__pprint__', None)
            _exists = self._dispatch.get(_repr, None)
            if not _exists and _pprint:
                self._dispatch[_repr] = _pprint

        return PrettyPrinter._format(self, object, stream, indent, allowance, context, level)

Answer 3

Martijn Pieters的子类解决方案为我工作，并且通过不对foo和bar进行硬编码，使它变得更通用。

外卖：

    self._format(object.foo, stream, indent, allowance + 1,
                 context, level)
    self._format(object.bar, stream, indent, allowance + 1,
                 context, level)

替换（输入）：

    for s in vars(object):
        stream.write( '\n%s: ' % s )
        self._format( object.__dict__[s],
                      stream, indent, allowance + 1, context, level )

Answer 4

这并不是真正的解决方案，但是我通常只是使对象可序列化，并像这样漂亮地打印它们：

pprint(obj.dict())

如何让我的类在Python中可打印？

4 个答案: