在Ipython中使用Pylint (Jupyter-Notebook)

Question

我想在使用Jupyter-Notebook的同时运行Pylint或其他类似工具。有没有办法这样安装和运行Pylint？

Answer 1

更具体地回答这个关于pylint的问题。在开发/ ci环境(即命令行)中实现这一点的一种相对简单的方法是将notebook转换为Python，然后运行linting。

假设./notebooks文件夹中有notebooks，路径中有jupyter和pylint命令，您可以运行以下命令：

jupyter nbconvert \
    --to=script \
    --output-dir=/tmp/converted-notebooks/ \
    ./notebooks/*.ipynb
pylint /tmp/converted-notebooks/*.py

您可能希望配置pylint，因为notebook样式与常规Python模块略有不同。

您可能要禁用的一些规则：

• pointless-statement
• expression-not-assigned
• trailing-newlines
• wrong-import-position
• redefined-outer-name
• invalid-name

单元格中的最大字符数(在水平滚动之前)似乎是116，但这可能取决于其他因素。

(例如，可以使用--max-line-length和--disable pylint参数或通过.pylintrc文件配置这些选项)

Answer 2

Jupyter pycodestyle相当于pylint的Jupyter Notebook，它能够根据PEP8样式指南检查您的代码。

首先，您需要通过键入以下命令在jupyter notebook中安装pycodestyle，

!pip install pycodestyle pycodestyle_magic

在jupyter notebook的单元格中运行此命令。成功安装后，您必须将魔法加载到Jupyter Notebook cell中，如下所示：

%load_ext pycodestyle_magic

然后，您必须在想要根据PEP8标准调查代码的单元中使用pycodestyle。

下面是一些例子，以便于更多和清楚地理解。

%%pycodestyle
a=1

输出：pycodestyle将显示以下消息：

2:2: E225 missing whitespace around operator

另一个例子，

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

输出：

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

Answer 3

我建议您考虑使用nbQA工具：

pip install nbqa pylint
nbqa pylint my_notebook.ipynb

除了pylint之外，nbqa还可以轻松运行其他几种格式化程序和林特工具，并且可以通过其专用的pre-commit hooks轻松集成到您的开发工作流程中。