PyLint を使用した Python コードのチェックUsing PyLint to check Python code

Visual Studio for Python プロジェクトには PyLint が組み込まれています。これは広く用いられている Python コードのエラー チェックツールで、優れた Python のコード パターンを作成するのに役立ちます。PyLint, a widely used tool that checks for errors in Python code and encourages good Python coding patterns, is integrated into Visual Studio for Python projects.

使用するには、ソリューション エクスプローラーで Python プロジェクトを右クリックし、[Python] > [Run PyLint (PyLint の実行)] を選択するだけです。Just right-click a Python project in Solution Explorer and select Python > Run PyLint...:

Python プロジェクトのコンテキスト メニューに表示された PyLint コマンド

このコマンドを使用すると、PyLint が存在しない場合は、アクティブな環境内に PyLint をインストールするように求められます。Using this command prompts you to install PyLint into your active environment if it's not already present.

PyLint の警告とエラーが [エラー一覧] ウィンドウに表示されます。PyLint warnings and errors appear in the Error List window:

PyLint のエラー一覧

エラーをダブルクリックすると、問題が発生したソース コードに直接移動できます。Double-clicking an error takes you directly to the source code that generated the issue.

ヒント

PyLint のすべての出力メッセージの詳細な一覧については、PyLint の機能のリファレンスに関するページをご覧ください。See the PyLint features reference for a detailed list of all the PyLint output messages.

PyLint コマンド ライン オプションの設定Setting PyLint command-line options

PyLint ドキュメントのコマンド ライン オプションのセクションでは、.pylintrc 構成ファイルを使用して PyLint の動作を制御する方法が説明されています。The command-line options section of the PyLint documentation describes how to control PyLint's behavior through a .pylintrc configuration file. このようなファイルは Visual Studio 内の Python プロジェクトのルートに配置するか、設定を適用したい範囲に応じて他の場所に配置します。Such a file can be placed in the root of a Python project in Visual Studio or elsewhere depending on how widely you want those settings applied.

たとえば、前の画像に表示されている "docstring が見つかりません" という警告がプロジェクト内の .pylintrc ファイルに対して表示されないようにするには、次の手順を実行します。For example, to suppress the "missing docstring" warnings shown in the previous image with a .pylintrc file in a project, do the steps:

  1. コマンド ラインで、プロジェクトのルート (.pyproj ファイルが含まれる) に移動し、次のコマンドを実行してコメント付きの構成ファイルを生成します。On the command line, navigate to your project root (which contains your .pyproj file) and run the following command to generate a commented configuration file:

    pylint --generate-rcfile > .pylintrc
    
  2. Visual Studio のソリューション エクスプローラーでプロジェクトを右クリックし、[追加] > [既存の項目] を選択します。新しい .pylintrc ファイルを見つけて選択し、[追加] を選択します。In Visual Studio Solution Explorer, right-click your project, select Add > Exiting Item..., navigate to and select the new .pylintrc file, and select Add.

  3. ファイルを編集のために開くと、操作できる各種の設定が表示されます。Open the file for editing, which contains a variety of settings you can work with. 警告を無効にするには、[MESSAGES CONTROL] セクションを探し、そのセクションの disable 設定を見つけます。To disable a warning, locate the [MESSAGES CONTROL] section, then locate the disable setting in that section. 特定のメッセージからなる長い文字列が表示されます。ここに目的の警告を追加できます。There is a long string of specific messages, to which you can append whichever warnings you want. この例では、,missing-docstring (区切りコンマを含む) を追加します。In the example here, append ,missing-docstring (including the delineating comma).

  4. .pylintrc ファイルを保存し、PyLint をもう一度実行して、警告が表示されなくなったことを確認します。Save the .pylintrc file and run PyLint again to see that the warnings are now suppressed.