Use logger string formatting, add some docstrings

IPython/nbformat/current.py

@@ -1,228 +1,237 b''
 """The official API for working with notebooks in the current format version.
 
 Authors:
 
 * Brian Granger
 * Jonathan Frederic
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from __future__ import print_function
 
 from xml.etree import ElementTree as ET
 import re
 
 from IPython.utils.py3compat import unicode_type
 
 from IPython.nbformat.v3 import (
     NotebookNode,
     new_code_cell, new_text_cell, new_notebook, new_output, new_worksheet,
     parse_filename, new_metadata, new_author, new_heading_cell, nbformat,
     nbformat_minor, nbformat_schema, to_notebook_json
 )
 from IPython.nbformat import v3 as _v_latest
 
 from .reader import reads as reader_reads
 from .reader import versions
 from .convert import convert
 from .validator import validate
 
 import logging
 logger = logging.getLogger('NotebookApp')
 
 #-----------------------------------------------------------------------------
 # Code
 #-----------------------------------------------------------------------------
 
 current_nbformat = nbformat
 current_nbformat_minor = nbformat_minor
 current_nbformat_module = _v_latest.__name__
 
 
 def docstring_nbformat_mod(func):
     """Decorator for docstrings referring to classes/functions accessed through
     nbformat.current.
 
     Put {nbformat_mod} in the docstring in place of 'IPython.nbformat.v3'.
     """
     func.__doc__ = func.__doc__.format(nbformat_mod=current_nbformat_module)
     return func
 
 
 class NBFormatError(ValueError):
     pass
 
 
 def parse_py(s, **kwargs):
     """Parse a string into a (nbformat, string) tuple."""
     nbf = current_nbformat
     nbm = current_nbformat_minor
     
     pattern = r'# <nbformat>(?P<nbformat>\d+[\.\d+]*)</nbformat>'
     m = re.search(pattern,s)
     if m is not None:
         digits = m.group('nbformat').split('.')
         nbf = int(digits[0])
         if len(digits) > 1:
             nbm = int(digits[1])
 
     return nbf, nbm, s
 
 
 def reads_json(s, **kwargs):
-    """Read a JSON notebook from a string and return the NotebookNode object."""
+    """Read a JSON notebook from a string and return the NotebookNode
+    object. Report if any JSON format errors are detected.
+
+    """
     nbjson = reader_reads(s)
     num_errors = validate(nbjson)
     if num_errors > 0:
         logger.error(
-            "Notebook JSON is invalid (%d errors detected)" % num_errors)
+            "Notebook JSON is invalid (%d errors detected)",
+            num_errors)
     return convert(nbjson, current_nbformat)
 
 
 def writes_json(nb, **kwargs):
+    """Take a NotebookNode object and write out a JSON string. Report if
+    any JSON format errors are detected.
+
+    """
     nbjson = versions[current_nbformat].writes_json(nb, **kwargs)
     num_errors = validate(nbjson)
     if num_errors > 0:
         logger.error(
-            "Notebook JSON is invalid (%d errors detected)" % num_errors)
+            "Notebook JSON is invalid (%d errors detected)",
+            num_errors)
     return nbjson
 
 
 def reads_py(s, **kwargs):
     """Read a .py notebook from a string and return the NotebookNode object."""
     nbf, nbm, s = parse_py(s, **kwargs)
     if nbf in (2, 3):
         nb = versions[nbf].to_notebook_py(s, **kwargs)
     else:
         raise NBFormatError('Unsupported PY nbformat version: %i' % nbf)
     return nb
 
 
 def writes_py(nb, **kwargs):
     # nbformat 3 is the latest format that supports py
     return versions[3].writes_py(nb, **kwargs)
 
 
 # High level API
 
 
 def reads(s, format, **kwargs):
     """Read a notebook from a string and return the NotebookNode object.
 
     This function properly handles notebooks of any version. The notebook
     returned will always be in the current version's format.
 
     Parameters
     ----------
     s : unicode
         The raw unicode string to read the notebook from.
     format : (u'json', u'ipynb', u'py')
         The format that the string is in.
 
     Returns
     -------
     nb : NotebookNode
         The notebook that was read.
     """
     format = unicode_type(format)
     if format == u'json' or format == u'ipynb':
         return reads_json(s, **kwargs)
     elif format == u'py':
         return reads_py(s, **kwargs)
     else:
         raise NBFormatError('Unsupported format: %s' % format)
 
 
 def writes(nb, format, **kwargs):
     """Write a notebook to a string in a given format in the current nbformat version.
 
     This function always writes the notebook in the current nbformat version.
 
     Parameters
     ----------
     nb : NotebookNode
         The notebook to write.
     format : (u'json', u'ipynb', u'py')
         The format to write the notebook in.
 
     Returns
     -------
     s : unicode
         The notebook string.
     """
     format = unicode_type(format)
     if format == u'json' or format == u'ipynb':
         return writes_json(nb, **kwargs)
     elif format == u'py':
         return writes_py(nb, **kwargs)
     else:
         raise NBFormatError('Unsupported format: %s' % format)
 
 
 def read(fp, format, **kwargs):
     """Read a notebook from a file and return the NotebookNode object.
 
     This function properly handles notebooks of any version. The notebook
     returned will always be in the current version's format.
 
     Parameters
     ----------
     fp : file
         Any file-like object with a read method.
     format : (u'json', u'ipynb', u'py')
         The format that the string is in.
 
     Returns
     -------
     nb : NotebookNode
         The notebook that was read.
     """
     return reads(fp.read(), format, **kwargs)
 
 
 def write(nb, fp, format, **kwargs):
     """Write a notebook to a file in a given format in the current nbformat version.
 
     This function always writes the notebook in the current nbformat version.
 
     Parameters
     ----------
     nb : NotebookNode
         The notebook to write.
     fp : file
         Any file-like object with a write method.
     format : (u'json', u'ipynb', u'py')
         The format to write the notebook in.
 
     Returns
     -------
     s : unicode
         The notebook string.
     """
     return fp.write(writes(nb, format, **kwargs))
 
 def _convert_to_metadata():
     """Convert to a notebook having notebook metadata."""
     import glob
     for fname in glob.glob('*.ipynb'):
         print('Converting file:',fname)
         with open(fname,'r') as f:
             nb = read(f,u'json')
         md = new_metadata()
         if u'name' in nb:
             md.name = nb.name
             del nb[u'name']            
         nb.metadata = md
         with open(fname,'w') as f:
             write(nb, f, u'json')