ipypublish.postprocessors.stream_modify module¶
postprocessors that modify the output stream
-
class
ipypublish.postprocessors.stream_modify.
FilterOutputFiles
(*args, **kwargs)[source]¶ Bases:
ipypublish.postprocessors.base.IPyPostProcessor
filter internal files in resources[‘outputs’], by those that are referenced in the stream
-
property
allowed_mimetypes
¶ override in subclasses
return a list of allowed mime types if None, then all are allowed
Text based mime-types include: text/plain, text/latex, text/restructuredtext, text/html, text/x-python, application/json, text/markdown, text/asciidoc, text/yaml
-
property
logger_name
¶ override in subclass
-
property
requires_path
¶ override in subclasses
whether the prostprocessor requires the supplied filepath to have an existing parent directory
if True and filepath is None, will raise an IOError, otherwise, will try to make the directory if it doesn’t exist
-
run_postprocess
(stream, mimetype, filepath, resources)[source]¶ should not be called directly override in sub-class
- Parameters
stream (
str
) – the main file contentsfilepath (
None
orpathlib.Path
) – the path to the output fileresources (
dict
) – a resources dict, output from exporter.from_notebook_node
- Returns
stream (
str
)filepath (
None
orpathlib.Path
)resources (
dict
)
-
property
-
class
ipypublish.postprocessors.stream_modify.
FixSlideReferences
(*args, **kwargs)[source]¶ Bases:
ipypublish.postprocessors.base.IPyPostProcessor
make sure references refer to correct slides
-
property
allowed_mimetypes
¶ override in subclasses
return a list of allowed mime types if None, then all are allowed
Text based mime-types include: text/plain, text/latex, text/restructuredtext, text/html, text/x-python, application/json, text/markdown, text/asciidoc, text/yaml
-
property
logger_name
¶ override in subclass
-
property
requires_path
¶ override in subclasses
whether the prostprocessor requires the supplied filepath to have an existing parent directory
if True and filepath is None, will raise an IOError, otherwise, will try to make the directory if it doesn’t exist
-
run_postprocess
(stream, mimetype, filepath, resources)[source]¶ should not be called directly override in sub-class
- Parameters
stream (
str
) – the main file contentsfilepath (
None
orpathlib.Path
) – the path to the output fileresources (
dict
) – a resources dict, output from exporter.from_notebook_node
- Returns
stream (
str
)filepath (
None
orpathlib.Path
)resources (
dict
)
-
property
-
class
ipypublish.postprocessors.stream_modify.
RemoveBlankLines
(*args, **kwargs)[source]¶ Bases:
ipypublish.postprocessors.base.IPyPostProcessor
remove multiple lines of blank space
-
property
allowed_mimetypes
¶ override in subclasses
return a list of allowed mime types if None, then all are allowed
Text based mime-types include: text/plain, text/latex, text/restructuredtext, text/html, text/x-python, application/json, text/markdown, text/asciidoc, text/yaml
-
property
logger_name
¶ override in subclass
-
property
requires_path
¶ override in subclasses
whether the prostprocessor requires the supplied filepath to have an existing parent directory
if True and filepath is None, will raise an IOError, otherwise, will try to make the directory if it doesn’t exist
-
run_postprocess
(stream, mimetype, filepath, resources)[source]¶ should not be called directly override in sub-class
- Parameters
stream (
str
) – the main file contentsfilepath (
None
orpathlib.Path
) – the path to the output fileresources (
dict
) – a resources dict, output from exporter.from_notebook_node
- Returns
stream (
str
)filepath (
None
orpathlib.Path
)resources (
dict
)
-
property
-
class
ipypublish.postprocessors.stream_modify.
RemoveTrailingSpace
(*args, **kwargs)[source]¶ Bases:
ipypublish.postprocessors.base.IPyPostProcessor
remove trailing whitespace on each line
-
property
allowed_mimetypes
¶ override in subclasses
return a list of allowed mime types if None, then all are allowed
Text based mime-types include: text/plain, text/latex, text/restructuredtext, text/html, text/x-python, application/json, text/markdown, text/asciidoc, text/yaml
-
property
logger_name
¶ override in subclass
-
property
requires_path
¶ override in subclasses
whether the prostprocessor requires the supplied filepath to have an existing parent directory
if True and filepath is None, will raise an IOError, otherwise, will try to make the directory if it doesn’t exist
-
run_postprocess
(stream, mimetype, filepath, resources)[source]¶ should not be called directly override in sub-class
- Parameters
stream (
str
) – the main file contentsfilepath (
None
orpathlib.Path
) – the path to the output fileresources (
dict
) – a resources dict, output from exporter.from_notebook_node
- Returns
stream (
str
)filepath (
None
orpathlib.Path
)resources (
dict
)
-
property