mirror of
https://github.com/wassname/scikit-image.git
synced 2026-06-29 10:12:05 +08:00
Merge pull request #1 from stefanv/ipython-notebookcreation
Refactor IPython notebook export
This commit is contained in:
sharky93
+35
-92
@@ -4,7 +4,9 @@ import json
|
||||
import copy
|
||||
import warnings
|
||||
|
||||
sample = """{
|
||||
|
||||
# Skeleton notebook in JSON format
|
||||
skeleton_nb = """{
|
||||
"metadata": {
|
||||
"name":""
|
||||
},
|
||||
@@ -30,36 +32,9 @@ sample = """{
|
||||
}"""
|
||||
|
||||
|
||||
def _remove_consecutive_duplicates(x):
|
||||
"""Remove duplicates of elements appearing consecutively.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x : list
|
||||
Input list.
|
||||
|
||||
Returns
|
||||
-------
|
||||
modified_x : list
|
||||
Output list, with no consecutive duplicates.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> input = [1, 2, 3, 3, 4, 5, 6, 6]
|
||||
>>> output = remove_consecutive_duplicates(input)
|
||||
>>> output
|
||||
[1, 2, 3, 4, 5, 6]
|
||||
|
||||
class Notebook(object):
|
||||
"""
|
||||
modified_x = [x[0]] + [x[i] for i in range(1, len(x)) if x[i] != x[i-1]]
|
||||
return modified_x
|
||||
|
||||
|
||||
class Notebook():
|
||||
"""
|
||||
Notebook object for generating an IPython notebook from an example Python
|
||||
file.
|
||||
|
||||
Notebook object for building an IPython notebook cell-by-cell.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
@@ -84,6 +59,7 @@ class Notebook():
|
||||
]
|
||||
}
|
||||
|
||||
self.template = json.loads(skeleton_nb)
|
||||
self.cell_type = {'input': self.cell_code, 'source': self.cell_md}
|
||||
self.valuetype_to_celltype = {'code': 'input', 'markdown': 'source'}
|
||||
|
||||
@@ -93,10 +69,9 @@ class Notebook():
|
||||
Parameters
|
||||
----------
|
||||
value : str
|
||||
The actual content to be saved in the cell.
|
||||
Cell content.
|
||||
cell_type : {'code', 'markdown'}
|
||||
The type of content.
|
||||
The default value will add a cell of type 'code'.
|
||||
Type of content (default is 'code').
|
||||
|
||||
"""
|
||||
if cell_type in ['markdown', 'code']:
|
||||
@@ -106,78 +81,46 @@ class Notebook():
|
||||
# assign value to the last cell
|
||||
cells[-1][key] = value
|
||||
else:
|
||||
warnings.warn('Unsupported cell type %s, data ignored' % cell_type)
|
||||
warnings.warn('Ignoring unsupported cell type (%s)' % cell_type)
|
||||
|
||||
def json(self):
|
||||
"""Dump the template JSON to string.
|
||||
"""Return a JSON representation of the notebook.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
The template JSON converted to a string with a two char indent.
|
||||
JSON notebook.
|
||||
|
||||
"""
|
||||
return json.dumps(self.template, indent=2)
|
||||
|
||||
|
||||
def python_to_notebook(example_file, notebook_path):
|
||||
"""Convert a Python file to an IPython notebook.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
example_file : str
|
||||
Path for source Python file.
|
||||
notebook_path : str
|
||||
Path for saving the notebook file (includes the filename).
|
||||
|
||||
"""
|
||||
def test_notebook_basic():
|
||||
nb = Notebook()
|
||||
with open(example_file, 'r') as pythonfile:
|
||||
nb.template = json.loads(sample)
|
||||
nb.code = pythonfile.readlines()
|
||||
# Add an extra newline at the end,
|
||||
# this aids in extraction of text segments
|
||||
nb.code.append('\n')
|
||||
assert(json.loads(nb.json()) == json.loads(skeleton_nb))
|
||||
|
||||
# Newline separated portions in example file, are sections.
|
||||
# Code and markdown written together in such a section are further
|
||||
# treated as different segments. Each cell has content from one
|
||||
# segment.
|
||||
docstring = False
|
||||
source = []
|
||||
|
||||
code = _remove_consecutive_duplicates(nb.code)
|
||||
def test_notebook_add():
|
||||
nb = Notebook()
|
||||
|
||||
for line in code:
|
||||
# A linebreak indicates a segment has ended.
|
||||
# If the text segment had only comments, ignore the blank source as
|
||||
# already added in cell type markdown
|
||||
if line == '\n':
|
||||
if source:
|
||||
# we've found text segments within the docstring
|
||||
if docstring:
|
||||
nb.add_cell(source, 'markdown')
|
||||
else:
|
||||
nb.add_cell(source, 'code')
|
||||
source = []
|
||||
# if it's a comment
|
||||
elif line.strip().startswith('#'):
|
||||
line = line.lstrip(' #')
|
||||
nb.add_cell(line, 'markdown')
|
||||
elif line == '"""\n':
|
||||
if not docstring:
|
||||
docstring = True
|
||||
# Indicates, completion of docstring
|
||||
# add whatever in source to markdown (cell type markdown)
|
||||
elif docstring:
|
||||
docstring = False
|
||||
# Write leftover docstring if any left
|
||||
if source:
|
||||
nb.add_cell(source, 'markdown')
|
||||
source = []
|
||||
else:
|
||||
# some text segment is continuing, so add to source
|
||||
source.append(line)
|
||||
str1 = 'hello world'
|
||||
str2 = 'f = lambda x: x * x'
|
||||
|
||||
with open(notebook_path, 'w') as output:
|
||||
output.write(nb.json())
|
||||
nb.add_cell(str1, cell_type='markdown')
|
||||
nb.add_cell(str2, cell_type='code')
|
||||
|
||||
d = json.loads(nb.json())
|
||||
cells = d['worksheets'][0]['cells']
|
||||
values = [c['input'] if c['cell_type'] == 'code' else c['source']
|
||||
for c in cells]
|
||||
|
||||
assert values[1] == str1
|
||||
assert values[2] == str2
|
||||
|
||||
assert cells[1]['cell_type'] == 'markdown'
|
||||
assert cells[2]['cell_type'] == 'code'
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
import numpy.testing as npt
|
||||
npt.run_module_suite()
|
||||
|
||||
+22
-3
@@ -80,7 +80,9 @@ from skimage import io
|
||||
from skimage import transform
|
||||
from skimage.util.dtype import dtype_range
|
||||
|
||||
from notebook import python_to_notebook
|
||||
from notebook import Notebook
|
||||
|
||||
from docutils.core import publish_parts
|
||||
|
||||
|
||||
LITERALINCLUDE = """
|
||||
@@ -326,7 +328,8 @@ def write_example(src_name, src_dir, rst_dir, cfg):
|
||||
rst_path = rst_dir.pjoin(basename + cfg.source_suffix)
|
||||
notebook_path = notebook_dir.pjoin(basename + '.ipynb')
|
||||
|
||||
if _plots_are_current(src_path, image_path) and rst_path.exists and notebook_path.exists:
|
||||
if _plots_are_current(src_path, image_path) and rst_path.exists and \
|
||||
notebook_path.exists:
|
||||
return
|
||||
|
||||
blocks = split_code_and_text_blocks(example_file)
|
||||
@@ -374,7 +377,23 @@ def write_example(src_name, src_dir, rst_dir, cfg):
|
||||
else:
|
||||
shutil.copy(cfg.plot2rst_default_thumb, thumb_path)
|
||||
|
||||
python_to_notebook(example_file, notebook_path)
|
||||
# Export example to IPython notebook
|
||||
nb = Notebook()
|
||||
|
||||
for (cell_type, _, content) in blocks:
|
||||
content = content.rstrip('\n')
|
||||
|
||||
if cell_type == 'code':
|
||||
nb.add_cell(content, cell_type='code')
|
||||
else:
|
||||
content = content.replace('"""', '')
|
||||
content = '\n'.join([line for line in content.split('\n') if
|
||||
not line.startswith('.. image')])
|
||||
html = publish_parts(content, writer_name='html')['html_body']
|
||||
nb.add_cell(html, cell_type='markdown')
|
||||
|
||||
with open(notebook_path, 'w') as f:
|
||||
f.write(nb.json())
|
||||
|
||||
|
||||
def save_thumbnail(image, thumb_path, shape):
|
||||
|
||||
Reference in New Issue
Block a user