##// END OF EJS Templates
improve logging in nbconvert preprocessors...
MinRK -
Show More
@@ -1,27 +1,11 b''
1 """
2 Module that re-groups preprocessor that would be applied to ipynb files
3 before going through the templating machinery.
1 """Base class for preprocessors"""
4 2
5 It exposes a convenient class to inherit from to access configurability.
6 """
7 #-----------------------------------------------------------------------------
8 # Copyright (c) 2013, the IPython Development Team.
9 #
3 # Copyright (c) IPython Development Team.
10 4 # Distributed under the terms of the Modified BSD License.
11 #
12 # The full license is in the file COPYING.txt, distributed with this software.
13 #-----------------------------------------------------------------------------
14
15 #-----------------------------------------------------------------------------
16 # Imports
17 #-----------------------------------------------------------------------------
18 5
19 6 from ..utils.base import NbConvertBase
20 7 from IPython.utils.traitlets import Bool
21 8
22 #-----------------------------------------------------------------------------
23 # Classes and Functions
24 #-----------------------------------------------------------------------------
25 9
26 10 class Preprocessor(NbConvertBase):
27 11 """ A configurable preprocessor
@@ -30,7 +14,7 b' class Preprocessor(NbConvertBase):'
30 14 preprocessor.
31 15
32 16 Any configurable traitlets this class exposed will be configurable in
33 profiles using c.SubClassName.atribute=value
17 profiles using c.SubClassName.attribute = value
34 18
35 19 you can overwrite :meth:`preprocess_cell` to apply a transformation
36 20 independently on each cell or :meth:`preprocess` if you prefer your own
@@ -59,6 +43,7 b' class Preprocessor(NbConvertBase):'
59 43
60 44 def __call__(self, nb, resources):
61 45 if self.enabled:
46 self.log.debug("Applying preprocessor: %s", self.__class__.__name__)
62 47 return self.preprocess(nb,resources)
63 48 else:
64 49 return nb, resources
@@ -68,9 +53,10 b' class Preprocessor(NbConvertBase):'
68 53 """
69 54 Preprocessing to apply on each notebook.
70 55
71 You should return modified nb, resources.
56 Must return modified nb, resources.
57
72 58 If you wish to apply your preprocessing to each cell, you might want
73 to overwrite preprocess_cell method instead.
59 to override preprocess_cell method instead.
74 60
75 61 Parameters
76 62 ----------
@@ -80,20 +66,16 b' class Preprocessor(NbConvertBase):'
80 66 Additional resources used in the conversion process. Allows
81 67 preprocessors to pass variables into the Jinja engine.
82 68 """
83 self.log.debug("Applying preprocess: %s", self.__class__.__name__)
84 try :
85 69 for worksheet in nb.worksheets:
86 70 for index, cell in enumerate(worksheet.cells):
87 71 worksheet.cells[index], resources = self.preprocess_cell(cell, resources, index)
88 72 return nb, resources
89 except NotImplementedError:
90 raise NotImplementedError('should be implemented by subclass')
91 73
92 74
93 75 def preprocess_cell(self, cell, resources, index):
94 76 """
95 Overwrite if you want to apply some preprocessing to each cell. You
96 should return modified cell and resource dictionary.
77 Override if you want to apply some preprocessing to each cell.
78 Must return modified cell and resource dictionary.
97 79
98 80 Parameters
99 81 ----------
@@ -1,23 +1,10 b''
1 """Module that allows latex output notebooks to be conditioned before
2 they are converted. Exposes a decorator (@cell_preprocessor) in
3 addition to the coalesce_streams pre-proccessor.
4 """
5 #-----------------------------------------------------------------------------
6 # Copyright (c) 2013, the IPython Development Team.
7 #
1 """Preprocessor for merging consecutive stream outputs for easier handling."""
2
3 # Copyright (c) IPython Development Team.
8 4 # Distributed under the terms of the Modified BSD License.
9 #
10 # The full license is in the file COPYING.txt, distributed with this software.
11 #-----------------------------------------------------------------------------
12 5
13 #-----------------------------------------------------------------------------
14 # Imports
15 #-----------------------------------------------------------------------------
16 6 import re
17 7
18 #-----------------------------------------------------------------------------
19 # Functions
20 #-----------------------------------------------------------------------------
21 8 def cell_preprocessor(function):
22 9 """
23 10 Wrap a function to be executed on all cells of a notebook
@@ -34,6 +21,11 b' def cell_preprocessor(function):'
34 21 """
35 22
36 23 def wrappedfunc(nb, resources):
24 from IPython.config import Application
25 if Application.initialized():
26 Application.instance().log.debug(
27 "Applying preprocessor: %s", function.__name__
28 )
37 29 for worksheet in nb.worksheets :
38 30 for index, cell in enumerate(worksheet.cells):
39 31 worksheet.cells[index], resources = function(cell, resources, index)
General Comments 0
You need to be logged in to leave comments. Login now