当一个类的对象在没有任何括号的情况下输入和运行时,它如何打印在 Python REPL 或 Jupyter Notebook 中

问题描述

背景:我正在 jupyter 笔记本中使用 SymPy 模块。我想创建 sympy Matrix 类的子/子类(实际上是 sympy.matrices.dense.MutableDenseMatrix)。

我写这个=>

import sympy as sym
class Mat(sym.Matrix):
  def __init__(self,a):
    self.a = super(a)

然后我在单独的单元格中调用以下内容

X=Mat([[1,2,3]])

这是一个错误

TypeError                                 
Traceback (most recent call last)
<ipython-input-154-9d0dfad5081f> in <module>
----> 1 X= Mat([[1,3]])

<ipython-input-153-41d7b2cc4dd1> in __init__(self,a)
      1 class Mat(sym.Matrix):
      2     def __init__(self,a):
----> 3         self.a = super(a)

TypeError: super() argument 1 must be type,not list

不知道原因我试过这个

class Mat:
    def __init__(self,a):
        self.a = sym.Matrix(a)

那么任务就通过了。

现在我单独在 Next Cell 中运行它(为了简单起见,这就像执行 Name

X

并得到输出

<__main__.Mat at 0x7f80b77f8b80>

但我在期待

[1 2 3]

Matrix([[1,3]])

这些是当我创建一个常规的 sym.Matrix 对象并执行它时分别出现在 Jupyter Notebook 和 Python REPL 中的输出 Name

注意:我知道 __str____repr__ 的存在,但只有当我使用 print(X)

注意:我尝试将 __call__ 定义为

def __call__(self):
  return self.a

但只有当我先执行 X=X()后执行 X

所以我的问题是,在执行对象 Name调用的内部方法(可能是魔法方法)是什么,以及如何为我的类定义它,如果将来我创建一个没有继承的类(所以我不必回退到相同的超类方法

解决方法

通过查看 at the doc 我们有:

在 Python 中,对象可以使用 _repr_ 方法。 IPython 扩展了这个想法,并允许对象声明其他丰富的表示形式,包括:

_repr_html_:以字符串或元组形式返回原始 HTML(见下文)。

_repr_json_:返回一个 JSONable dict 或一个元组(见下文)。

_repr_jpeg_:返回原始 JPEG 数据或元组(见下文)。

_repr_png_:返回原始 PNG 数据或元组(见下文)。

_repr_svg_:以字符串或元组形式返回原始 SVG 数据(见下文)。

_repr_latex_:以“$”或元组(见下文)包围的字符串形式返回 LaTeX 命令。

_repr_mimebundle_:返回包含映射的完整 mimebundle

作为附加 this SO question 似乎是相关的。

一个工作片段应该是这样的:

import sympy as sym
class Mat(sym.Matrix):
  def __init__(self,a):
    self.a = sym.Matrix(a)
  def _repr_html_(self):
        return f"<p><h1>{self.a.__repr__()}</h1></p>"

这会导致类似的输出: enter image description here