Python のための Qodana コミュニティ
![Python Python](https://resources.jetbrains.com/help/img/qodana/2024.1/python.png)
Qodana Community for Python は PyCharm Community に基づいており、Python プロジェクトの静的分析を提供します。
サポートされているテクノロジー
Qodana Community for Python は、次のテクノロジーのインスペクションを提供します。
プログラミング言語 | Python |
マークアップ言語 | CSS HTML JSON および JSON5 RELAX NG XML YAML |
スクリプト言語 | シェルスクリプト |
データベースと ORM | MongoDB MySQL Oracle PostgreSQL SQL SQL Server |
フレームワークおよびライブラリ | Django Google App Engine Jupyter Pyramid |
サポートされている機能
Python リンターの Qodana コミュニティは、次の Qodana 機能を提供します。
フィーチャー | ライセンスに基づいて利用可能 |
---|---|
Community | |
Community | |
Community |
やってみよう
プロジェクトをローカルで分析する
プロジェクトの依存関係をインストールする
外部依存関係のない基本的な Python プロジェクトの場合、事前の手順は必要ありません。
プロジェクトに外部 pip
依存関係がある場合は、qodana.yaml
ファイルの bootstrap
キーを使用して設定できます。
例: プロジェクトの依存関係がプロジェクトルートの requirements.txt
ファイルによって指定されている場合は、qodana.yaml
に次の行を追加します。
コマンドは分析前に自動的に実行されます。
分析を実行する
Qodana には、コードのローカル分析のための 2 つのオプションが用意されています。Qodana CLI(英語) は最も簡単に開始できるオプションです。あるいは、「 」タブから Docker コマンドを使用することもできます。
マシンに Qodana CLI がすでにインストールされている(英語)と仮定すると、プロジェクトのルートディレクトリで次のコマンドを実行できます。
ここで、QODANA_TOKEN
変数はプロジェクトトークンを参照します。
ここでリンター名 jetbrains/qodana-python-community:2024.1
を省略すると、代わりに Python 用 Qodana リンターが実行されます。
まず、Docker Hub からイメージをプルします (最新バージョンを取得する場合にのみ必要です)。
source-directory
がプロジェクトのルートを指し、QODANA_TOKEN
がプロジェクトトークンを参照して、ローカル分析を開始します。
ブラウザーで Qodana クラウド(英語)を開き、インスペクションの結果を調べます。ここで分析を再構成することもできます。詳細については、インスペクションレポートセクションを参照してください。
次のステップ
関連ページ:
![](https://resources.jetbrains.com/help/img/qodana/2024.1/baseline-enabled.png)
ベースライン
ベースラインは、特定の Qodana 実行時に取得され、ファイルに含まれているコードベースの問題のスナップショットです。ベースライン機能を使用すると、現在のコードとベースラインの状態を比較し、新しい問題、変更されていない問題、解決された問題を確認できます。この機能は、Community、Ultimate、Ultimate Plus ライセンスとその試用版で利用可能なすべてのリンターでサポートされています。使い方:ベースラインなしで Qodana を実行すると、現在の実行時に検出された問題を確認...
![](https://resources.jetbrains.com/help/img/qodana/2024.1/flexinspect-how-it-works.png)
FlexInspect
IntelliJ IDEA のバージョン 2024.1 以降では、IntelliJ API と Kotlin を使用して、プロジェクト固有の独自のインスペクションを開発できます。次のことが可能です。ソースコードの PSI 表現にアクセスします。新しいインスペクションをオンザフライでデバッグします。期待どおりに動作しないコードフラグメントのハイライトなど、新しいカスタムインスペクションの動作を観察します。FlexInspect を使用すると、すべての IntelliJ IDEA および Qodana イ...
![](https://pleiades.io/icons/jetbrains_logo.png)
クオリティゲート
高品質のゲートは、コードの品質を制御し、期待される品質を満たすソフトウェアを構築できるようにする手法です。品質ゲート条件が失敗すると、Qodana は終了コード 255 を使用して終了し、CI/CD ワークフローまたはパイプラインが失敗します。例: プロジェクトの品質ゲートが 10 個の問題に設定され、コードカバレッジが 40% に設定されている場合、Qodana が 11 個目の問題またはコードカバレッジが 40% のしきい値を下回っていることが検出されると、ビルドワークフローは失敗します。品...
![](https://resources.jetbrains.com/help/img/qodana/2024.1/ui-overview.png)
インスペクションレポート
Qodana を使用すると、ローカルまたは Qodana クラウドで、インタラクティブでユーザーフレンドリーな形式でインスペクションレポートを確認できます。各レポートには次のタブが含まれています。実際の問題は、Qodana が最新のインスペクション中に検出した問題を明らかにします、ベースラインには、ベースラインとしてマークされ、それ以降修正されていない問題がリストされます。構成により、将来の使用に備えて Qodana を構成できます、ライセンス監査は