mirror of
https://github.com/wassname/scikit-image.git
synced 2026-06-27 23:39:49 +08:00
emmanuelle
8b2dbd56e5
Removed a clumsy workaround (about paths) Fixed links to image files to fix sphinx warning. Removed non-ascii character Another non ascii character And another non-ascii character... (to be squashed later on) Corrected some typos in the docstrings of sphinx-gallery files These corrections have also been submitted as a patch to the original sphinx-gallery project (#121) Corrected the appearance of two examples of the gallery Tweaked CSS for larger images Added sphinx-gallery's license and a README.txt about the origin of this directory. Edited gabor_from_astronaut example for nicer popup PEP 8 + minor fixes Removed commented lines of code
124 lines
3.5 KiB
Python
124 lines
3.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
r"""
|
|
============================
|
|
Parser for Jupyter notebooks
|
|
============================
|
|
|
|
Class that holds the Jupyter notebook information
|
|
|
|
"""
|
|
# Author: Óscar Nájera
|
|
# License: 3-clause BSD
|
|
|
|
from __future__ import division, absolute_import, print_function
|
|
import json
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
def ipy_notebook_skeleton():
|
|
"""Returns a dictionary with the elements of a Jupyter notebook"""
|
|
py_version = sys.version_info
|
|
notebook_skeleton = {
|
|
"cells": [],
|
|
"metadata": {
|
|
"kernelspec": {
|
|
"display_name": "Python " + str(py_version[0]),
|
|
"language": "python",
|
|
"name": "python" + str(py_version[0])
|
|
},
|
|
"language_info": {
|
|
"codemirror_mode": {
|
|
"name": "ipython",
|
|
"version": py_version[0]
|
|
},
|
|
"file_extension": ".py",
|
|
"mimetype": "text/x-python",
|
|
"name": "python",
|
|
"nbconvert_exporter": "python",
|
|
"pygments_lexer": "ipython" + str(py_version[0]),
|
|
"version": '{0}.{1}.{2}'.format(*sys.version_info[:3])
|
|
}
|
|
},
|
|
"nbformat": 4,
|
|
"nbformat_minor": 0
|
|
}
|
|
return notebook_skeleton
|
|
|
|
|
|
def rst2md(text):
|
|
"""Converts the RST text from the examples docstrigs and comments
|
|
into markdown text for the Jupyter notebooks"""
|
|
|
|
top_heading = re.compile(r'^=+$\s^([\w\s-]+)^=+$', flags=re.M)
|
|
text = re.sub(top_heading, r'# \1', text)
|
|
|
|
math_eq = re.compile(r'^\.\. math::((?:.+)?(?:\n+^ .+)*)', flags=re.M)
|
|
text = re.sub(math_eq,
|
|
lambda match: r'$${0}$$'.format(match.group(1).strip()),
|
|
text)
|
|
inline_math = re.compile(r':math:`(.+)`')
|
|
text = re.sub(inline_math, r'$\1$', text)
|
|
|
|
return text
|
|
|
|
|
|
class Notebook(object):
|
|
"""Jupyter notebook object
|
|
|
|
Constructs the file cell-by-cell and writes it at the end"""
|
|
|
|
def __init__(self, file_name, target_dir):
|
|
"""Declare the skeleton of the notebook
|
|
|
|
Parameters
|
|
----------
|
|
file_name : str
|
|
original script file name, .py extension will be renamed
|
|
target_dir: str
|
|
directory where notebook file is to be saved
|
|
"""
|
|
|
|
self.file_name = file_name.replace('.py', '.ipynb')
|
|
self.write_file = os.path.join(target_dir, self.file_name)
|
|
self.work_notebook = ipy_notebook_skeleton()
|
|
self.add_code_cell("%matplotlib inline")
|
|
|
|
def add_code_cell(self, code):
|
|
"""Add a code cell to the notebook
|
|
|
|
Parameters
|
|
----------
|
|
code : str
|
|
Cell content
|
|
"""
|
|
|
|
code_cell = {
|
|
"cell_type": "code",
|
|
"execution_count": None,
|
|
"metadata": {"collapsed": False},
|
|
"outputs": [],
|
|
"source": [code.strip()]
|
|
}
|
|
self.work_notebook["cells"].append(code_cell)
|
|
|
|
def add_markdown_cell(self, text):
|
|
"""Add a markdown cell to the notebook
|
|
|
|
Parameters
|
|
----------
|
|
code : str
|
|
Cell content
|
|
"""
|
|
markdown_cell = {
|
|
"cell_type": "markdown",
|
|
"metadata": {},
|
|
"source": [rst2md(text)]
|
|
}
|
|
self.work_notebook["cells"].append(markdown_cell)
|
|
|
|
def save_file(self):
|
|
"""Saves the notebook to a file"""
|
|
with open(self.write_file, 'w') as out_nb:
|
|
json.dump(self.work_notebook, out_nb, indent=2)
|