Show More
@@ -1,167 +1,179 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """NBConvert is a utility for conversion of IPYNB files. |
|
3 | 3 | |
|
4 | 4 | Commandline interface for the NBConvert conversion utility. Read the |
|
5 | 5 | readme.rst for usage information |
|
6 | 6 | """ |
|
7 | 7 | #----------------------------------------------------------------------------- |
|
8 | 8 | #Copyright (c) 2013, the IPython Development Team. |
|
9 | 9 | # |
|
10 | 10 | #Distributed under the terms of the Modified BSD License. |
|
11 | 11 | # |
|
12 | 12 | #The full license is in the file COPYING.txt, distributed with this software. |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | #Imports |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | #Stdlib imports |
|
20 | 20 | from __future__ import print_function |
|
21 | 21 | import sys |
|
22 | 22 | import os |
|
23 | 23 | import glob |
|
24 | 24 | |
|
25 | 25 | #From IPython |
|
26 | 26 | from IPython.core.application import BaseIPythonApplication |
|
27 | 27 | from IPython.config.application import catch_config_error |
|
28 | 28 | from IPython.utils.traitlets import Unicode, List, Instance, DottedObjectName, Type |
|
29 | 29 | from IPython.utils.importstring import import_item |
|
30 | 30 | |
|
31 | 31 | from .exporters.export import export_by_name, get_export_names |
|
32 | 32 | from .exporters.exporter import Exporter |
|
33 | 33 | from .writers.base import WriterBase |
|
34 | 34 | from .utils.config import GlobalConfigurable |
|
35 | 35 | |
|
36 | 36 | #----------------------------------------------------------------------------- |
|
37 | 37 | #Classes and functions |
|
38 | 38 | #----------------------------------------------------------------------------- |
|
39 | 39 | |
|
40 | 40 | class NbConvertApp(BaseIPythonApplication): |
|
41 | 41 | """Application used to convert to and from notebook file type (*.ipynb)""" |
|
42 | 42 | |
|
43 | 43 | |
|
44 | 44 | description = Unicode( |
|
45 | 45 | u"""This application is used to convert notebook files (*.ipynb). |
|
46 | 46 | An ipython config file can be used to batch convert notebooks in the |
|
47 | 47 | current directory.""") |
|
48 | 48 | |
|
49 | 49 | examples = Unicode(u""" |
|
50 | 50 | Running `ipython nbconvert` will read the directory config file and then |
|
51 | 51 | apply it to one or more notebooks. |
|
52 | 52 | |
|
53 | 53 | Multiple notebooks can be given at the command line in a couple of |
|
54 | 54 | different ways: |
|
55 | 55 | |
|
56 | 56 | > ipython nbconvert notebook*.ipynb |
|
57 | 57 | > ipython nbconvert notebook1.ipynb notebook2.ipynb |
|
58 | 58 | > ipython nbconvert # this will use the config file to fill in the notebooks |
|
59 | 59 | """) |
|
60 | 60 | |
|
61 | 61 | config_file_name = Unicode(u'ipython_nbconvert_config.py') |
|
62 | 62 | |
|
63 | 63 | #Writer specific variables |
|
64 | 64 | writer = Instance('IPython.nbconvert.writers.base.WriterBase', |
|
65 | 65 | help="""Instance of the writer class used to write the |
|
66 | 66 | results of the conversion.""") |
|
67 | 67 | writer_class = DottedObjectName('FilesWriter', config=True, |
|
68 | 68 | help="""Writer class used to write the |
|
69 | 69 | results of the conversion""") |
|
70 | 70 | writer_aliases = {'FilesWriter': 'IPython.nbconvert.writers.files.FilesWriter', |
|
71 | 71 | 'DebugWriter': 'IPython.nbconvert.writers.debug.DebugWriter', |
|
72 | 72 | 'StdoutWriter': 'IPython.nbconvert.writers.stdout.StdoutWriter'} |
|
73 | 73 | writer_factory = Type() |
|
74 | 74 | |
|
75 | 75 | def _writer_class_changed(self, name, old, new): |
|
76 | 76 | if new in self.writer_aliases: |
|
77 | 77 | new = self.writer_aliases[new] |
|
78 | 78 | self.writer_factory = import_item(new) |
|
79 | 79 | |
|
80 | 80 | |
|
81 | 81 | #Other configurable variables |
|
82 | 82 | export_format = Unicode( |
|
83 | 83 | "", config=True, |
|
84 | 84 | help="""If specified, nbconvert will convert the document(s) specified |
|
85 | 85 | using this format.""") |
|
86 | 86 | |
|
87 | 87 | notebooks = List([], config=True, help="""List of notebooks to convert. |
|
88 | 88 | Search patterns are supported.""") |
|
89 | 89 | |
|
90 | 90 | aliases = {'format':'NbConvertApp.export_format', |
|
91 | 91 | 'notebooks':'NbConvertApp.notebooks', |
|
92 | 92 | 'writer':'NbConvertApp.writer_class'} |
|
93 | 93 | |
|
94 | 94 | |
|
95 | 95 | @catch_config_error |
|
96 | 96 | def initialize(self, argv=None): |
|
97 | 97 | super(NbConvertApp, self).initialize(argv) |
|
98 | 98 | |
|
99 | 99 | #Register class here to have help with help all |
|
100 | 100 | self.classes.insert(0, Exporter) |
|
101 | 101 | self.classes.insert(0, WriterBase) |
|
102 | 102 | self.classes.insert(0, GlobalConfigurable) |
|
103 | 103 | |
|
104 | 104 | #Init |
|
105 | 105 | self.init_config(self.extra_args) |
|
106 | 106 | self.init_writer() |
|
107 | 107 | |
|
108 | 108 | |
|
109 | 109 | def init_config(self, extra_args): |
|
110 | 110 | """ |
|
111 | 111 | Add notebooks to the config if needed. Glob each notebook to replace |
|
112 | 112 | notebook patterns with filenames. |
|
113 | 113 | """ |
|
114 | 114 | |
|
115 | 115 | #Get any additional notebook patterns from the commandline |
|
116 | 116 | if len(extra_args) > 0: |
|
117 | 117 | for pattern in extra_args: |
|
118 | 118 | self.notebooks.append(pattern) |
|
119 | 119 | |
|
120 | 120 | #Use glob to replace all the notebook patterns with filenames. |
|
121 | 121 | filenames = [] |
|
122 | 122 | for pattern in self.notebooks: |
|
123 | 123 | for filename in glob.glob(pattern): |
|
124 | 124 | if not filename in filenames: |
|
125 | 125 | filenames.append(filename) |
|
126 | 126 | self.notebooks = filenames |
|
127 | 127 | |
|
128 | 128 | |
|
129 | 129 | def init_writer(self): |
|
130 | 130 | """ |
|
131 | 131 | Initialize the writer (which is stateless) |
|
132 | 132 | """ |
|
133 | 133 | self._writer_class_changed(None, self.writer_class, self.writer_class) |
|
134 | 134 | self.writer = self.writer_factory(parent=self) |
|
135 | 135 | |
|
136 | 136 | |
|
137 | 137 | def start(self, argv=None): |
|
138 | 138 | """ |
|
139 | 139 | Entrypoint of NbConvert application. |
|
140 | 140 | """ |
|
141 | 141 | |
|
142 | 142 | #Call base |
|
143 | 143 | super(NbConvertApp, self).start() |
|
144 | 144 | |
|
145 | 145 | #Export each notebook |
|
146 | 146 | for notebook_filename in self.notebooks: |
|
147 | 147 | |
|
148 | 148 | #Get a unique key for the notebook and set it in the resources object. |
|
149 | 149 | basename = os.path.basename(notebook_filename) |
|
150 | 150 | notebook_name = basename[:basename.rfind('.')] |
|
151 | 151 | resources = {} |
|
152 | 152 | resources['unique_key'] = notebook_name |
|
153 | 153 | |
|
154 |
# |
|
|
155 | output, resources = export_by_name(self.export_format, | |
|
156 | notebook_filename, | |
|
157 |
|
|
|
158 |
|
|
|
154 | #Try to export | |
|
155 | try: | |
|
156 | return_value = export_by_name(self.export_format, | |
|
157 | notebook_filename, | |
|
158 | resources=resources, | |
|
159 | config=self.config) | |
|
160 | except NameError as e: | |
|
161 | print("Error: '%s' exporter not found." % self.export_format, | |
|
162 | file=sys.stderr) | |
|
163 | print("Known exporters are:", | |
|
164 | "\n\t" + "\n\t".join(get_export_names()), | |
|
165 | file=sys.stderr) | |
|
166 | sys.exit(-1) | |
|
167 | else: | |
|
168 | output, resources = return_value | |
|
169 | ||
|
170 | #Write | |
|
159 | 171 | self.writer.write(output, resources, notebook_name=notebook_name) |
|
160 | 172 | |
|
161 | 173 | |
|
162 | 174 | #----------------------------------------------------------------------------- |
|
163 | 175 | # Main entry point |
|
164 | 176 | #----------------------------------------------------------------------------- |
|
165 | 177 | |
|
166 | 178 | launch_new_instance = NbConvertApp.launch_instance |
|
167 | 179 |
General Comments 0
You need to be logged in to leave comments.
Login now