Coverage for local/lib/python2.7/site-packages/sage/repl/rich_output/output_graphics.py : 56%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
|
# -*- encoding: utf-8 -*- r""" Graphics Output Types
This module defines the rich output types for 2-d images, both vector and raster graphics. """
#***************************************************************************** # 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/ #*****************************************************************************
import os import base64
from sage.cpython.string import bytes_to_str from sage.repl.rich_output.output_basic import OutputBase from sage.repl.rich_output.buffer import OutputBuffer
class OutputImagePng(OutputBase):
def __init__(self, png): """ PNG Image
.. NOTE::
Every backend that is capable of displaying any kind of graphics is supposed to support the PNG format at least.
INPUT:
- ``png`` -- :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`. The PNG image data.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImagePng sage: OutputImagePng.example() # indirect doctest OutputImagePng container """
@classmethod def example(cls): r""" Construct a sample PNG output container
This static method is meant for doctests, so they can easily construct an example.
OUTPUT:
An instance of :class:`OutputImagePng`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImagePng sage: OutputImagePng.example() OutputImagePng container sage: OutputImagePng.example().png buffer containing 608 bytes sage: OutputImagePng.example().png.get().startswith(b'\x89PNG') True """
class OutputImageGif(OutputBase):
def __init__(self, gif): """ GIF Image (possibly animated)
INPUT:
- ``gif`` -- :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`. The GIF image data.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageGif sage: OutputImageGif.example() # indirect doctest OutputImageGif container """
@classmethod def example(cls): r""" Construct a sample GIF output container
This static method is meant for doctests, so they can easily construct an example.
OUTPUT:
An instance of :class:`OutputImageGif`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageGif sage: OutputImageGif.example() OutputImageGif container sage: OutputImageGif.example().gif buffer containing 408 bytes sage: OutputImageGif.example().gif.get().startswith(b'GIF89a') True """
def html_fragment(self): """ Return a self-contained HTML fragment displaying the image
This is a workaround for the Jupyter notebook which doesn't support GIF directly.
OUTPUT:
String. HTML fragment for displaying the GIF image.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageGif sage: OutputImageGif.example().html_fragment() '<img src="data:image/gif;base64,R0lGODl...zd3t/g4eLj5OVDQQA7"/>' """
class OutputImageJpg(OutputBase):
def __init__(self, jpg): """ JPEG Image
INPUT:
- ``jpg`` -- :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`. The JPEG image data.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageJpg sage: OutputImageJpg.example() # indirect doctest OutputImageJpg container """
@classmethod def example(cls): r""" Construct a sample JPEG output container
This static method is meant for doctests, so they can easily construct an example.
OUTPUT:
An instance of :class:`OutputImageJpg`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageJpg sage: OutputImageJpg.example() OutputImageJpg container sage: OutputImageJpg.example().jpg buffer containing 978 bytes sage: OutputImageJpg.example().jpg.get().startswith(b'\xff\xd8\xff\xe0\x00\x10JFIF') True """
class OutputImageSvg(OutputBase):
def __init__(self, svg): """ SVG Image
INPUT:
- ``svg`` -- :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`. The SVG image data.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageSvg sage: OutputImageSvg.example() # indirect doctest OutputImageSvg container """
@classmethod def example(cls): r""" Construct a sample SVG output container
This static method is meant for doctests, so they can easily construct an example.
OUTPUT:
An instance of :class:`OutputImageSvg`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageSvg sage: OutputImageSvg.example() OutputImageSvg container sage: OutputImageSvg.example().svg buffer containing 1422 bytes sage: b'</svg>' in OutputImageSvg.example().svg.get() True """
class OutputImagePdf(OutputBase):
def __init__(self, pdf): """ PDF Image
INPUT:
- ``pdf`` -- :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`. The PDF data.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImagePdf sage: OutputImagePdf.example() # indirect doctest OutputImagePdf container """
@classmethod def example(cls): r""" Construct a sample PDF output container
This static method is meant for doctests, so they can easily construct an example.
OUTPUT:
An instance of :class:`OutputImagePdf`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImagePdf sage: OutputImagePdf.example() OutputImagePdf container sage: OutputImagePdf.example().pdf buffer containing 4285 bytes sage: OutputImagePdf.example().pdf.get().startswith(b'%PDF-1.4') True """
class OutputImageDvi(OutputBase):
def __init__(self, dvi): """ DVI Image
INPUT:
- ``dvi`` -- :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`. The DVI data.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageDvi sage: OutputImageDvi.example() # indirect doctest OutputImageDvi container """
@classmethod def example(cls): r""" Construct a sample DVI output container
This static method is meant for doctests, so they can easily construct an example.
OUTPUT:
An instance of :class:`OutputImageDvi`.
EXAMPLES::
sage: from sage.repl.rich_output.output_catalog import OutputImageDvi sage: OutputImageDvi.example() OutputImageDvi container sage: OutputImageDvi.example().dvi buffer containing 212 bytes sage: b'TeX output' in OutputImageDvi.example().dvi.get() True """
|