PyCharm 2024.2 ヘルプ

コマンドラインからコードインスペクションを実行する

PyCharm はコードインスペクションを実行して、構文エラー、デッドコード、考えられるバグ、不適切なコーディングスタイル、その他の問題を見つけてハイライトします。コマンドラインから特定のプロジェクト用に構成されたすべてのインスペクションを実行し、結果をレポート付きの XML、JSON、プレーンテキストファイルとして保存することもできます。

コマンドラインインスペクターは、インスペクションを実行するバックグラウンドで PyCharm のインスタンスを起動します。PyCharm の別のインスタンスがすでに実行されている場合は機能しません。この場合、実行中のインスタンスでインスペクションを使用できます。コマンドラインインスペクターを使用して、多くのコントリビューターがいる大規模プロジェクトの自動化された定期的なコード分析を行います。

PyCharm を実行するための実行可能ファイルは、bin のインストールディレクトリにあります。この実行可能ファイルをコマンドラインランチャーとして使用するには、コマンドラインインターフェースの説明に従って、システム PATH に追加します。

構文
pycharm64.exe inspect <project> <inspection-profile> <output> [<options>]
サンプル

最大の詳細度で C:\MyProject\.idea\inspectionProfiles\MyProfile.xml プロファイルを使用して C:\MyProject プロジェクトの C:\MyProject\src ディレクトリをインスペクションし、結果を C:\MyProject\InspectionResults の XML ファイルに保存します。

pycharm64.exe inspect C:\MyProject C:\MyProject\.idea\inspectionProfiles\MyProfile.xml C:\MyProject\InspectionResults -v2 -d C:\MyProject\src

PyCharm には、コマンドラインコードインスペクターを実行するためのスクリプトが含まれています。デフォルトでは、アプリケーションパッケージ PyCharm.app/Contents/bin/inspect.sh にあります。

構文
inspect.sh <project> <inspection-profile> <output> [<options>]
サンプル

最大の詳細度で ~/MyProject/.idea/inspectionProfiles/MyProfile.xml プロファイルを使用して ~/MyProject プロジェクトの ~/MyProject/src ディレクトリをインスペクションし、結果を ~/MyProject/InspectionResults の XML ファイルに保存します。

inspect.sh ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src

PyCharm を実行するためのスクリプトは、bin のインストールディレクトリにあります。このスクリプトをコマンドラインランチャーとして使用するには、コマンドラインインターフェースの説明に従って、システム PATH にスクリプトを追加します。

構文
pycharm.sh inspect <project> <inspection-profile> <output> [<options>]
サンプル

最大の詳細度で ~/MyProject/.idea/inspectionProfiles/MyProfile.xml プロファイルを使用して ~/MyProject プロジェクトの ~/MyProject/src ディレクトリをインスペクションし、結果を ~/MyProject/InspectionResults の XML ファイルに保存します。

pycharm.sh inspect ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src

オプション

オプション

説明

-changes

ローカルのコミットされていない変更に対してのみインスペクションを実行します。

-d

プロジェクト全体をインスペクションしたくない場合は、サブディレクトリへのフルパスを指定します。

-format

インスペクションの結果で出力ファイルの形式を指定します: xml (デフォルト)、jsonplain

-v

出力の詳細レベルを設定します。

  • -v0 はデフォルトの低冗長度です。

  • -v1 は中程度の詳細度です。

  • -v2 は最大の冗長性です。

インスペクションプロファイル

インスペクションプロファイルは、有効なインスペクションとそのオプションを指定する .xml ファイルです。

デフォルトでは、プロジェクトインスペクションプロファイルはプロジェクトディレクトリ .idea/inspectionProfiles に保存されます。

グローバル IDE インスペクションプロファイルは、inspectionIDE 構成ディレクトリに保管されます。

インスペクション結果

インスペクションで生成された XML ファイルを開くと、PyCharm または任意のテキストエディターが通常のファイルとして表示されます。ただし、問題ツールウィンドウオフラインビューを使用して分析する方が便利です。

インスペクションの結果を見る

  1. インスペクションを実行したプロジェクトを開きます。

  2. メインメニューでコード | コードの解析 | オフラインインスペクション結果を表示に移動します

  3. インスペクションの結果が含まれるディレクトリを選択し、OK をクリックします。

関連ページ:

コードインスペクション

PyCharm には、プロジェクト内の異常なコードを検出して修正する一連のコードインスペクションがあります。IDE は、さまざまな問題を見つけてハイライトし、デッドコードを見つけ、考えられるバグやスペルの問題を見つけ、全体的なコード構造を改善することができます。インスペクションは、すべてのプロジェクトファイルまたは特定のスコープでのみ(たとえば、本番コードまたは変更されたファイルでのみ)コードをスキャンできます。すべてのインスペクションには、問題がコードに影響を与える可能性がある程度の重大度レベ...

コマンドラインインターフェース

コマンドラインから PyCharm 機能を使用します: ファイルとプロジェクトを開き、差分を表示し、ファイルをマージし、コードスタイルを適用し、フォーマットし、ソースコードをインスペクションします。スタンドアロンインスタンスのランチャー:インストールディレクトリには、PyCharm を起動し、ソースコードをフォーマットし、インスペクションを実行するためのバッチスクリプトと実行可能ファイルが含まれています。コマンドプロンプト cmd.exe から使用するには、PyCharmbin フォルダーの場所を環...

プロファイルを構成する

インスペクションプロファイルは、有効なインスペクション、これらのインスペクションが分析するファイルのスコープ、およびインスペクション重大度設定に関する情報を保持します。PyCharm には、2 種類のプロファイルがあります。プロファイル IDE に保管は、PyCharm 構成ディレクトリの inspection フォルダーに保存され、すべてのプロジェクトで使用できます。プロジェクトにコピーオプションを使用して、IDE プロファイルを現在のプロジェクトにコピーできます。プロファイルプロジェクトに保管は、....

IDE で使用されるディレクトリ

デフォルトでは、PyCharm は、各 IDE インスタンスのユーザー固有のファイル(構成、キャッシュ、プラグイン、ログなど)をユーザーのホームディレクトリに保存します。ただし、必要に応じて、これらのファイルを保存する場所を変更できます。IDE ディレクトリの場所を変更するたとえば、ユーザープロファイルドライブの容量が不足している場合や低速ディスクにある場合、ホームディレクトリが暗号化されている(IDE の速度が低下している)場合、またはネットワークドライブにある場合は、デフォルトの IDE デ...

問題ツールウィンドウ

問題ツールウィンドウには、PyCharm がプロジェクト内で検出した問題がいくつかのタブを使用して表示されます。ウィンドウ内で問題を選択してを押すか、問題をダブルクリックしてエディター内の対応する行に移動します。ツールウィンドウのタブを切り替えるには、とを押します。設計時コードインスペクションが有効になっている場合、このタブには、現在のファイルで見つかったすべてのコードの問題が一覧表示されます。エディターでファイルを切り替えると、リストが更新されます。ツールバー:表示オプション重大度でコ

コマンドラインからプラグインをインストールする

JetBrains マーケットプレイスまたはカスタムプラグインリポジトリからプラグイン ID を使用してプラグインをインストールします。PyCharm を実行するための実行可能ファイルは、bin のインストールディレクトリにあります。この実行可能ファイルをコマンドラインランチャーとして使用するには、コマンドラインインターフェースの説明に従って、システムに追加します。構文 pycharm64.exe installPlugins <plugin-id ...> [repository-ur...