How to use Pylint or other linters with Jupyter Notebooks?

Question

Is it possible to have a linter inside of a Jupyter Notebook?

Answer 1

• Yes it is possible
• You can install pycodestyle for Jupyter Notebook which is similar to pylint. You can use the below commands from inside a Jupyter Notebook shell:

# install
!pip install pycodestyle pycodestyle_magic


# load
%load_ext pycodestyle_magic


# use
%%pycodestyle
def square_of_number(
     num1, num2, num3, 
     num4):
    return num1**2, num2**2, num3*

# Output
2:1: E302 expected 2 blank lines, found 0
3:23: W291 trailing whitespace

• Check this question out for more details. My answer is inspired by the answers in the link.
• Check out this question for more similar linters and solutions.

Answer 2

Yes - you can run any standard Python code quality tool on a Jupyter Notebook using nbQA

e.g.:

pip install -U nbqa pylint
nbqa pylint notebook.ipynb

disclaimer: I"m the author of nbQA