1"""Simple magics for display formats"""
2#-----------------------------------------------------------------------------
3#  Copyright (c) 2012 The IPython Development Team.
4#
5#  Distributed under the terms of the Modified BSD License.
6#
7#  The full license is in the file COPYING.txt, distributed with this software.
8#-----------------------------------------------------------------------------
9
10#-----------------------------------------------------------------------------
11# Imports
12#-----------------------------------------------------------------------------
13
14# Our own packages
15from IPython.core.display import display, Javascript, Latex, SVG, HTML, Markdown
16from IPython.core.magic import  (
17    Magics, magics_class, cell_magic
18)
19from IPython.core import magic_arguments
20
21#-----------------------------------------------------------------------------
22# Magic implementation classes
23#-----------------------------------------------------------------------------
24
25
26@magics_class
27class DisplayMagics(Magics):
28    """Magics for displaying various output types with literals
29
30    Defines javascript/latex/svg/html cell magics for writing
31    blocks in those languages, to be rendered in the frontend.
32    """
33
34    @cell_magic
35    def js(self, line, cell):
36        """Run the cell block of Javascript code
37
38        Alias of `%%javascript`
39        """
40        self.javascript(line, cell)
41
42    @cell_magic
43    def javascript(self, line, cell):
44        """Run the cell block of Javascript code"""
45        display(Javascript(cell))
46
47
48    @cell_magic
49    def latex(self, line, cell):
50        """Render the cell as a block of latex
51
52        The subset of latex which is support depends on the implementation in
53        the client.  In the Jupyter Notebook, this magic only renders the subset
54        of latex defined by MathJax
55        [here](https://docs.mathjax.org/en/v2.5-latest/tex.html)."""
56        display(Latex(cell))
57
58    @cell_magic
59    def svg(self, line, cell):
60        """Render the cell as an SVG literal"""
61        display(SVG(cell))
62
63    @magic_arguments.magic_arguments()
64    @magic_arguments.argument(
65        '--isolated', action='store_true', default=False,
66        help="""Annotate the cell as 'isolated'.
67Isolated cells are rendered inside their own <iframe> tag"""
68    )
69    @cell_magic
70    def html(self, line, cell):
71        """Render the cell as a block of HTML"""
72        args = magic_arguments.parse_argstring(self.html, line)
73        html = HTML(cell)
74        if args.isolated:
75            display(html, metadata={'text/html':{'isolated':True}})
76        else:
77            display(html)
78
79    @cell_magic
80    def markdown(self, line, cell):
81        """Render the cell as Markdown text block"""
82        display(Markdown(cell))
83