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