70 lines
2.4 KiB
Python
70 lines
2.4 KiB
Python
|
"""
|
||
|
|
Module containing a preprocessor that removes cells if they match
|
||
|
|
one or more regular expression.
|
||
|
|
"""
|
||
|
|
|
||
|
|
# Copyright (c) IPython Development Team.
|
||
|
|
# Distributed under the terms of the Modified BSD License.
|
||
|
|
|
||
|
|
import re
|
||
|
|
from traitlets import List, Unicode
|
||
|
|
from .base import Preprocessor
|
||
|
|
|
||
|
|
|
||
|
|
class RegexRemovePreprocessor(Preprocessor):
|
||
|
|
"""
|
||
|
|
Removes cells from a notebook that match one or more regular expression.
|
||
|
|
|
||
|
|
For each cell, the preprocessor checks whether its contents match
|
||
|
|
the regular expressions in the `patterns` traitlet which is a list
|
||
|
|
of unicode strings. If the contents match any of the patterns, the cell
|
||
|
|
is removed from the notebook.
|
||
|
|
|
||
|
|
To modify the list of matched patterns,
|
||
|
|
modify the patterns traitlet. For example, execute the following command
|
||
|
|
to convert a notebook to html and remove cells containing only whitespace::
|
||
|
|
|
||
|
|
jupyter nbconvert --RegexRemovePreprocessor.patterns="['\\s*\\Z']" mynotebook.ipynb
|
||
|
|
|
||
|
|
The command line argument
|
||
|
|
sets the list of patterns to ``'\\s*\\Z'`` which matches an arbitrary number
|
||
|
|
of whitespace characters followed by the end of the string.
|
||
|
|
|
||
|
|
See https://regex101.com/ for an interactive guide to regular expressions
|
||
|
|
(make sure to select the python flavor). See
|
||
|
|
https://docs.python.org/library/re.html for the official regular expression
|
||
|
|
documentation in python.
|
||
|
|
"""
|
||
|
|
|
||
|
|
patterns = List(Unicode(), default_value=[]).tag(config=True)
|
||
|
|
|
||
|
|
def check_conditions(self, cell):
|
||
|
|
"""
|
||
|
|
Checks that a cell matches the pattern.
|
||
|
|
|
||
|
|
Returns: Boolean.
|
||
|
|
True means cell should *not* be removed.
|
||
|
|
"""
|
||
|
|
|
||
|
|
# Compile all the patterns into one: each pattern is first wrapped
|
||
|
|
# by a non-capturing group to ensure the correct order of precedence
|
||
|
|
# and the patterns are joined with a logical or
|
||
|
|
pattern = re.compile('|'.join('(?:%s)' % pattern
|
||
|
|
for pattern in self.patterns))
|
||
|
|
|
||
|
|
# Filter out cells that meet the pattern and have no outputs
|
||
|
|
return not pattern.match(cell.source)
|
||
|
|
|
||
|
|
def preprocess(self, nb, resources):
|
||
|
|
"""
|
||
|
|
Preprocessing to apply to each notebook. See base.py for details.
|
||
|
|
"""
|
||
|
|
# Skip preprocessing if the list of patterns is empty
|
||
|
|
if not self.patterns:
|
||
|
|
return nb, resources
|
||
|
|
|
||
|
|
# Filter out cells that meet the conditions
|
||
|
|
nb.cells = [cell for cell in nb.cells if self.check_conditions(cell)]
|
||
|
|
|
||
|
|
return nb, resources
|