How to display line numbers in IPython Notebook code cell by default

Question

I would like my default display for IPython notebook code cells to include line numbers.

I learned from Showing line numbers in IPython/Jupyter Notebooks that I can toggle this with ctrl-M L, which is great, but manual. In order to include line numbers by default, I would need to add something to my ipython_notebook_config.py file. Unless I’ve missed something, there is not an explanation of how to do this in the documentation.

Asked By: khstacking

||

Source

Answer 1

In your custom.js file (location depends on your OS) put

IPython.Cell.options_default.cm_config.lineNumbers = true;

If you can’t find custom.js, you can just search for it, but generally it will be in your profile_default folder. If it doesn’t exist, create the file at $(ipython locate profile)/static/custom/custom.js

If for whatever reason that doesn’t work, you can always edit the custom.js file in the site-packages/IPython/html/static/custom/ in the same way.

Answered By: William Denman

Answer 2

(For Jupyter 4+) In the latest Jupyter versions, they have documented the place to make config changes. So basically, in the Jupyter update, they’ve removed the concept of profiles, so the custom.js file location is now .jupyter/custom/custom.js, depending on where your .jupyter folder is. So if you don’t have a custom folder or the custom.js file, just create them, then put these lines into the newly created file:

define([
    'base/js/namespace',
    'base/js/events'
    ], 
    function(IPython, events) {
        events.on("app_initialized.NotebookApp", 
            function () {
                require("notebook/js/cell").Cell.options_default.cm_config.lineNumbers = true;
            }
        );
    }
);

The above is for setting line numbers to all your cell types at the same time. Code, Markdown and Raw cells will all get line numbers if you do this. If you want line numbers only for code cells, there is a simpler approach. Select a code cell, open the Chrome/Firefox JavaScript console, type the following lines:

var cell = Jupyter.notebook.get_selected_cell();
var config = cell.config;
var patch = {
    CodeCell:{
        cm_config:{lineNumbers:true}
    }
}
config.update(patch)

Then reload the page. These changes persist because Jupyter will create a json config file in .jupyter/nbconfig to store them. This method is from this page of the documentation, so read the docs for more config changes that you can make.

(old answer)

In the latest version of IPython Notebook (v3.1.0), go to ~/.ipython/<profile_name>/static/custom/custom.js and add these lines:

define([
    'base/js/namespace',
    'base/js/events'
    ], 
    function(IPython, events) {
        events.on("app_initialized.NotebookApp", 
            function () {
                IPython.Cell.options_default.cm_config.lineNumbers = true;
            }
        );
    }
);

The IPython.Cell.options_default.cm_config.lineNumbers = true; line alone will not work as it needs to load the IPython.Cell object before it tries this. Adding this line alone will cause an undefined error in the console. You need to encase it in the event handler as shown.

@William-Denman’s code might have worked for an earlier version, but now you will need to do this.

EDIT: The line of code right in the middle has to be changed to require("notebook/js/cell").Cell.options_default.cm_config.lineNumbers = true; for the latest version of IPython/Jupyter (IPython 4.0.0, Jupyter 4.0.6). The old IPython.Cell object will also work, but your web console will throw a deprecation warning, so you can expect the old line to not be supported in future versions.

Also, in the latest IPython/Jupyter, which I’m running using the WinPython portable, I couldn’t find the custom.js file within the profile folder. I found it (after much searching) in WinPython-64bit-2.7.10.3python-2.7.10.amd64Libsite-packagesnotebookstaticcustom. I don’t know if this is a WinPython thing or a Jupyter thing. If someone has Jupyter (latest version) installed normally (using pip or whatever) and can still find the custom.js file in the profile folder, please comment.

Answered By: Mindstormer619

Answer 3

Above didn’t work for me in 2018

I found that inside ~/.jupyter/nbconfig/notebook.json I needed to add to add the following lines:

"CodeCell": {
  "cm_config": {
  "lineNumbers": true
}

inside the object that was there. So the final object would look like:

{
  "CodeCell": {
    "cm_config": {
      "lineNumbers": true
    }
  }
}

Answered By: Stephen C

How to display line numbers in IPython Notebook code cell by default

Question:

Answers:

Above didn’t work for me in 2018