出力

SymPy オブジェクトを表現するいろいろな方法について記す。

Note

本文中のすべての IPython セッション中のサンプルコードで、以下のインポートおよび出力書式設定が済んでいるものとする。

from sympy import cos, sin
from sympy.printing import *

Pretty Print

大げさに言えば、オブジェクトをアスキーアートとして出力する一連の仕組みだ。先に要点を挙げる：

• 個人的に SymPy のこれは肌に合わないので、常に無効にしておきたい。 IPython コンソールのセッションでオブジェクトの出力がアスキーアート化されているようならば、 init_printing(pretty_print=False) を実行することで、即時に無効化できる。

• 明示的にアスキーアートを出力するには関数 pretty_print を呼び出す。

• 関数 pretty_print には別名 pprint が定義されているので、コンソール上の作業時には別名のほうを主にタイプするはずだ。

• この機能に頼るぐらいならば、IPython ではなく Jupyter で作業するだろう。そちらは最初から LaTeX 出力がオンになっているはずだ。

LaTeX

オブジェクトを TeX コードとして出力するときの要点を挙げると次のようなものになるだろう：

• 関数 latex または print_latex を呼び出すとオブジェクトを表現する TeX コードを得ることができる。

• 関数 latex または print_latex の挙動を調整するための fold_func_brackets, mat_str, mat_delim などのキーワード引数があるので、これを上手に使う。

• ただし過信はできない。出力結果を何かの文書に流用するのであれば、最終的にはテキストエディターで細部を手動編集することになる。

オブジェクトを TeX 形式の文字列に変換するには関数 latex を用いる。ただし、それを標準出力等に出力するには関数 print_latex を使うのがタイプ量の点でわずかに楽だ。

両者の引数リストは同一だ。そのキーワード引数の中で有用なものをいくつか記す。

• fold_func_brackets=True を指定すると、数学関数呼び出しのカッコを可能な限り省略する。例えば三角関数を多く含む式に対して適用すると効果がわかりやすい：

  In [1]: from sympy import cos, sin
  
  In [2]: from sympy.abc import x
  
  In [3]: f = sin(x)**2 + cos(x)**2
  
  In [4]: print_latex(f)
  \sin^{2}{\left (x \right )} + \cos^{2}{\left (x \right )}
  
  In [4]: print_latex(f, fold_func_brackets=True)
  \sin^{2} {x} + \cos^{2} {x}
  

  個人的にはまだ中括弧を削れるとは思うのだが、実用には耐える。

• mat_str は行列の環境名を指定するキーワード引数だ。例えば mat_str=pmatrix を指定すると、式に含まれる行列に対応する TeX コードが \begin{pmatrix} と \end{pmatrix} で囲まれるようになる。ただしその場合には行列のカッコを SymPy が別途補うので、さらに mat_delim キーワード引数を空文字列等に指定することでそれを無効化する。

  In [1]: from sympy import Matrix
  
  In [2]: A = Matrix([[1, 2], [3, 4]]); A
  Out[2]:
  Matrix([
  [1, 2],
  [3, 4]])
  
  In [3]: print_latex(A)
  \left[\begin{matrix}1 & 2\\3 & 4\end{matrix}\right]
  
  In [4]: print_latex(A, mat_str='pmatrix')
  \left[\begin{pmatrix}1 & 2\\3 & 4\end{pmatrix}\right]
  
  In [5]: print_latex(A, mat_str='pmatrix', mat_delim=None)
  \begin{pmatrix}1 & 2\\3 & 4\end{pmatrix}
  

  [4] と [5] の MathJax によるレンダリングを次に示す（画像上の右クリックメニュー Show Math As ‣ Tex Commands でソース TeX コードが確認できる）：

  \[\begin{split}\left[\begin{pmatrix}1 & 2\\3 & 4\end{pmatrix}\right]\end{split}\]
  \[\begin{split}\begin{pmatrix}1 & 2\\3 & 4\end{pmatrix}\end{split}\]

実際には print_latex の出力結果をそのままコピー＆ペーストして済むということはほとんどないだろう。テキストエディターに出力結果テキストを展開して、手動で括弧を間引いたり、スペースを補ったり、コマンドを一部自作のマクロに置き換えたりすることになる。

LatexPrinter をカスタマイズする

ここでは 関数 latex による SymPy オブジェクトの一部の出力文字列を変更する方法を記す。例を挙げる。外微分周りの表示で以下の二点を目的としたカスタマイズ手順を説明する。

• 座標成分が太字になるのを回避したい。

• 外微分演算子を自作のマクロに置き換えたい。

ここでは正攻法とはとても言えない方法を採っている。いずれ改良案を考えたい。

1. 必要なクラスをインポートする。

   from sympy.printing import (latex, print_latex)
   from sympy.printing.latex import LatexPrinter
   

2. 対応する SymPy オブジェクトの型に従い、カスタムメソッドを実装する。

   今回の例だと対象となるのは BaseScalerField と Differential だ。このときは名前が _print_BaseScalarField および _print_Differential というメソッドを適当なスコープで実装する。

   コード例を以下に示す：

   def _print_BaseScalarField(self, field):
       string = field._coord_sys._names[field._index]
       return f'{self._print(Symbol(string))}'
   
   def _print_Differential(self, diff):
       field = diff._form_field
       if hasattr(field, '_coord_sys'):
           string = field._coord_sys._names[field._index]
           return rf'\dd {self._print(Symbol(string))}'
       else:
           return rf'\dd({self._print(field)})'
   

   実装の必要に応じてインポート文を追加する（この場合は Symbol を含める）。実装例は LatexPrinter のソースコードを手本にすればよい。

   一般にクラス CLASSNAME の LaTeX 出力を書き換える場合にはメソッド _print_CLASSNAME を実装する。

3. LatexPrinter 本来のメソッドをカスタムメソッドで置き換える。

   Python 組み込み関数 setattr を活用する：

   for m in (_print_BaseScalarField, _print_Differential):
       setattr(LatexPrinter, m.__name__, m)
   

ここまでできれば、既定の latex や print_latex をそのまま呼び出すことで、カスタムメソッドが SymPy の出力システムから呼び出される。

オブジェクト指向プログラミング言語のライブラリー設計だと、何か set_latex_printer のようなインターフェイスが存在して、そこに LatexPrinter のサブクラスを設定できて然るべきなのだが、LatexPrinter に関してはそのようなものは提供されていない。

なお、正攻法で行くのならば、LatexPrinter をサブクラスして、自分用の関数 latex と print_latex を実装するのが妥当と思われる。

実装例

これまでに説明してきた方法を一つにまとめたスクリプトおよびその実行結果を以下に示す。

from sympy import (symbols, Symbol)
from sympy.printing import (latex, print_latex)
from sympy.printing.latex import LatexPrinter
from sympy.diffgeom import Differential
from sympy.diffgeom.rn import R3_r

def _print_BaseScalarField(self, field):
    string = field._coord_sys._names[field._index]
    return f'{self._print(Symbol(string))}'

def _print_Differential(self, diff):
    field = diff._form_field
    if hasattr(field, '_coord_sys'):
        string = field._coord_sys._names[field._index]
        return rf'\dd {self._print(Symbol(string))}'
    else:
        return rf'\dd({self._print(field)})'

for m in (_print_BaseScalarField, _print_Differential):
    setattr(LatexPrinter, m.__name__, m)

def main():
    a, b, c = symbols('a b c', real=True)
    x, y, z = R3_r.coord_functions()
    dx, dy, dz = R3_r.base_oneforms()
    ex, ey, ez = R3_r.base_vectors()

    fx = a* x * y * z
    fy = b * x ** 2 * z
    fz = -3 * x**2 * y
    omega = fx * dx + fy * dy + fz * dz
    print_latex(omega)

    domega = Differential(omega)
    print_latex(domega)

    print_latex(domega(ey, ez)) # for WedgeProduct(dy, dz)
    print_latex(domega(ez, ex)) # for WedgeProduct(dz, dx)
    print_latex(domega(ex, ey)) # for WedgeProduct(dx, dy)

if __name__ == '__main__':
    main()

このコードの途中の 2 行をコメントアウトすることによって得られる出力は次のようなものだが:

- 3 \boldsymbol{\mathrm{x}}^{2} \boldsymbol{\mathrm{y}} \mathrm{d}z + \boldsymbol{\mathrm{x}}^{2} \boldsymbol{\mathrm{z}} b \mathrm{d}y + \boldsymbol{\mathrm{x}} \boldsymbol{\mathrm{y}} \boldsymbol{\mathrm{z}} a \mathrm{d}x
d(- 3 \boldsymbol{\mathrm{x}}^{2} \boldsymbol{\mathrm{y}} \mathrm{d}z + \boldsymbol{\mathrm{x}}^{2} \boldsymbol{\mathrm{z}} b \mathrm{d}y + \boldsymbol{\mathrm{x}} \boldsymbol{\mathrm{y}} \boldsymbol{\mathrm{z}} a \mathrm{d}x)
- \boldsymbol{\mathrm{x}}^{2} b - 3 \boldsymbol{\mathrm{x}}^{2}
\boldsymbol{\mathrm{x}} \boldsymbol{\mathrm{y}} a + 6 \boldsymbol{\mathrm{x}} \boldsymbol{\mathrm{y}}
- \boldsymbol{\mathrm{x}} \boldsymbol{\mathrm{z}} a + 2 \boldsymbol{\mathrm{x}} \boldsymbol{\mathrm{z}} b

カスタム版を適用した出力は次のようになる:

- 3 x^{2} y \dd z + x^{2} z b \dd y + x y z a \dd x
\dd(- 3 x^{2} y \dd z + x^{2} z b \dd y + x y z a \dd x)
- x^{2} b - 3 x^{2}
x y a + 6 x y
- x z a + 2 x z b

画像出力

オブジェクトを文字列として出力する以外に、画像として出力する方法もある。関数 preview はそのような画像生成と出力の両方を行なうことができる。

詳細はモジュール sympy.printing.preview のコードを確認するといい。プロセス生成の手順は理解しやすい。

PNG 出力

キーワード引数 output=png を指定するか、あるいはこのキーワード引数を省略すると、 SymPy オブジェクトに相当する数式が描画された PNG 画像を生成して適当なビューワープログラムでそれを表示する。

• Pyglet パッケージが動作環境にない場合には、呼び出し側が明示的にキーワード引数 viewer を追加で指定する必要がある。

  例えば Windows 上での実行において「ペイント」を起動させるには次のようにする：

  In [1]: preview(cos(x)**2 + sin**2(x), viewer='mspaint')
  

  このようにすると、対応する数式が描かれている PNG ファイルを開いた状態の「ペイント」ウィンドウがデスクトップに現れる。

• 数式が描画された PNG 画像をファイルに保存することもできる。キーワード引数 viewer='file' に加えて、キーワード引数 filename を指定し、保存先のファイルパスを指定する必要がある：

  In [2]: preview(cos(x)**2 + sin(x)**2, viewer='file', filename='preview.png')
  

• また、画像をメモリに保存する機能もある。これには BytesIO オブジェクトをあらかじめ生成しておき、キーワード引数 viewer='BytesIO' に加えてキーワード引数 outputbuffer を指定し、そのオブジェクトをその引数に設定する必要がある。利用予定がないので詳細を割愛する。

DVI 出力

関数 preview にキーワード引数 output='dvi' を指定することで、出力データの形式が DVI となる。PNG のときと同様に、閲覧プログラムを実行させたり、データをファイルに保存させたりできる。

ちなみにここでの LaTeX 環境は TeX Live であり、環境変数 PATH には dviout 等の実行形式格納フォルダーのパスが含まれている。

In [1]: preview(cos(x)**2 + sin(x)**2, output='dvi', viewer='dviout')

In [2]: preview(cos(x)**2 + sin(x)**2, output='dvi', viewer='file', filename='preview.dvi')

PDF 出力

関数 preview にキーワード引数 output='pdf' を指定することで、出力データの形式が PDF となる。

キーワード引数 output='pdf' を指定すると、次のコマンドラインを実行することと同等の処理が入る。 TeX Live では dvipdf が存在しないためにこれが通じず、実行時エラーを引き起こす。

bash$ dvipdf texput.dvi texput.pdf

SymPy のコードを修正して、次のようなコマンドライン実行に差し替えられれば動作するだろう：

bash$ dvipdfmx texput.dvi

SVG 出力

関数 preview にキーワード引数 output='svg' を指定することで、出力データの形式が SVG となる。

• 実行環境に dvisvgm が存在すること必要だ。TeX Live ユーザーならば問題ないだろう。

• 即表示する場合はキーワード引数 viewer に SVG ファイルを描画できるプログラムを指定するわけだが、普通は Web ブラウザーで十分だ。Inkscape だと起動に時間がかかる。

TeX ファイルを保存する

関数 preview に対してキーワード引数 outputTexFile に保存先パスを指定すると、処理中に中間生成する TeX ファイルを捨てずにとっておくことができる。SymPy の生成する TeX コードをテキストエディターで清書するにはこの手段を採用する。

In [1]: preview(cos(x)**2 + sin(x)**2, outputTexFile='preview.tex', ...)

ついでに preamble についても説明する。既定の内容は次のようなものだ：

\documentclass[12pt]{article}
\pagestyle{empty}

\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{euler}

\begin{document}

これをキーワード引数 preamble を指定することで変更できる。次に説明する TeX 数式直接指定の際に、必要パッケージを指示するためにはこれが使える。

In [2]: preamble = r'''\documentclass[10pt]{article}
   ...: \usepackage{amsmath,amsfonts}
   ...: \begin{document}
   ...: '''

In [3]: preview(cos(x)**2 + sin(x)**2, outputTexFile='preview.tex', preamble=preamble, ...)

入力

実は関数 preview の引数としては SymPy オブジェクトだけではなく、 TeX 数式を表す文字列も受け付ける。

In [1]: preview(r'$\cos^2 x + \sin^2 x$', output='png', viewer='mspaint')

今ならば MathJax があるので、この機能はそれほど便利なわけではない。