外部ツール

ローカル外部ツールを追加する

pylint は、コードをチェックし、スタイル、ロジック、使用上の問題を検出するコードアナライザーツールです。 これは、PyCharm で利用可能なコード検証機能への素晴らしい追加かもしれません。

1. メインメニューで、 表示 | ツールウィンドウ | Python パッケージ に移動して、 Python パッケージツールウィンドウを開きます。

2. 検索フィールドで「pylint」を検索し、パッケージの一覧から選択します。

3. パッケージ名の横にある インストールする をクリックし、バージョンを選択します。

   

4. システムに pylint をインストールしたため、PyCharm との統合を設定できます。

5. Ctrl+Alt+S を押して設定を開き、 ツール | 外部ツール を選択します。

6. 新しい外部ツールを追加するには、 ボタンをクリックします。

7. 次のように設定オプションを追加します。

   

   • グループ: ツール | 外部ツール メニューに表示する外部ツールグループの名前

   • 名前: 外部ツール名

   • 説明: オプションの説明

   • プログラム: pylint 実行可能ファイルへのパス（$PyInterpreterDirectory$ は、現在のプロジェクトの Python インタープリターが配置されるディレクトリです）。 例：

     $PyInterpreterDirectory$\pylint

     $PyInterpreterDirectory$/pylint (Linux, macOS)

   • 引数: チェックするファイルとフォルダー（この例では car .py と test ）を指定し、pylint エラーの出力形式を設定します。 例：

     --msg-template="$FileDir$\{path}:{line}:{column}:{C}:({symbol}){msg}" car.py test

     --msg-template="$FileDir$/{path}:{line}:{column}:{C}:({symbol}){msg}" car.py test

   • 作業ディレクトリ: プロジェクトルートディレクトリ

   • 拡張オプション セクションのすべてのオプションを有効にして、エラーのあるファイルへのリンクを pylint 出力に挿入するように 出力フィルター を設定すると、コード内のエラーや警告にすばやく移動できます。

8. 変更を保存するには、 OK をクリックします。 外部ツール ウィンドウで 適用 と OK をクリックして外部ツールを追加します。

これで ツール | 外部ツール からこの外部ツールにアクセスできます。

このメニューを使用して pylint を実行できます。 ただし、アプリケーションの 実行 / デバッグ構成に追加することもできます。

外部ツールを実行する

1. 実行 | 実行構成の編集 ... に進みます。

2. 実行 / デバッグ構成 ダイアログで、 オプションを変更 リンクをクリックし、 起動前タスクの追加 を選択します。

   

3. 新規タスクの追加 リストから 外部ツールの実行 を選択してください。

   

4. 外部ツール ダイアログで、 pylint を選択し、 OK をクリックします。 Pylint はアプリケーション起動前に実行されるスクリプト一覧に追加されます。

   

5. 実行 / デバッグ構成 ダイアログに戻り、もう一度 OK をクリックして変更を保存します。

6. Shift+F10 ショートカットまたは 実行 ボタンを使用して構成を実行します。

   スクリプトを実行すると、 実行 ツールウィンドウの pylint タブに出力が表示されます。

   

報告されたエラーをインスペクションし、対応するリンクをクリックして問題のあるコードに移動し、必要な変更を加えることができます。

リモート外部ツールを追加する

リモート SSH 外部ツールはローカルの外部ツールと同様に設定しますが、それらが実行されるリモートサーバーを定義し、SSH 経由で接続するための認証情報が必要です。

この例では、SSH を介してリモートサーバーで実行され、現在の日付と時刻を返すリモート SSH 外部ツールとして date を追加する方法を示します。

1. Ctrl+Alt+S を押して設定を開き、 ツール | リモート SSH 外部ツール を選択します。

2. をクリックして ツールの作成 ダイアログを開きます。

   

   このダイアログでは、 ローカル外部ツールを追加するときと同じ設定セットが提供されますが、リモート接続を選択することもできます。 接続設定を指定しない場合、PyCharm はサーバー上でツールを実行するたびに、ホスト、ポート、関連する SSH 資格情報を要求します。 詳細については、 リモート SSH 外部ツール を参照してください。

3. OK をクリックしてツールを追加し、変更を適用します。

追加されたツールをリモートサーバーで実行する

次のいずれかを実行します：

• メインメニューで、 Tools | Remote Tools と追加されたリモート外部ツールの名前に移動します。

• ツールを実行するためのショートカットを作成します。

  Ctrl+Alt+S を押して設定を開き、 キーマップ を選択します。 設定したリモート外部ツールの名前のアクションを見つけて、ショートカットを割り当てます。

ホスト、ポート、資格情報を指定した後、PyCharm は SSH 経由でサーバーに接続して date コマンドを実行し、PyCharm の 実行 ツールウィンドウに出力を返します。