class OutputPlainText(OutputBase):
def __init__(self, plain_text):
"""
Plain Text Output
INPUT:
- ``plain_text`` --
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
a bytes (string in Python 2.x) or string (unicode in Python
2.x) can be passed directly which will then be converted
into an
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. The
plain text output.
This should always be exactly the same as the (non-rich)
output from the ``_repr_`` method. Every backend object must
support plain text output as fallback.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputPlainText
sage: OutputPlainText('foo')
OutputPlainText container
"""
self.text = OutputBuffer(plain_text)
@classmethod
def example(cls):
"""
Construct a sample plain text output container
This static method is meant for doctests, so they can easily
construct an example.
OUTPUT:
An instance of :class:`OutputPlainText`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputPlainText
sage: OutputPlainText.example()
OutputPlainText container
sage: OutputPlainText.example().text.get_str()
'Example plain text output'
"""
return cls('Example plain text output')
def print_to_stdout(self):
"""
Write the data to stdout.
This is just a convenience method to help with debugging.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputPlainText
sage: plain_text = OutputPlainText.example()
sage: plain_text.print_to_stdout()
Example plain text output
"""
print(self.text.get_str())
class OutputLatex(OutputBase):
def __init__(self, latex):
"""
LaTeX Output
.. note::
The LaTeX commands will only use a subset of LaTeX that
can be displayed by MathJax.
INPUT:
- ``latex`` --
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
a string (bytes) can be passed directly which will then be
converted into an
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. String
containing the latex equation code. Excludes the surrounding
dollar signs / LaTeX equation environment. Also excludes the
surrounding MathJax ``<html>`` tag.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: OutputLatex('<html><script type="math/tex; mode=display">1</script></html>')
OutputLatex container
"""
self.latex = OutputBuffer(latex)
def mathjax(self, display=True):
r"""
Return the LaTeX with a surrounding MathJax HTML code.
INPUT:
- ``display`` -- boolean. Whether to return display (as
opposed to inline) TeX.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex('1')
sage: rich_output.latex
buffer containing 1 bytes
sage: rich_output.latex.get_str()
'1'
sage: rich_output.mathjax()
'<html><script type="math/tex; mode=display">1</script></html>'
sage: rich_output.mathjax(display=False)
'<html><script type="math/tex">1</script></html>'
"""
if display:
template = r'<html><script type="math/tex; mode=display">{0}</script></html>'
else:
template = r'<html><script type="math/tex">{0}</script></html>'
return template.format(self.latex.get_str())
def display_equation(self):
r"""
Return the LaTeX code for a display equation
OUTPUT:
String.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex('1')
sage: rich_output.latex
buffer containing 1 bytes
sage: rich_output.latex.get_str()
'1'
sage: rich_output.display_equation()
'\\begin{equation}\n1\n\\end{equation}'
"""
return '\n'.join(
[r'\begin{equation}',
self.latex.get_str(), r'\end{equation}'])
def inline_equation(self):
r"""
Return the LaTeX code for an inline equation
OUTPUT:
String.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex('1')
sage: rich_output.latex
buffer containing 1 bytes
sage: rich_output.latex.get_str()
'1'
sage: rich_output.inline_equation()
'\\begin{math}\n1\n\\end{math}'
"""
return '\n'.join(
[r'\begin{math}',
self.latex.get_str(), r'\end{math}'])
@classmethod
def example(cls):
r"""
Construct a sample LaTeX output container
This static method is meant for doctests, so they can easily
construct an example.
OUTPUT:
An instance of :class:`OutputLatex`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: OutputLatex.example()
OutputLatex container
sage: OutputLatex.example().latex.get_str()
'\\newcommand{\\Bold}[1]{\\mathbf{#1}}\\int \\sin\\left(x\\right)\\,{d x}'
"""
return cls(r'\newcommand{\Bold}[1]{\mathbf{#1}}'
r'\int \sin\left(x\right)\,{d x}')
def print_to_stdout(self):
r"""
Write the data to stdout.
This is just a convenience method to help with debugging.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex.example()
sage: rich_output.print_to_stdout()
\newcommand{\Bold}[1]{\mathbf{#1}}\int \sin\left(x\right)\,{d x}
"""
print(self.latex.get_str())
class OutputAsciiArt(OutputBase):
def __init__(self, ascii_art):
"""
ASCII Art Output
INPUT:
- ``ascii_art`` --
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
a string (bytes) can be passed directly which will then be
converted into an
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Ascii
art rendered into a string.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputAsciiArt
sage: OutputAsciiArt(':-}')
OutputAsciiArt container
"""
self.ascii_art = OutputBuffer(ascii_art)
@classmethod
def example(cls):
r"""
Construct a sample ascii art output container
This static method is meant for doctests, so they can easily
construct an example.
OUTPUT:
An instance of :class:`OutputAsciiArt`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputAsciiArt
sage: OutputAsciiArt.example()
OutputAsciiArt container
sage: OutputAsciiArt.example().ascii_art.get_str()
'[ * * * * ]\n[ ** ** * * * * * * ]\n[ ***, * , * , **, ** , *, * , * , * ]'
"""
return cls('[ * * * * ]\n'
'[ ** ** * * * * * * ]\n'
'[ ***, * , * , **, ** , *, * , * , * ]')
def print_to_stdout(self):
"""
Write the data to stdout.
This is just a convenience method to help with debugging.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputAsciiArt
sage: ascii_art = OutputAsciiArt.example()
sage: ascii_art.print_to_stdout()
[ * * * * ]
[ ** ** * * * * * * ]
[ ***, * , * , **, ** , *, * , * , * ]
"""
print(self.ascii_art.get_str())
class OutputPlainText(OutputBase):
def __init__(self, plain_text):
"""
Plain Text Output
INPUT:
- ``plain_text`` --
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
a bytes (string in Python 2.x) or string (unicode in Python
2.x) can be passed directly which will then be converted
into an
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. The
plain text output.
This should always be exactly the same as the (non-rich)
output from the ``_repr_`` method. Every backend object must
support plain text output as fallback.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputPlainText
sage: OutputPlainText('foo')
OutputPlainText container
"""
self.text = OutputBuffer(plain_text)
@classmethod
def example(cls):
"""
Construct a sample plain text output container
This static method is meant for doctests, so they can easily
construct an example.
OUTPUT:
An instance of :class:`OutputPlainText`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputPlainText
sage: OutputPlainText.example()
OutputPlainText container
sage: OutputPlainText.example().text.get_str()
'Example plain text output'
"""
return cls('Example plain text output')
def print_to_stdout(self):
"""
Write the data to stdout.
This is just a convenience method to help with debugging.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputPlainText
sage: plain_text = OutputPlainText.example()
sage: plain_text.print_to_stdout()
Example plain text output
"""
print(self.text.get_str())
class OutputLatex(OutputBase):
def __init__(self, latex):
"""
LaTeX Output
.. note::
The LaTeX commands will only use a subset of LaTeX that
can be displayed by MathJax.
INPUT:
- ``latex`` --
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
a string (bytes) can be passed directly which will then be
converted into an
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. String
containing the latex equation code. Excludes the surrounding
dollar signs / LaTeX equation environment. Also excludes the
surrounding MathJax ``<html>`` tag.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: OutputLatex('<html><script type="math/tex; mode=display">1</script></html>')
OutputLatex container
"""
self.latex = OutputBuffer(latex)
def mathjax(self, display=True):
r"""
Return the LaTeX with a surrounding MathJax HTML code.
INPUT:
- ``display`` -- boolean. Whether to return display (as
opposed to inline) TeX.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex('1')
sage: rich_output.latex
buffer containing 1 bytes
sage: rich_output.latex.get_str()
'1'
sage: rich_output.mathjax()
'<html><script type="math/tex; mode=display">1</script></html>'
sage: rich_output.mathjax(display=False)
'<html><script type="math/tex">1</script></html>'
"""
if display:
template = r'<html><script type="math/tex; mode=display">{0}</script></html>'
else:
template = r'<html><script type="math/tex">{0}</script></html>'
return template.format(self.latex.get_str())
def display_equation(self):
r"""
Return the LaTeX code for a display equation
OUTPUT:
String.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex('1')
sage: rich_output.latex
buffer containing 1 bytes
sage: rich_output.latex.get_str()
'1'
sage: rich_output.display_equation()
'\\begin{equation}\n1\n\\end{equation}'
"""
return '\n'.join([r'\begin{equation}', self.latex.get_str(),
r'\end{equation}'])
def inline_equation(self):
r"""
Return the LaTeX code for an inline equation
OUTPUT:
String.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex('1')
sage: rich_output.latex
buffer containing 1 bytes
sage: rich_output.latex.get_str()
'1'
sage: rich_output.inline_equation()
'\\begin{math}\n1\n\\end{math}'
"""
return '\n'.join([r'\begin{math}', self.latex.get_str(), r'\end{math}'])
@classmethod
def example(cls):
r"""
Construct a sample LaTeX output container
This static method is meant for doctests, so they can easily
construct an example.
OUTPUT:
An instance of :class:`OutputLatex`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: OutputLatex.example()
OutputLatex container
sage: OutputLatex.example().latex.get_str()
'\\newcommand{\\Bold}[1]{\\mathbf{#1}}\\int \\sin\\left(x\\right)\\,{d x}'
"""
return cls(r'\newcommand{\Bold}[1]{\mathbf{#1}}'
r'\int \sin\left(x\right)\,{d x}')
def print_to_stdout(self):
r"""
Write the data to stdout.
This is just a convenience method to help with debugging.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputLatex
sage: rich_output = OutputLatex.example()
sage: rich_output.print_to_stdout()
\newcommand{\Bold}[1]{\mathbf{#1}}\int \sin\left(x\right)\,{d x}
"""
print(self.latex.get_str())
class OutputAsciiArt(OutputBase):
def __init__(self, ascii_art):
"""
ASCII Art Output
INPUT:
- ``ascii_art`` --
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
a string (bytes) can be passed directly which will then be
converted into an
:class:`~sage.repl.rich_output.buffer.OutputBuffer`. Ascii
art rendered into a string.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputAsciiArt
sage: OutputAsciiArt(':-}')
OutputAsciiArt container
"""
self.ascii_art = OutputBuffer(ascii_art)
@classmethod
def example(cls):
r"""
Construct a sample ascii art output container
This static method is meant for doctests, so they can easily
construct an example.
OUTPUT:
An instance of :class:`OutputAsciiArt`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputAsciiArt
sage: OutputAsciiArt.example()
OutputAsciiArt container
sage: OutputAsciiArt.example().ascii_art.get_str()
'[ * * * * ]\n[ ** ** * * * * * * ]\n[ ***, * , * , **, ** , *, * , * , * ]'
"""
return cls('[ * * * * ]\n'
'[ ** ** * * * * * * ]\n'
'[ ***, * , * , **, ** , *, * , * , * ]')
def print_to_stdout(self):
"""
Write the data to stdout.
This is just a convenience method to help with debugging.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputAsciiArt
sage: ascii_art = OutputAsciiArt.example()
sage: ascii_art.print_to_stdout()
[ * * * * ]
[ ** ** * * * * * * ]
[ ***, * , * , **, ** , *, * , * , * ]
"""
print(self.ascii_art.get_str())
