Run any Python code quality tool on a Jupyter Notebook!
Project description
nbQA
Adapter to run any code-quality tool on a Jupyter notebook. This is intended to be run as a pre-commit hook and/or during continuous integration.
Documentation is hosted here.
Installation
Install nbqa with pip:
$ pip install nbqaQuickstart
The general syntax is
nbqa <command> <notebook or directory> <args>where command is any standard Python code quality tool.
Examples
Check static type annotations:
$ nbqa mypy tweet-sentiment-roberta-pytorch.ipynb --ignore-missing-imports
tweet-sentiment-roberta-pytorch.ipynb:cell_10:5: error: Argument "batch_size" to "get_test_loader" has incompatible type "str"; expected "int"Check any examples in your docstrings are correct:
$ nbqa pytest tweet-sentiment-roberta-pytorch.ipynb --doctest-modules
============================= test session starts ==============================
platform linux -- Python 3.8.2, pytest-5.4.3, py-1.9.0, pluggy-0.13.1
rootdir: /home/marco/tweet-sentiment-extraction
plugins: cov-2.10.0
collected 3 items
tweet-sentiment-roberta-pytorch.ipynb . [100%]
============================== 1 passed in 0.03s ===============================Format your notebooks using black:
$ nbqa black . --line-length=96 --nbqa-mutate
reformatted tweet-sentiment-roberta-pytorch.ipynb
All done! ✨ 🍰 ✨
1 files reformatted.Configuration
You can configure nbQA either at the command line, or by using a .nbqa.ini file. We’ll see some examples below.
Extra flags
If you wish to pass extra flags (e.g. --ignore W503 to flake8) you can either run
nbqa flake8 my_notebook.ipynb --ignore W503or you can put the following in your .nbqa.ini file
[flake8]
addopts = --ignore W503Config file
If you already have a config file for your third-party tool (e.g. .mypy.ini for mypy), you can run
nbqa mypy my_notebook.ipynb --nbqa-config .mypy.inior you can put the following in your .nbqa.ini file
[mypy]
config = .mypy.iniAllow mutations
By default, nbQA won’t modify your notebooks. If you wish to let your third-party tool modify your notebooks, you can
either pass the --nbqa-mutate flag at the command-line, e.g.
nbqa black my_notebook.ipynb --nbqa-mutateor you can put the following in your .nbqa.ini file
[black]
mutate = 1Usage as pre-commit hook
If you want to use nbqa with pre-commit, here’s an example of what you
could add to your .pre-commit-config.yaml file:
- repo: https://github.com/nbQA-dev/nbQA
rev: 0.1.21
hooks:
- id: nbqa
args: ['flake8']
name: nbqa-flake8
alias: nbqa-flake8
additional_dependencies: ['flake8']
- id: nbqa
args: ['isort', '--nbqa-mutate']
name: nbqa-isort
alias: nbqa-isort
additional_dependencies: ['isort']
- id: nbqa
args: ['mypy']
name: nbqa-mypy
alias: nbqa-mypy
additional_dependencies: ['mypy']Supported third party packages
In theory, nbqa can adapt any Python code-quality tool to a Jupyter Notebook.
In practice, here are the tools it’s been tested with:
See Also
Here are some other code quality tools for Jupyter Notebooks:
nbstripout (clear notebook cells’ outputs);
jupyterlab_code_formatter (Jupyter Lab plugin);
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
