Show More
@@ -1,124 +1,133 | |||
|
1 | 1 | """ |
|
2 | 2 | A print function that pretty prints sympy Basic objects. |
|
3 | 3 | |
|
4 | 4 | :moduleauthor: Brian Granger |
|
5 | 5 | |
|
6 | 6 | Usage |
|
7 | 7 | ===== |
|
8 | 8 | |
|
9 | 9 | Once the extension is loaded, Sympy Basic objects are automatically |
|
10 | 10 | pretty-printed. |
|
11 | 11 | |
|
12 | 12 | """ |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Copyright (C) 2008-2011 The IPython Development Team |
|
15 | 15 | # |
|
16 | 16 | # Distributed under the terms of the BSD License. The full license is in |
|
17 | 17 | # the file COPYING, distributed as part of this software. |
|
18 | 18 | #----------------------------------------------------------------------------- |
|
19 | 19 | |
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | # Imports |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | |
|
24 | 24 | from IPython.lib.latextools import latex_to_png |
|
25 | 25 | from IPython.testing import decorators as dec |
|
26 | 26 | # use @dec.skipif_not_sympy to skip tests requiring sympy |
|
27 | 27 | |
|
28 | 28 | try: |
|
29 | 29 | from sympy import pretty, latex |
|
30 | 30 | except ImportError: |
|
31 | 31 | pass |
|
32 | 32 | |
|
33 | 33 | #----------------------------------------------------------------------------- |
|
34 | 34 | # Definitions of special display functions for use with IPython |
|
35 | 35 | #----------------------------------------------------------------------------- |
|
36 | 36 | |
|
37 | 37 | def print_basic_unicode(o, p, cycle): |
|
38 | 38 | """A function to pretty print sympy Basic objects.""" |
|
39 | 39 | if cycle: |
|
40 | 40 | return p.text('Basic(...)') |
|
41 | 41 | out = pretty(o, use_unicode=True) |
|
42 | 42 | if '\n' in out: |
|
43 | 43 | p.text(u'\n') |
|
44 | 44 | p.text(out) |
|
45 | 45 | |
|
46 | 46 | |
|
47 | 47 | def print_png(o): |
|
48 | 48 | """A function to display sympy expression using LaTex -> PNG.""" |
|
49 | 49 | s = latex(o, mode='inline') |
|
50 | 50 | # mathtext does not understand certain latex flags, so we try to replace |
|
51 | 51 | # them with suitable subs. |
|
52 | 52 | s = s.replace('\\operatorname','') |
|
53 | 53 | s = s.replace('\\overline', '\\bar') |
|
54 | 54 | png = latex_to_png(s) |
|
55 | 55 | return png |
|
56 | 56 | |
|
57 | 57 | def can_print_latex(o): |
|
58 | 58 | """ |
|
59 | 59 | Return True if type o can be printed with LaTeX. |
|
60 | 60 | |
|
61 | 61 | If o is a container type, this is True if and only if every element of o |
|
62 | 62 | can be printed with LaTeX. |
|
63 | 63 | """ |
|
64 | 64 | import sympy |
|
65 | if isinstance(o, (list, tuple)): | |
|
65 | if isinstance(o, (list, tuple, set, frozenset)): | |
|
66 | 66 | return all(can_print_latex(i) for i in o) |
|
67 | 67 | elif isinstance(o, dict): |
|
68 | 68 | return all((isinstance(i, basestring) or can_print_latex(i)) and can_print_latex(o[i]) for i in o) |
|
69 | 69 | elif isinstance(o,(sympy.Basic, sympy.matrices.Matrix, int, long, float)): |
|
70 | 70 | return True |
|
71 | 71 | return False |
|
72 | 72 | |
|
73 | 73 | def print_latex(o): |
|
74 | 74 | """A function to generate the latex representation of sympy |
|
75 | 75 | expressions.""" |
|
76 | 76 | if can_print_latex(o): |
|
77 | 77 | s = latex(o, mode='plain') |
|
78 | 78 | s = s.replace('\\dag','\\dagger') |
|
79 | 79 | s = s.strip('$') |
|
80 | 80 | return '$$%s$$' % s |
|
81 | 81 | # Fallback to the string printer |
|
82 | 82 | return None |
|
83 | 83 | |
|
84 | 84 | _loaded = False |
|
85 | 85 | |
|
86 | 86 | def load_ipython_extension(ip): |
|
87 | 87 | """Load the extension in IPython.""" |
|
88 | import sympy | |
|
88 | 89 | global _loaded |
|
89 | 90 | if not _loaded: |
|
90 | 91 | plaintext_formatter = ip.display_formatter.formatters['text/plain'] |
|
91 | 92 | |
|
92 |
for cls in (object, |
|
|
93 | # set and frozen set are currently broken with SymPy's latex() | |
|
94 | # function. See http://code.google.com/p/sympy/issues/detail?id=3062. | |
|
93 | for cls in (object, str): | |
|
94 | plaintext_formatter.for_type(cls, print_basic_unicode) | |
|
95 | ||
|
96 | printable_containers = [list, tuple] | |
|
97 | ||
|
98 | # set and frozen set were broken with SymPy's latex() function, but | |
|
99 | # was fixed in the 0.7.1-git development version. See | |
|
100 | # http://code.google.com/p/sympy/issues/detail?id=3062. | |
|
101 | if sympy.__version__ > '0.7.1': | |
|
102 | printable_containers += [set, frozenset] | |
|
103 | else: | |
|
95 | 104 | plaintext_formatter.for_type(cls, print_basic_unicode) |
|
96 | 105 | |
|
97 | 106 | plaintext_formatter.for_type_by_name( |
|
98 | 107 | 'sympy.core.basic', 'Basic', print_basic_unicode |
|
99 | 108 | ) |
|
100 | 109 | plaintext_formatter.for_type_by_name( |
|
101 | 110 | 'sympy.matrices.matrices', 'Matrix', print_basic_unicode |
|
102 | 111 | ) |
|
103 | 112 | |
|
104 | 113 | png_formatter = ip.display_formatter.formatters['image/png'] |
|
105 | 114 | |
|
106 | 115 | png_formatter.for_type_by_name( |
|
107 | 116 | 'sympy.core.basic', 'Basic', print_png |
|
108 | 117 | ) |
|
109 |
for cls in |
|
|
118 | for cls in [dict, int, long, float] + printable_containers: | |
|
110 | 119 | png_formatter.for_type(cls, print_png) |
|
111 | 120 | |
|
112 | 121 | latex_formatter = ip.display_formatter.formatters['text/latex'] |
|
113 | 122 | latex_formatter.for_type_by_name( |
|
114 | 123 | 'sympy.core.basic', 'Basic', print_latex |
|
115 | 124 | ) |
|
116 | 125 | latex_formatter.for_type_by_name( |
|
117 | 126 | 'sympy.matrices.matrices', 'Matrix', print_latex |
|
118 | 127 | ) |
|
119 | 128 | |
|
120 |
for cls in |
|
|
129 | for cls in printable_containers: | |
|
121 | 130 | # Use LaTeX only if every element is printable by latex |
|
122 | 131 | latex_formatter.for_type(cls, print_latex) |
|
123 | 132 | |
|
124 | 133 | _loaded = True |
General Comments 0
You need to be logged in to leave comments.
Login now