passagemath-repl 10.4.62__py3-none-any.whl

sage/repl/rich_output/example.canvas3d

@@ -0,0 +1 @@
+[{"vertices":[{"x":1,"y":1,"z":1},{"x":-1,"y":1,"z":1},{"x":-1,"y":-1,"z":1},{"x":1,"y":-1,"z":1}],"faces":[[0,1,2,3]],"color":"008000"},{"vertices":[{"x":1,"y":1,"z":1},{"x":-1,"y":1,"z":1},{"x":-1,"y":1,"z":-1},{"x":1,"y":1,"z":-1}],"faces":[[0,1,2,3]],"color":"008000"},{"vertices":[{"x":1,"y":1,"z":1},{"x":1,"y":-1,"z":1},{"x":1,"y":-1,"z":-1},{"x":1,"y":1,"z":-1}],"faces":[[0,1,2,3]],"color":"008000"},{"vertices":[{"x":-1,"y":1,"z":1},{"x":-1,"y":-1,"z":1},{"x":-1,"y":-1,"z":-1},{"x":-1,"y":1,"z":-1}],"faces":[[0,1,2,3]],"color":"008000"},{"vertices":[{"x":1,"y":1,"z":-1},{"x":-1,"y":1,"z":-1},{"x":-1,"y":-1,"z":-1},{"x":1,"y":-1,"z":-1}],"faces":[[0,1,2,3]],"color":"008000"},{"vertices":[{"x":1,"y":-1,"z":1},{"x":-1,"y":-1,"z":1},{"x":-1,"y":-1,"z":-1},{"x":1,"y":-1,"z":-1}],"faces":[[0,1,2,3]],"color":"008000"}]

sage/repl/rich_output/example.svg

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Created with matplotlib (http://matplotlib.org/) -->
+<svg height="420pt" version="1.1" viewBox="0 0 420 420" width="420pt" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <defs>
+  <style type="text/css">
+*{stroke-linecap:butt;stroke-linejoin:round;}
+  </style>
+ </defs>
+ <g id="figure_1">
+  <g id="patch_1">
+   <path d="
+M0 420.48
+L420.48 420.48
+L420.48 0
+L0 0
+z
+" style="fill:#ffffff;"/>
+  </g>
+  <g id="axes_1">
+   <g id="patch_2">
+    <path d="
+M7.2 413.28
+L413.28 413.28
+L413.28 7.2
+L7.2 7.2
+z
+" style="fill:#ffffff;"/>
+   </g>
+   <g id="matplotlib.axis_1"/>
+   <g id="matplotlib.axis_2"/>
+   <g id="patch_3">
+    <path clip-path="url(#p85c0e9ffdb)" d="
+M210.24 405.471
+C262.016 405.471 311.678 384.9 348.289 348.289
+C384.9 311.678 405.471 262.016 405.471 210.24
+C405.471 158.464 384.9 108.802 348.289 72.191
+C311.678 35.58 262.016 15.0092 210.24 15.0092
+C158.464 15.0092 108.802 35.58 72.191 72.191
+C35.58 108.802 15.0092 158.464 15.0092 210.24
+C15.0092 262.016 35.58 311.678 72.191 348.289
+C108.802 384.9 158.464 405.471 210.24 405.471
+z
+" style="fill:none;stroke:#0000ff;"/>
+   </g>
+  </g>
+ </g>
+ <defs>
+  <clipPath id="p85c0e9ffdb">
+   <rect height="406.08" width="406.08" x="7.2" y="7.2"/>
+  </clipPath>
+ </defs>
+</svg>

sage/repl/rich_output/example_wavefront_scene.mtl

@@ -0,0 +1,7 @@
+newmtl texture177
+Ka 0.2 0.2 0.5
+Kd 0.4 0.4 1.0
+Ks 0.0 0.0 0.0
+illum 1
+Ns 1
+d 1

sage/repl/rich_output/example_wavefront_scene.obj

@@ -0,0 +1,17 @@
+mtllib scene.mtl
+g obj_1
+usemtl texture177
+v 0.5 0.5 0.5
+v -0.5 0.5 0.5
+v -0.5 -0.5 0.5
+v 0.5 -0.5 0.5
+v 0.5 0.5 -0.5
+v -0.5 0.5 -0.5
+v 0.5 -0.5 -0.5
+v -0.5 -0.5 -0.5
+f 1 2 3 4
+f 1 5 6 2
+f 1 4 7 5
+f 6 5 7 8
+f 7 4 3 8
+f 3 2 6 8

sage/repl/rich_output/output_basic.py

@@ -0,0 +1,391 @@
+# sage_setup: distribution = sagemath-repl
+r"""
+Basic Output Types
+
+The Sage rich representation system requires a special container class
+to hold the data for each type of rich output. They all inherit from
+:class:`OutputBase`, though a more typical example is
+:class:`OutputPlainText`. Some output classes consist of more than one
+data buffer, for example jmol or certain animation formats. The output
+class is independent of user preferences and of the display
+backend.
+
+The display backends can define derived classes to attach
+backend-specific display functionality to, for example how to launch a
+viewer. But they must not change how the output container is
+created. To enforce this, the Sage ``_rich_repr_`` magic method will
+only ever see the output class defined here. The display manager will
+promote it to a backend-specific subclass if necessary prior to
+displaying it.
+
+To create new types of output, you must create your own subclass of
+:class:`OutputBase` and register it in
+:mod:`sage.repl.rich_output.output_catalog`.
+
+.. warning::
+
+    All rich output data in subclasses of :class:`OutputBase` must be
+    contained in :class:`~sage.repl.rich_output.buffer.OutputBuffer`
+    instances. You must never reference any files on the local file
+    system, as there is no guarantee that the notebook server and the
+    worker process are on the same computer. Or even share a common
+    file system.
+"""
+
+#*****************************************************************************
+#       Copyright (C) 2015 Volker Braun <vbraun.name@gmail.com>
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  http://www.gnu.org/licenses/
+#*****************************************************************************
+
+
+from sage.structure.sage_object import SageObject
+from sage.repl.rich_output.buffer import OutputBuffer
+
+
+class OutputBase(SageObject):
+    """
+    Base class for all rich output containers.
+    """
+
+    def _repr_(self):
+        """
+        Return a string representation.
+
+        OUTPUT: string
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_basic import OutputBase
+            sage: output_base = OutputBase()
+            sage: output_base._repr_()
+            'OutputBase container'
+        """
+        return '{0} container'.format(self.__class__.__name__)
+
+    @classmethod
+    def example(cls):
+        """
+        Construct a sample instance.
+
+        This static method is meant for doctests, so they can easily
+        construct an example.
+
+        OUTPUT: an instance of the :class:`OutputBase` subclass
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_basic import OutputBase
+            sage: OutputBase.example()
+            Traceback (most recent call last):
+            ...
+            NotImplementedError: derived classes must implement this class method
+        """
+        raise NotImplementedError('derived classes must implement this class method')
+
+
+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 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 OutputUnicodeArt(OutputBase):
+
+    def __init__(self, unicode_art):
+        """
+        Unicode Art Output.
+
+        Similar to :class:`OutputAsciiArt` but using the entire
+        unicode range.
+
+        INPUT:
+
+        - ``unicode_art`` --
+          :class:`~sage.repl.rich_output.buffer.OutputBuffer`. Alternatively,
+          a string (unicode in Python 2.x) can be passed directly
+          which will then be converted into an
+          :class:`~sage.repl.rich_output.buffer.OutputBuffer`. Unicode
+          art rendered into a string.
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_catalog import OutputUnicodeArt
+            sage: OutputUnicodeArt(u':-}')
+            OutputUnicodeArt container
+        """
+        # Internally, all buffers store bytes. Unicode is always utf-8
+        # encoded.
+        if not isinstance(unicode_art, bytes):
+            unicode_art = unicode_art.encode('utf-8')
+        self.unicode_art = OutputBuffer(unicode_art)
+
+    @classmethod
+    def example(cls):
+        r"""
+        Construct a sample unicode art output container.
+
+        This static method is meant for doctests, so they can easily
+        construct an example.
+
+        OUTPUT: an instance of :class:`OutputUnicodeArt`
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_catalog import OutputUnicodeArt
+            sage: OutputUnicodeArt.example()
+            OutputUnicodeArt container
+            sage: print(OutputUnicodeArt.example().unicode_art.get_unicode())
+            ⎛-11   0   1⎞
+            ⎜  3  -1   0⎟
+            ⎝ -1  -1   0⎠
+        """
+        return cls('⎛-11   0   1⎞\n'
+                   '⎜  3  -1   0⎟\n'
+                   '⎝ -1  -1   0⎠')
+
+    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 OutputUnicodeArt
+            sage: unicode_art = OutputUnicodeArt.example()
+            sage: unicode_art.print_to_stdout()
+            ⎛-11   0   1⎞
+            ⎜  3  -1   0⎟
+            ⎝ -1  -1   0⎠
+        """
+        print(self.unicode_art.get_unicode())
+
+
+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.
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_catalog import OutputLatex
+            sage: OutputLatex(latex(sqrt(x)))                                           # needs sage.symbolic
+            OutputLatex container
+        """
+        self.latex = OutputBuffer(latex)
+
+    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())

sage/repl/rich_output/output_browser.py

@@ -0,0 +1,103 @@
+# sage_setup: distribution = sagemath-repl
+r"""
+Rich Output for the Browser
+"""
+
+import re
+
+from sage.repl.rich_output.output_basic import OutputBase
+from sage.repl.rich_output.buffer import OutputBuffer
+
+# regex to match "<html>\[...\]</html>" or "<html>\(...\)</html>"
+latex_re = re.compile(r'<html>(?P<mathstart>\\\[|\\\()(?P<latex>.*)(?P<mathend>\\\]|\\\))</html>',
+                      flags=re.DOTALL)
+
+
+class OutputHtml(OutputBase):
+
+    def __init__(self, html):
+        """
+        HTML Output.
+
+        INPUT:
+
+        - ``html`` --
+          :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 html fragment code. Excludes the surrounding
+          ``<body>`` and ``<html>`` tag.
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_catalog import OutputHtml
+            sage: OutputHtml('<div>Foo<b>B</b>ar</div>')
+            OutputHtml container
+        """
+        self.html = OutputBuffer(html)
+
+        # if the html is a simple wrapper of latex for mathjax rendering, then
+        # the latex string is saved for possible latex output such as Jupyter's
+        # pdf export of a notebook
+        m = latex_re.match(html)
+        if m:
+            mathjax_string = m.group('latex')
+            latex_string = mathjax_string.replace('&lt;', '<')
+            if m.group('mathstart') == r'\[' and m.group('mathend') == r'\]':
+                self.latex = OutputBuffer('$$' + latex_string + '$$')
+            else:
+                self.latex = OutputBuffer('$' + latex_string + '$')
+        else:
+            self.latex = None
+
+    @classmethod
+    def example(cls):
+        r"""
+        Construct a sample Html output container.
+
+        This static method is meant for doctests, so they can easily
+        construct an example.
+
+        OUTPUT: an instance of :class:`OutputHtml`
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_catalog import OutputHtml
+            sage: OutputHtml.example()
+            OutputHtml container
+            sage: OutputHtml.example().html.get_str()
+            '<div>Hello World!</div>'
+        """
+        return cls('<div>Hello World!</div>')
+
+    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 OutputHtml
+            sage: rich_output = OutputHtml.example()
+            sage: rich_output.print_to_stdout()
+            <div>Hello World!</div>
+        """
+        print(self.html.get_unicode())
+
+    def with_html_tag(self):
+        r"""
+        Return the HTML code surrounded by ``<html>`` tag.
+
+        This is just a convenience method.
+
+        EXAMPLES::
+
+            sage: from sage.repl.rich_output.output_catalog import OutputHtml
+            sage: rich_output = OutputHtml.example()
+            sage: rich_output.print_to_stdout()
+            <div>Hello World!</div>
+            sage: rich_output.with_html_tag()
+            '<html><div>Hello World!</div></html>'
+        """
+        return '<html>{0}</html>'.format(self.html.get_unicode())

sage/repl/rich_output/output_catalog.py

@@ -0,0 +1,54 @@
+# sage_setup: distribution = sagemath-repl
+r"""
+Catalog of all available output container types.
+
+If you define another output type then you must add it to the imports here.
+"""
+
+#*****************************************************************************
+#       Copyright (C) 2015 Volker Braun <vbraun.name@gmail.com>
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  http://www.gnu.org/licenses/
+#*****************************************************************************
+
+
+from .output_basic import (
+    OutputPlainText,
+    OutputAsciiArt,
+    OutputUnicodeArt,
+    OutputLatex,
+)
+
+from .output_browser import (
+    OutputHtml,
+)
+
+from .output_graphics import (
+    OutputImagePng,
+    OutputImageGif,
+    OutputImageJpg,
+    OutputImageSvg,
+    OutputImagePdf,
+    OutputImageDvi,
+)
+
+from .output_graphics3d import (
+    OutputSceneJmol,
+    OutputSceneWavefront,
+    OutputSceneCanvas3d,
+    OutputSceneThreejs,
+)
+
+from .output_video import (
+    OutputVideoOgg,
+    OutputVideoWebM,
+    OutputVideoMp4,
+    OutputVideoFlash,
+    OutputVideoMatroska,
+    OutputVideoAvi,
+    OutputVideoWmv,
+    OutputVideoQuicktime,
+)