Visual Studio で Python コードをリントする

  • [アーティクル]

リンティング プロセスでは、Python ソース コードの言語構文とスタイルの問題が強調表示されます。 コードでリンターを実行して、見落としがちなプログラミングのミスや、エラーにつながる可能性のある従来とは異なるコーディング プラクティスを特定して修正できます。 リンティングでは、初期化されていない変数や未定義の変数の使用、未定義の関数の呼び出し、かっこの欠落、組み込み型や関数の再定義の試みなどの微妙な問題を検出できます。 リンティングは、コードの実行方法を分析してエラーを検出するのに対し、書式設定はコードの表示方法を再構築するだけなので、書式設定とは異なります。

リンティングの 2 つの一般的なオプションには、pylint と mypy があります。 これらのツールは、Python コードのエラーを確認し、適切な Python コード パターンを推奨するために広く使用されています。 どちらのツールも、Visual Studio for Python プロジェクトに統合されています。

前提条件

  • 見ることができます。 製品をインストールするには、「Visual Studio のインストール」の手順に従います。
  • Python プロジェクトにアクセスして、既存のコードでリンティング ツールを実行します。

リンターを実行する

Visual Studio のリンティング ツールは、ソリューション エクスプローラーで入手できます。

次の手順では、リンターを使用してコードを確認する方法について説明します。

  1. Visual Studio のソリューション エクスプローラーで Python プロジェクトを右クリックし、[Python] を選択して、[PyLint の実行] または [Mypy の実行] を選択します。

    ソリューション エクスプローラーの Python プロジェクトで使用可能な linting コマンドを示すスクリーンショット。

    このコマンドを使用すると、リンターが存在しない場合は、アクティブな環境内に選択したリンターをインストールするように求められます。

  2. リンターがコードで実行されたら、[エラー一覧] ウィンドウでリントの警告とエラーを確認できます。

    Visual Studio のコード ファイルの pylint エラーと警告の一覧を示すスクリーンショット。

  3. エラーまたは警告をダブルクリックして、問題が生じているソース コード内の場所に移動します。

コマンド ライン オプションを設定する

pylint と mypy の両方に、プロジェクトのリンティング設定を構成するためのコマンドライン オプションが用意されています。

このセクションでは、pylint コマンドライン オプションを使用し、.pylintrc 構成ファイルを使用して PyLint の動作を制御する例を示します。 このファイルは Visual Studio 内の Python プロジェクトのルートに配置するか、設定を適用する範囲に応じて別のフォルダーに配置します。

Python プロジェクトで .pylintrc ファイルを使用して次の手順を実行すると、前述の画像に表示されている "docstring が見つかりません" という警告が表示されないようにすることができます。

  1. コマンド ラインで、.pyproj ファイルがあるプロジェクト ルート フォルダーを参照し、次のコマンドを実行してコメント付きの構成ファイルを生成します。

    pylint --generate-rcfile > .pylintrc

  2. ソリューション エクスプローラーでプロジェクトを右クリックし、[追加]>[既存の項目] の順に選択します。

  3. ダイアログで、新しい .pylintrc ファイルを含むフォルダーを参照します。 .pylintrc ファイルを選択し、[追加] を選択します。

  4. ソリューション エクスプローラーで、.pylintrc ファイルを開いて編集します。

  5. このファイルでは、いくつかの設定を構成できます。 この例では、警告を無効にする方法を示します。

    1. [MESSAGES CONTROL] セクションを見つけて、そのセクション内の disable 設定を見つけます。

      Visual Studio の pylintrc ファイルの MESSAGES CONTROL セクションの無効設定を示すスクリーンショット。

      disable 設定は、特定のメッセージの長い文字列で構成されており、ここに目的の警告を追加できます。

    2. 文字列 ,missing-docstring (コンマ プレフィックスを含む) を disable 設定値に追加します。

      Visual Studio の pylintrc ファイルの無効設定に特定の警告メッセージを追加する方法を示すスクリーンショット。

  6. .pylintrc ファイルを保存します。

  7. pylint をもう一度実行します。 "docstring が見つかりません" という警告が表示されなくなった点に注目してください。

ネットワーク共有から pylintrc ファイルを使用する

ネットワーク共有から .pylintrcファイルを使用できます。

  1. PYLINTRC という名前の環境変数を作成します。

  2. 汎用名前付け規則 (UNC) パスまたはマッピングされたドライブ文字を使用して、ネットワーク共有上のファイル名の値を変数に割り当てます。 たとえば、PYLINTRC=\\myshare\python\.pylintrc のようにします。

関連するコンテンツ