自定义SageMath现有数据类型的漂亮打印输出

理解SageMath的漂亮打印机制

在IPython环境中，用户通常可以通过 get_ipython().display_formatter.formatters["text/plain"].for_type() 方法来定制对象的打印输出。然而，在SageMath中，直接使用这种方法对现有类型（如 ast.AST）可能无效。此外，对于自定义类，虽然可以通过定义 _repr_ (针对 SageObject 子类) 或 __repr__ 方法来实现定制，但对于许多SageMath内置的、不可变的复杂数据类型，直接修改其 __repr__ 属性会引发 TypeError，例如尝试修改 sage.rings.complex_interval.ComplexIntervalFieldElement 的 __repr__。

为了有效定制SageMath的打印行为，我们需要深入了解其内部的漂亮打印流程。SageMath的打印机制涉及多个组件的协作：

1. SageDisplayFormatter.format() 方法。
2. DisplayManager.displayhook() 方法。
3. DisplayManager._rich_output_formatter() 方法。
4. BackendIPythonCommandline.plain_text_formatter() 方法（在对象没有 _rich_repr_ 方法时使用，并指定 SagePrettyPrinter）。
5. BackendBase._apply_pretty_printer() 方法。
6. 创建 pretty_printer_class (通常是 SagePrettyPrinter) 的实例，并调用其 .pretty() 方法。
7. SagePrettyPrinter.pretty() 方法会遍历其内部的 pretty_repr 列表。
8. SomeIPythonRepr.__call__() 方法最终通过查找 self._type_repr 字典来获取特定类型的打印函数。

因此，定制现有SageMath类型漂亮打印的关键在于修改 SomeIPythonRepr 实例内部的 _type_repr 字典。

定制现有类型的打印输出

要自定义SageMath中现有类型的漂亮打印，我们需要找到负责该类型打印的 SomeIPythonRepr 实例，并修改其内部的 _type_repr 字典。

以下是具体步骤和示例：

1. 导入必要的模块： 首先，导入 SagePrettyPrinter 和 SomeIPythonRepr。

   from sage.repl.display.pretty_print import SagePrettyPrinter
   from sage.repl.display.fancy_repr import SomeIPythonRepr
   import ast

   登录后复制

2. 获取 SomeIPythonRepr 实例：SagePrettyPrinter.pretty_repr 是一个列表，其中包含了多个漂亮的打印器实例。我们需要找到其中类型为 SomeIPythonRepr 的实例。

   someIPythonReprInstance = next(x for x in SagePrettyPrinter.pretty_repr
                                  if isinstance(x, SomeIPythonRepr))

   登录后复制

3. 修改 _type_repr 字典：someIPythonReprInstance._type_repr 是一个字典，其键是类型，值是对应的打印函数。我们可以为目标类型添加或覆盖一个打印函数。

   重要提示： 与标准IPython不同，SageMath的这个机制在查找打印函数时不会遍历对象的MRO（方法解析顺序）。这意味着如果你想为 ast.AST 的子类（如 ast.Module）定制打印，你需要直接指定 ast.Module 而不是 ast.AST。

   

   可图大模型

   可图大模型（Kolors）是快手大模型团队自研打造的文生图AI大模型

   32

   查看详情

   someIPythonReprInstance._type_repr[ast.Module] = lambda o, p, cycle: p.text("??")

   登录后复制

   现在，当我们打印 ast.Module 类型的对象时，它将显示为 ??：

   x = ast.parse('1+2')
   print(x)
   # 输出: ??

   登录后复制

进阶示例：定制代数数（AlgebraicNumber）的打印

我们可以编写更复杂的打印函数，以提供更丰富的对象信息。例如，为 AlgebraicNumber 类型定制打印，使其在输出时显示其最小多项式。

from sage.rings.qqbar import AlgebraicNumber, QQbar
from sage.repl.display.pretty_print import SagePrettyPrinter
from sage.repl.display.fancy_repr import SomeIPythonRepr
from sage.rings.rational_field import QQ # 用于判断是否为有理数
from math import sqrt

# 获取 SomeIPythonRepr 实例
someIPythonReprInstance = next(x for x in SagePrettyPrinter.pretty_repr
                               if isinstance(x, SomeIPythonRepr))

# 定义自定义的打印函数
def printAlgebraicNumber(o: AlgebraicNumber, p: SagePrettyPrinter, cycle: bool) -> None:
    # 确保对象是精确的，以便获取正确的repr和最小多项式
    o.exactify()
    p.text(repr(o)) # 打印对象的标准表示
    if o not in QQ: # 如果不是有理数，则打印其最小多项式
        p.text(' (minpoly = ')
        p.pretty(o.minpoly()) # 使用漂亮打印器打印最小多项式
        p.text(')')

# 将自定义函数注册到 AlgebraicNumber 类型
someIPythonReprInstance._type_repr[AlgebraicNumber] = printAlgebraicNumber

# 测试效果
alpha = QQbar(sqrt(2))
print(alpha)
# 输出: 1.414213562373095? (minpoly = x^2 - 2)

在这个示例中，我们定义了一个 printAlgebraicNumber 函数，它接收对象 o、漂亮打印器 p 和循环标志 cycle。函数内部首先调用 o.exactify() 确保代数数是精确形式，然后打印其标准 repr。如果该代数数不是有理数，则进一步打印其最小多项式。

性能考量： 需要注意的是，自定义打印函数可能会引入性能开销。例如，在 printAlgebraicNumber 示例中，每次打印 AlgebraicNumber 实例时都会调用 o.exactify() 和 o.minpoly()。对于大量对象的打印，这可能会导致性能下降。在设计自定义打印函数时，应权衡信息丰富度与计算成本。

调试技巧

如果自定义打印没有按预期工作，可以使用 SagePrettyPrinter.DEBUG=True 来开启调试模式，查看哪个漂亮打印器正在被使用，或者是否根本没有使用漂亮打印器。

from sage.repl.display.pretty_print import SagePrettyPrinter
SagePrettyPrinter.DEBUG = True
# 再次尝试打印，观察控制台输出的调试信息

其他有用工具

在处理SageMath的显示和打印时，以下对象可能也会有所帮助：

• get_ipython().display_formatter: 返回 SageDisplayFormatter 实例。
• sage.repl.rich_output.get_display_manager(): 返回 DisplayManager 单例实例，等价于 get_ipython().display_formatter.dm。

总结

通过直接修改 SomeIPythonRepr._type_repr 字典，SageMath用户可以克服标准Python和IPython方法在定制现有、尤其是不可变数据类型打印输出时的限制。这种方法提供了强大的灵活性，允许用户为特定类型定义高度定制化的打印逻辑，从而提升交互式会话和文档生成的清晰度。然而，在实现自定义打印函数时，务必注意其潜在的性能影响，并利用调试工具来解决可能出现的问题。

以上就是自定义SageMath现有数据类型的漂亮打印输出的详细内容，更多请关注php中文网其它相关文章！