Python で pylint を使用する方法 (pylint コード検査)_python

Pylint は、Python コードを分析する簡単な方法を提供し、その高い構成可能性により、部門内の人々が統一されたコーディング スタイルを簡単に使用できるようになります。 この記事では、理論的な紹介と例の分析を通じて、Pylint がどのように Python コードを標準化できるかを説明します。 1. 潜在的な問題コードとは何ですか。

Pylint は、通常のコード分析ツールの機能に加えて、コード行の長さ、変数名が命名標準に準拠しているかどうか、宣言されたインターフェイスが実際にあるかどうかを確認するなど、より多くの機能を提供します。実装など。

Pylint の大きな利点は、高度に構成可能で、高度にカスタマイズ可能であり、機能を追加するための小さなプラグインを簡単に作成できることです。 Pylint を 2 回実行すると、現在と最後の実行の結果が同時に表示されるため、コードの品質が向上したかどうかを確認できます。 Pylint は現在、Eclipse の pydev プラグインにも統合されています。

2. Linux への Pylint のインストール

1. Linux では、まず Python パッケージ (バージョン 2.2 以降) をインストールし、環境変数 $PATH に Python 実行可能ファイルへのパスを追加します。

2. Pylint、logilab-astng (バージョン >= 0.14) および logilab-common (バージョン >= 0.13) のパッケージをダウンロードし、tar zxvf *.tar.gz を使用してこれらのパッケージを解凍します。

3. logilab-astng、logilab-common、Pylint が解凍されたフォルダーに順に入力し、Python setup.py install コマンドを実行してインストールします。 4. インストールが完了したら、pylint [options] module_or_package を通じて Pylint を呼び出すことができます。

3. Windows への Pylint のインストール


1. Python パッケージ (バージョン 2.2 以降) をインストールし、デスクトップの [マイ コンピューター] アイコンを右クリックし、$PATH で [プロパティ]、[詳細設定]、[環境変数] を選択します。 Python のパス (C:Python26 など)。

2. 解凍ツールを使用してすべてのパッケージを解凍します。

3. コマンド ライン ウィンドウを開き、cd を使用して logilab-astng、logilab-common、Pylint の解凍されたフォルダーに順番に入力し、コマンド python setup.py install を実行してインストールします。 4. インストールが完了すると、Python インストール パスに Scripts フォルダーが表示されます。このフォルダーには、pylint.bat などのいくつかの Bat スクリプトが含まれています。 5. pylint.bat を呼び出すときにフルパスを入力しないようにするには、pylint.bat のリダイレクト ファイルを Python インストール ディレクトリに作成します。これは、pylint.bat の実際のパスを含むプレーン テキスト ファイルです。 . 、C:\Python26Scriptspylint.bat など。

6. インストールが完了したら、pylint [options] module_or_package を通じて Pylint を呼び出すことができます。

4. pylint を使用します


Pylint を使用してモジュール module.py のコードを確認します:

1. モジュールが存在するフォルダーに入り、pylint [options] module.py

現在の作業ディレクトリが Python パスに自動的に追加されるため、この呼び出しメソッドはいつでも機能します。

2. モジュールが配置されているフォルダーを入力せずに、

pylint [options] directory/module.py を実行しますpylint [options] module.py

这种调用方式是一直可以工作的，因为当前的工作目录会被自动加入 Python 的路径中。

2. 不进入模块所在的文件夹，运行

pylint [options] directory/module.py

这种调用方式当如下条件满足的时候是可以工作的：directory 是个 Python 包 ( 比如包含一个 __init__.py 文件 )，或者 directory 被加入了 Python 的搜索路径中。  

使用 Pylint 对一个包 pakage 进行代码检查：

1. 进入这个包所在文件夹，运行

pylint [options] pakage

 这种调用方式是一直可以工作的，因为当前的工作目录会被自动加入 Python 的路径中。

2. 不进入包所在的文件夹，运行

pylint [options] directory/ pakage

この呼び出しメソッドは、次の条件が満たされている場合に機能します。 Python パッケージ (たとえば、__init__.py ファイルを含む) またはディレクトリが Python 検索パスに追加されます。

Pylint を使用してパッケージのコードを確認します:

1. パッケージが存在するフォルダーに入り、pylint [options] pakage を実行します

🎜 この呼び出しメソッドは常に機能します。現在の作業ディレクトリが Python パスに自動的に追加されるためです。 🎜🎜2. パッケージが置かれているフォルダーを入力せずに、🎜🎜pylint [options] directory/pakage を実行します🎜🎜 この場合、次の条件が満たされている場合に機能します: ディレクトリが追加されているPython のパス。たとえば、Linux では、PYTHONPATH=$PYTHONPATH: ディレクトリをエクスポートします。 🎜さらに、tkinter パッケージがインストールされているマシンの場合、コマンド pylint-gui を使用して単純な GUI インターフェイスを開き、ここにモジュールまたはパッケージの名前を入力し (ルールはコマンドラインと同じです)、「実行」をクリックします。と、Pylint の出力が GUI に表示されます。 🎜🎜🎜5. Pylintの共通コマンドラインパラメータ🎜🎜

-h,--help : すべてのヘルプ情報を表示します。
--generate-rcfile: pylint --generate-rcfile を使用してサンプル構成ファイルを生成できます。リダイレクトを使用して、後で使用できるようにこの構成ファイルを保存できます。他のオプションを前に追加して、これらのオプションの値が生成された構成ファイルに含まれるようにすることもできます。 例: pylint --persistent=n --generate-rcfile > pylint.conf を見ると、persistent=no がデフォルト値の yes ではなくなっていることがわかります。
--rcfile= :設定ファイルを指定します。使用する構成を構成ファイルに含めると、独自のコードが標準化されるだけでなく、これらの仕様を他のユーザーと簡単に共有できるようになります。
-i , --include-ids= : 出力にメッセージ ID を含め、pylint --help-msg= を使用してこのエラーの詳細を表示します。これにより、エラーを具体的に見つけることができます。
-r , --reports= : デフォルトは y で、Pylint の出力にはソースコード分析部分だけでなくレポート部分も含まれることを意味します。
--files-output= : 各モジュール/パッケージのメッセージを pylint_module/package.[txt|html] という名前のファイルに出力します。レポートがある場合は、pylint_global.[ txt] という名前のファイルに出力します。 |html] ファイル。デフォルトでは、ファイルではなく画面に出力されます。
-f , --output-format= : 出力形式を設定します。選択できる形式は、テキスト、解析可能、カラー化、msvs (ビジュアル スタジオ)、および html です。デフォルトの出力形式はテキストです。
--disable-msg= : 指定された ID のメッセージを無効にします。たとえば、出力に警告メッセージ W0402 を表示したくない場合は、--disable-msg を使用できます。 = W0402

6. Pylint の出力

Pylint のデフォルトの出力形式は、-f 、--output-format= を通じて指定できます。すぐ。

Pylint の出力には、ソース コード分析部分とレポート部分の 2 つの部分があります。
ソース コード分析部分:
各 Python モジュールについて、Pylint の結果には最初にいくつかの「*」文字が表示され、その後にモジュールの名前が表示され、その後に一連のメッセージが表示されます。メッセージの形式は次のとおりです: __MESSAGE_TYPE: LINE_NUM: [OBJECT :] MESSAGE__ MESSAGE_TYPE には次のタイプがあります:

(C) 規約。コーディング スタイル標準
(R) リファクタリングに違反します。非常に貧弱に書かれたコード。
(W) 警告。 Python 固有の質問。
(E) エラー。おそらくコードのバグです。
(F) 致命的なエラー。 Pylint のそれ以上の実行を妨げるエラー。

レポート セクション:

ソース コード分析が完了すると、各カテゴリのメッセージ数、モジュールの依存関係など、プロジェクトの特定の側面に焦点を当てた一連のレポートが作成されます。 。

具体的には、レポートには次の側面が含まれます: チェックされたモジュールの数。 各モジュールのエラーと警告の割合。
たとえば、2 つのモジュール A と B があります。A に 1 つのエラー、B に 3 つのエラーがあり、合計 4 つのエラーが検出された場合、A のエラーの割合は 25%、B のエラーの割合は75%。 エラーと警告の合計数。

Python で pylint を使用する方法

Eclipse IDE で、[ウィンドウ] -> [設定...] ダイアログ ボックスを開き、右側のツリー リストから [PyDev] -> [Interpreter Python] を選択し、 [新しい] ボタンをクリックし、Python インストール パスから Python.exe を選択すると、システム PYTHONPATH を確認するように求めるダイアログ ボックスが表示されます。私は両方を選択したので、問題ありません。最後に「OK」をクリックして終了します。

1. Django プロジェクトの開発を構成します1. PyDev プロジェクトを確立します

Eclipse IDE——>ファイル——>新規——>その他——>Pydev——> ——> プロジェクトに名前を付けます (デモなど) ——> 適切な Python バージョンを選択します (私の場合は 2.5)。下のマークを付けて、src ファイルを作成しないでください—>終了。

2. Django プロジェクトを作成します

(1) django-admin.py startproject デモ。 (コマンドラインで django-admin.py を直接使用することはできないようですが、C:/Python26/Scripts/django-admin.py を使用する必要があるようです。後で、C:/Python26/Scripts を Path に追加する必要があることを知りました) .)

(2) 生成された Django プロジェクト ディレクトリを、Eclipse で作成したプロジェクト配下のディレクトリにコピーします。ここで Elicpse IDE に戻ります—> PyDev パッケージ ビューで新しく作成したプロジェクトのデモを更新して、Django プロジェクトを表示します。ファイルとディレクトリの追加と削除は、右クリック メニューから実行できます。

3. Django プロジェクトのエンジニアリング構成

(1) プロジェクトを右クリックします—>プロパティ—>PyDev-PYTHONPATH を選択—>ソース フォルダーを追加します (プロジェクトに追加するプロジェクト ファイルのパスを選択します)コード—>OK

(2) Pydev プロジェクトを構成します:

Pydev プロジェクト名を選択します——>実行形式——>実行ダイアログを開く——>Python 実行——>新規を右クリック——>メイン パネルにプロジェクト名を書き込み、プロジェクト名をロードします参照してメイン モジュールを選択し、メイン モジュールとして manage.py を選択します—> [拡張] パネルで、引数に runserver --noreload と入力し、次の作業ディレクトリをベース ディレクトリに追加します。

2. Django プロジェクトのデバッグ設定

は開発設定と似ていますが、具体的な操作は次のとおりです:
(1) プロジェクトを右クリック —>Debug as ——> ;デバッグダイアログを開きます。
(2) メインウィンドウでmanage.pyが配置されているプロジェクトを選択し、メインモジュールでmanage.pyが配置されているファイルの場所を選択します。
(3) 引数に runserver --noreload を入力します。
(4)環境にDJANGO_SETTINGS_MODULE=settings,PYTHONPATH=$PWDを追加します。

3. pylint を設定する

1. pylint の概要

Pylint は主に PY コードを分析し、コード内のエラーを見つけ、コーディング スタイルのヒントを提供するために使用されます。つまり、その機能は、コードを PEP 008 (http://www.python.org/dev/peps/pep-0008/) タイトル: Style Guide for Python Code で説明されているコード スタイルに近づけることです。コードが統一され、読みやすくなります。

2. pylintをダウンロードしてインストールします

pylint、logilab-astng、logilab-common インストール方法はdjangoのインストールと同じです。つまり、python setup.py install を直接使用するだけです。 Y 3. Pylint を設定します
(1) ウィンドウ -& GT; Pydev -& Pylint を選択し、「C:/Python25」などの Lint.py のアドレスを入力します。 /Lib/Site -packages/pylint/lint.py"

(2) そして、最後の編集ボックスにパラメーターを追加して、pylint の出力を制限します。 perties-＆gt; pydev-pythonpathは、プロジェクトのソースファイルディレクトリを「プロジェクトソースフォルダー」に追加しました。
(4) [プロジェクト] -> [自動的にビルド] を選択すると、変更を保存するときに pylint がプロジェクト内のコードを自動的にチェックします。それ以外の場合は、Ctrl+B を使用して pylint を手動でビルドしてトリガーする必要があります。

参考ドキュメント:

http://pydev.org/manual_adv_pylint.html

関連推奨事項:

Python コードスタイルを標準化する方法 (IBM より)_pyトン

Python コードチェックツール pylint を使用すると、Python がより標準化されます

以上がPython で pylint を使用する方法 (pylint コード検査)_pythonの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。