mirror of
https://github.com/wassname/jupyter_contrib_nbextensions.git
synced 2026-07-29 11:21:37 +08:00
117 lines
4.8 KiB
Python
117 lines
4.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import os
|
|
|
|
import nbformat.v4 as nbf
|
|
from nbconvert import LatexExporter, RSTExporter
|
|
from nbconvert.utils.pandoc import PandocMissing
|
|
from nose.plugins.skip import SkipTest
|
|
from nose.tools import assert_in, assert_not_in, assert_true
|
|
from traitlets.config import Config
|
|
|
|
|
|
def path_in_data(rel_path):
|
|
"""Return an absolute path from a relative path in tests/data."""
|
|
return os.path.join(os.path.dirname(__file__), 'data', rel_path)
|
|
|
|
|
|
def export_through_preprocessor(
|
|
notebook_node, preproc_cls, exporter_class, export_format):
|
|
"""Export a notebook through a given preprocessor."""
|
|
exporter = exporter_class(
|
|
preprocessors=[preproc_cls.__module__ + '.' + preproc_cls.__name__],
|
|
config=Config(NbConvertApp={'export_format': export_format}))
|
|
try:
|
|
return exporter.from_notebook_node(notebook_node)
|
|
except PandocMissing:
|
|
raise SkipTest("Pandoc wasn't found")
|
|
|
|
|
|
def test_preprocessor_pymarkdown():
|
|
"""Test python markdown preprocessor."""
|
|
# check import shortcut
|
|
from jupyter_contrib_nbextensions.nbconvert_support import PyMarkdownPreprocessor # noqa
|
|
notebook_node = nbf.new_notebook(cells=[
|
|
nbf.new_code_cell(source="a = 'world'"),
|
|
nbf.new_markdown_cell(source="Hello {{ a }}",
|
|
metadata={"variables": {" a ": "world"}}),
|
|
])
|
|
body, resources = export_through_preprocessor(
|
|
notebook_node, PyMarkdownPreprocessor, RSTExporter, 'rst')
|
|
expected = 'Hello world'
|
|
assert_in(expected, body, 'first cell should contain {}'.format(expected))
|
|
|
|
|
|
def test_preprocessor_codefolding():
|
|
"""Test codefolding preprocessor."""
|
|
# check import shortcut
|
|
from jupyter_contrib_nbextensions.nbconvert_support import CodeFoldingPreprocessor # noqa
|
|
notebook_node = nbf.new_notebook(cells=[
|
|
nbf.new_code_cell(source='\n'.join(["# Codefolding test 1",
|
|
"'AXYZ12AXY'"]),
|
|
metadata={"code_folding": [0]}),
|
|
nbf.new_code_cell(source='\n'.join(["# Codefolding test 2",
|
|
"def myfun():",
|
|
" 'GR4CX32ZT'"]),
|
|
metadata={"code_folding": [1]}),
|
|
])
|
|
body, resources = export_through_preprocessor(
|
|
notebook_node, CodeFoldingPreprocessor, RSTExporter, 'rst')
|
|
assert_not_in('AXYZ12AXY', body, 'check firstline fold has worked')
|
|
assert_not_in('GR4CX32ZT', body, 'check function fold has worked')
|
|
|
|
|
|
def test_preprocessor_svg2pdf():
|
|
"""Test svg2pdf preprocessor for markdown cell svg images in latex/pdf."""
|
|
# check import shortcut
|
|
from jupyter_contrib_nbextensions.nbconvert_support import SVG2PDFPreprocessor # noqa
|
|
from jupyter_contrib_nbextensions.nbconvert_support.pre_svg2pdf import (
|
|
get_inkscape_executable_path)
|
|
if not get_inkscape_executable_path():
|
|
raise SkipTest('No inkscape executable found')
|
|
|
|
notebook_node = nbf.new_notebook(cells=[
|
|
nbf.new_markdown_cell(
|
|
source=''.format(path_in_data('test.svg')))
|
|
])
|
|
body, resources = export_through_preprocessor(
|
|
notebook_node, SVG2PDFPreprocessor, LatexExporter, 'latex')
|
|
|
|
pdf_path = path_in_data('test.pdf')
|
|
pdf_existed = os.path.isfile(pdf_path)
|
|
if pdf_existed:
|
|
os.remove(pdf_path)
|
|
assert_true(pdf_existed, 'exported pdf should exist')
|
|
assert_in('test.pdf', body,
|
|
'exported pdf should be referenced in exported notebook')
|
|
|
|
|
|
def test_preprocessor_collapsible_headings():
|
|
"""Test collapsible_headings preprocessor."""
|
|
# check import shortcut
|
|
from jupyter_contrib_nbextensions.nbconvert_support import CollapsibleHeadingsPreprocessor # noqa
|
|
cells = []
|
|
for lvl in range(6, 1, -1):
|
|
for collapsed in (True, False):
|
|
cells.extend([
|
|
nbf.new_markdown_cell(
|
|
source='{} {} heading level {}'.format(
|
|
'#' * lvl,
|
|
'Collapsed' if collapsed else 'Uncollapsed',
|
|
lvl),
|
|
metadata={'heading_collapsed': True} if collapsed else {}),
|
|
nbf.new_markdown_cell(source='\n'.join([
|
|
'want hidden' if collapsed else 'want to see',
|
|
'what I mean',
|
|
])),
|
|
nbf.new_code_cell(source='\n'.join([
|
|
'want hidden' if collapsed else 'want to see',
|
|
'what I mean',
|
|
])),
|
|
])
|
|
notebook_node = nbf.new_notebook(cells=cells)
|
|
body, resources = export_through_preprocessor(
|
|
notebook_node, CollapsibleHeadingsPreprocessor, RSTExporter, 'rst')
|
|
assert_not_in('hidden', body, 'check text hidden by collapsed headings')
|
|
assert_in('want to see', body, 'check for text under uncollapsed headings')
|