colablinter 0.0.5

Linting and formatting Python code in Google Colab.

colablinter

Overview

colablinter is an IPython magic command extension for Jupyter and Google Colab environments.

It integrates the high-speed linter ruff and import sorter isort to perform cell-by-cell code quality and formatting checks.

Magic cell Commands

Command	Role	Description
%%cl_check	Quality Check	Displays a linting report.
%%cl_format	Format, Sort	Displays a formatting preview (for copy/paste)

After executing a magic command, the original code of the cell is executed (if applicable to the command).

Magic line Commands

Command	Role	Description
%cl_check	Quality Check	Displays a linting report for entire notebook.

Installation

Requires Python 3.12 or newer.

pip install colablinter

Usage

The extension must be explicitly loaded in the notebook session before use.

%load_ext colablinter

1. Check Code Quality

   Use %%cl_check to see linting reports.

   %%cl_check
   
   def invalid_code(x):
       return x + y # 'y' is not defined
   

   Output examples:

   ---- Code Quality & Style Check Report ----
   F821 Undefined name `y`
   --> notebook_cell.py:3:16
   |
   2 | def invalid_code(x):
   3 |     return x + y # 'y' is not defined
   |                  ^
   |
   
   Found 1 error.
   -------------------------------------------
   

2. Format code preview

   %%cl_format will display the formatted code, but the cell executes the original code.

   %%cl_format
   import sys
   import os
   def calculate_long_sum(a,b,c,d,e,f):
       return (a+b+c)*(d+e+f)  # messy
   

   Output examples:

   # Formatted Code
   import os
   import sys
   from datetime import datetime
   
   
   def calculate_long_sum(a, b, c, d, e, f):
       return (a + b + c) * (d + e + f)  # messy
   

3. Full notebook check

   Use %cl_check command to see linting reports for entire notebook.

   %cl_check