Skip to content

Use LaTeX to print various built-in types with the SymPy printing extension #1399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fperez merged 2 commits into from
Apr 15, 2012
Merged

Use LaTeX to print various built-in types with the SymPy printing extension #1399

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e21221c
Use LaTeX to print various built-in types with the SymPy printing ext…
asmeurer Feb 12, 2012
1186cac
Only print container types with LaTeX in the notebook if all the elem…
asmeurer Mar 15, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions IPython/extensions/sympyprinting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
except ImportError:
pass


#-----------------------------------------------------------------------------
# Definitions of magic functions for use with IPython
#-----------------------------------------------------------------------------
Expand All @@ -55,14 +54,32 @@ def print_png(o):
png = latex_to_png(s)
return png

def can_print_latex(o):
"""
Return True if type o can be printed with LaTeX.

If o is a container type, this is True if and only if every element of o
can be printed with LaTeX.
"""
import sympy
if isinstance(o, (list, tuple)):
return all(can_print_latex(i) for i in o)
elif isinstance(o, dict):
return all((isinstance(i, basestring) or can_print_latex(i)) and can_print_latex(o[i]) for i in o)
elif isinstance(o,(sympy.Basic, sympy.matrices.Matrix, int, long, float)):
return True
return False

def print_latex(o):
"""A function to generate the latex representation of sympy expressions."""
s = latex(o, mode='plain')
s = s.replace('\\dag','\\dagger')
s = s.strip('$')
return '$$%s$$' % s

"""A function to generate the latex representation of sympy
expressions."""
if can_print_latex(o):
s = latex(o, mode='plain')
s = s.replace('\\dag','\\dagger')
s = s.strip('$')
return '$$%s$$' % s
# Fallback to the string printer
return None

_loaded = False

Expand All @@ -72,7 +89,9 @@ def load_ipython_extension(ip):
if not _loaded:
plaintext_formatter = ip.display_formatter.formatters['text/plain']

for cls in (object, tuple, list, set, frozenset, dict, str):
for cls in (object, set, frozenset, str):
# set and frozen set are currently broken with SymPy's latex()
# function. See http://code.google.com/p/sympy/issues/detail?id=3062.
plaintext_formatter.for_type(cls, print_basic_unicode)

plaintext_formatter.for_type_by_name(
Expand All @@ -87,6 +106,8 @@ def load_ipython_extension(ip):
png_formatter.for_type_by_name(
'sympy.core.basic', 'Basic', print_png
)
for cls in (list, tuple, dict, int, long, float):
png_formatter.for_type(cls, print_png)

latex_formatter = ip.display_formatter.formatters['text/latex']
latex_formatter.for_type_by_name(
Expand All @@ -95,5 +116,9 @@ def load_ipython_extension(ip):
latex_formatter.for_type_by_name(
'sympy.matrices.matrices', 'Matrix', print_latex
)
_loaded = True

for cls in (list, tuple):
# Use LaTeX only if every element is printable by latex
latex_formatter.for_type(cls, print_latex)

_loaded = True