1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
"""
Contains writer base class.
"""
#-----------------------------------------------------------------------------
#Copyright (c) 2013, the IPython Development Team.
#
#Distributed under the terms of the Modified BSD License.
#
#The full license is in the file COPYING.txt, distributed with this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
from IPython.utils.traitlets import List
from ..utils.base import NbConvertBase
#-----------------------------------------------------------------------------
# Classes
#-----------------------------------------------------------------------------
class WriterBase(NbConvertBase):
"""Consumes output from nbconvert export...() methods and writes to a
useful location. """
files = List([], config=True, help="""
List of the files that the notebook references. Files will be
included with written output.""")
def __init__(self, config=None, **kw):
"""
Constructor
"""
super(WriterBase, self).__init__(config=config, **kw)
def write(self, output, resources, **kw):
"""
Consume and write Jinja output.
Parameters
----------
output : string
Conversion results. This string contains the file contents of the
converted file.
resources : dict
Resources created and filled by the nbconvert conversion process.
Includes output from transformers, such as the extract figure
transformer.
"""
raise NotImplementedError()
|
