Codefolding

This extension adds codefolding functionality from CodeMirror to a codecell. This functionality is still evolving and will improve in the next versions of CodeMirror.

After clicking on the gutter (left margin of codecell) or typing Alt+F, the code gets folded. See the examples below. The folding status is saved in the cell metadata of the notebook, so reloading of a notebook will restore the folding view.

Supported modes:

Three different folding modes are supported.

Indent Folding

Python-style code folding, detetects indented code.

The unfolded code above can be folded like this:

or this:

Bracked Folding

For other languages like Javascript using brackets to designate code blocks. This works e.g. for Javascript in using the %%javsscript magic in a codecell.

Firstline Comment Folding

Allows collapsing of Python code cells to a single comment line. This is useful for long codecells. The algorithm simply looks for a comment in the first line and allows folding in the rest of the cell.

The code above can be folded like this:

Installation

Copy the codefolding directory to a new /static/custom/codefolding directory of your IPython profile and add

require(['/static/custom/codefolding/codefolding.js'])

to your custom.js file so it looks like this:

$([IPython.events]).on('app_initialized.NotebookApp', function(){
  //... 
  require(['/static/custom/codefolding/codefolding.js'])
});

Internals

You need the current master branch from Codemirror in order to get codefolding to work. This is still very much work-in-progress.

The folding information is saved in the metadata of each codecell. The number of the folding start line (beginning with 0) is stored in an array:

cell.metadata.code_folding = [ 3, 20, 33 ]

When reloading the IPython notebook, the folding status is restored.