##// END OF EJS Templates
Merge pull request #4712 from takluyver/docs-shotgun-3...
Merge pull request #4712 from takluyver/docs-shotgun-3 Various docs fixes * Tweak exclude patterns, which were accidentally excluding qt.console.frontend_widget * Added example of adding input transformers (#4709) * Tidied up and added some module docstrings, now that we're using the first line in the API index * Update the inputsplitter module docstring, which was rather out of date. * Fix some header levels introduced in #4265 * pyreadline is apparently no longer mandatory on Windows (#4544)

File last commit:

r4609:a661b7c0
r13973:1faf2f6e merge
Show More
rwbase.py
47 lines | 1.4 KiB | text/x-python | PythonLexer
"""Base classes and function for readers and writers.
Authors:
* Brian Granger
"""
#-----------------------------------------------------------------------------
# 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 base64 import encodestring, decodestring
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------
class NotebookReader(object):
def reads(self, s, **kwargs):
"""Read a notebook from a string."""
raise NotImplementedError("loads must be implemented in a subclass")
def read(self, fp, **kwargs):
"""Read a notebook from a file like object"""
return self.reads(fp.read(), **kwargs)
class NotebookWriter(object):
def writes(self, nb, **kwargs):
"""Write a notebook to a string."""
raise NotImplementedError("loads must be implemented in a subclass")
def write(self, nb, fp, **kwargs):
"""Write a notebook to a file like object"""
return fp.write(self.writes(nb,**kwargs))