Package PyFoam :: Package IPythonHelpers :: Module Notebook :: Class Notebook
[hide private]
[frames] | no frames]

Class Notebook

source code


Class that represents an IPython-notebook in memory

Instance Methods [hide private]
 
__addCell(self, **kwargs) source code
 
__init__(self, input=None, nbformat=3, nbformat_minor=0, name=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__iter__(self) source code
 
__len__(self) source code
 
_cells(self) source code
 
addCode(self, input, collapsed=False, language=u'python', **kwargs) source code
 
addHeading(self, title, level=1, **kwargs) source code
 
addMarkdown(self, text, **kwargs) source code
 
addRaw(self, text, **kwargs) source code
 
pyFoamMetaData(self)
Our very own metadata-dictionary
source code
 
reset(self, new) source code
 
writeToFile(self, fName) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]
  name
  raw

Inherited from object: __class__

Method Details [hide private]

__init__(self, input=None, nbformat=3, nbformat_minor=0, name=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • input - If this is a string then it is interpreted as a filename. Otherwise as a filehandle. If unset then an empty notebook is contructed
  • name - name of the notebook. Only used if a new notebook is created
Overrides: object.__init__

Property Details [hide private]

name

Get Method:
unreachable.name(self)
Set Method:
unreachable.name(self, newName)

raw

Get Method:
unreachable.raw(self)