コードの再フォーマットと再配置
PyCharm を使用すると、現在のコードスタイルスキームまたは .editorconfig ファイルで指定した要件に従ってコードを再フォーマットできます。.editorconfig で定義されていないものがあれば、プロジェクト設定から取得されます。
コードの一部、ファイル全体、ファイルのグループ、ディレクトリ、モジュールを再フォーマットできます。コードの一部または一部のファイルを再フォーマットから除外することもできます。PyCharm は、Python コードの配置とフォーマットに関する PEP8(英語) の規則と要件に準拠しています。
コードフラグメントを再フォーマットする
エディターで、再フォーマットしたいコードフラグメントを選択します。
再フォーマットする前に、選択したコードに適用されているコードスタイル設定を確認できます。Alt+Enter を押してコードスタイルの設定を調整するをクリックします。
メインメニューで、に移動するか、Ctrl+Alt+L を押します。
ファイルを再フォーマットする
ファイルをエディターで開いて Ctrl+Alt+Shift+L を押すか、プロジェクトツールウィンドウでファイルを右クリックしてを選択します。
開いたファイルの整形ダイアログで、必要に応じて、次の再フォーマットオプションを選択します。
インポートの最適化 : 未使用のインポートを削除する、足りないものを追加する、インポート文を整理するには、このオプションを選択します。
エントリの再配置 : コードスタイル設定で指定された配置規則に基づいてコードを再配置する必要がある場合は、このオプションを選択します。
コードのクリーンアップ : コードクリーンアップインスペクションを実行するには、このオプションを選択します。
改行を保持しない : コードスタイルの設定に従って改行を再フォーマットします。このオプションは、設定を上書きします。
実行をクリックします。
再フォーマット中にコードに加えられた正確な変更を確認するには、ローカル履歴機能を使用します。
行のインデントを再フォーマットする
指定した設定に基づいて行のインデントを再フォーマットできます。
エディター内で、必要なコードの一部を選択して Ctrl+Alt+I を押します。
インデント設定を調整する必要がある場合は、設定ダイアログ (Ctrl+Alt+S) でに進みます。インデントを変更する言語を選択します。
タブとインデントタブで、適切なインデントオプションを指定し、OK をクリックします。
保存時にコードを自動的に再フォーマットする
変更が保存されたときに、変更されたファイルのコードを自動的に再フォーマットするように IDE を構成できます。
Ctrl+Alt+S を押して設定を開き、を選択します。
コードの整形オプションを有効にします。
さらに、IDE がコードを再フォーマットする方法を構成できます。
スコープの構成をクリックして、再フォーマットから除外するファイル名とディレクトリのパターンを指定します。
すべてのファイルタイプリストから、コードを再フォーマットするファイルのタイプを選択します。
プロジェクトがバージョン管理下にある場合は、ファイル全体または変更された行を選択します。
変更された行を選択した場合、再フォーマットは、ローカルで変更されたが、リポジトリにまだチェックインされていないコード行にのみ適用されます。
再フォーマットからファイルを除外する
ファイルとディレクトリのグループを、再フォーマット、コード配置、およびインポートの最適化から除外できます。
設定ダイアログ（Ctrl+Alt+S）で、に移動します。
フォーマッタータブに切り替え、フォーマットしないフィールドに、グロブパターン(英語)を使用して除外するファイルとディレクトリを入力します。
セミコロン
;で区切られた複数のグロブパターンを指定できます。
をクリックすると、フィールドが展開され、各パターンが別々の行に表示されます。変更を適用し、ダイアログを閉じます。
エディターでのコードフラグメントの再フォーマットからの除外
設定ダイアログ（Ctrl+Alt+S）で、に移動します。
フォーマッタータブに切り替えて、コードコメント内のマーカーでフォーマッターのオン / オフを切り替えるオプションを有効にします。
エディターで、除外する領域の先頭に、行コメント Ctrl+/ を作成し、
@formatter:offと入力します。領域の最後に、別の行コメントを作成し、@formatter:onと入力します。マーカー間のコードは再フォーマットされません。
既存のフォーマットを保持
コードを再フォーマットするときに無視されるフォーマット規則を選択できます。例: 単純なメソッドや関数を 1 行に収めるように IDE を調整することができますが、通常はコードの再フォーマット後に複数行に展開されます。
メインメニューでに移動し、プログラミング言語を選択して、折り返しと波括弧タブを開きます。
整形時の保持セクションで、無視したいフォーマット規則を選択し、適用するものを選択解除します。
コードを再フォーマットする (Ctrl+Alt+L).
PyCharm は現在のスタイル設定に従ってあなたのコードを再フォーマットし、選択したルールのための既存のフォーマットを維持します。
Python コードを Black で再フォーマットする
Black(英語) を使用して、Python コードを PyCharm でフォーマットできます。システムまたはプロジェクトインタープリターに Black がインストールされている場合は、次のいずれかの通知が表示されます。
Black の構成
以下のいずれか 1 つを実行します:
通知ポップアップで「構成」をクリックします。
設定ダイアログ (Ctrl+Alt+S) の に移動します。
実行モードドロップダウンで、PyCharm が Black フォーマッタを実行する方法を選択します。
バイナリモードでは、システムにインストールされている Black 実行可能ファイルが使用されます。実行可能ファイルが見つからない場合は、
アイコンをクリックしてパスを指定できます。
パッケージモードでは、PyCharm はプロジェクトインタープリターにインストールされている Black パッケージを使用します。ブラックをインストールをクリックすると、選択したインタープリターの Black パッケージをインストールできます。
Black フォーマッタをいつ実行するかを選択します。
Ctrl+Alt+L を押すか、メインメニューからを選択するときに、組み込みフォーマッタの代わりに Black を使用するには、コードの再フォーマットについてチェックボックスを有効にします。
変更を保存するときに Black フォーマッタを自動的に実行する場合は、保存時を選択します。他のアクションを設定するには、「保存時のすべてのアクション」をクリックします。
Black フォーマッタの設定は pyproject.toml で行うことができます。ブラック v21.4.0 以上の場合、自動的に適用されます。詳細については、Black のドキュメント(英語)を参照してください。
設定フィールドを使用して、追加のオプションを指定したり、pyproject.toml の設定をオーバーライドしたりできます。
詳細については、ブラック CLI リファレンス(英語)を参照してください。
コードの再配置
設定ダイアログのコードスタイルページで設定された配置ルールに従ってコードを再配置できます。
コードエントリの並べ替え
設定ダイアログ（Ctrl+Alt+S）で、に移動します。
配置規則を作成する言語を選択します。
配置タブで、グループ化ルールや一致ルールなどの適切なオプションを指定します。
変更を保存するには、OK をクリックします。
エディターで、再配置するコードエントリを選択し、メインメニューのに移動します。
関連ページ：
コードスタイルの構成
特定のコーディングガイドラインが企業内に存在する場合は、ソースコードを作成する際に、このガイドラインに従わなければなりません。PyCharm は、必要なコードスタイルを維持できます。IDE には、プロジェクトスキームとデフォルトスキームの 2 つの定義済みスキームが付属しています。プロジェクトスキームでは、構成する設定は現在のプロジェクトにのみ適用されます。これらの設定は、.idea の codeStyles フォルダーに保存され、VCS を介してプロジェクトと共有されます。プロジェクトのコードスタイ...
ファイルの再フォーマットダイアログ
現在のファイルのエディターでを押すとダイアログが表示されます。メインメニューからを選択するかを押すと、PyCharm は指定されたスコープのソースコードを自動的に再フォーマットしようとします。再フォーマット、またはフォーマットからのファイルの除外の詳細については、「コードの再フォーマットと再配置」を参照してください。VCS にコミットされていない変更のみこのチェックボックスが選択されている場合、再フォーマットは、ローカルで変更されたが、リポジトリにまだチェックインされていないコードにのみ適用...
ローカル履歴
ローカル履歴は、バージョン管理とは関係なく、プロジェクトに加えられたすべての変更を常に追跡できます。コミット間で行われた違いのみを追跡するバージョン管理システムとは異なり、ローカルヒストリーにはさらに多くの機能があります。コードの編集、テストの実行、アプリケーションのデプロイなどを行うと、プロジェクトの状態が自動的に記録され、IDE と外部の両方から行われたすべての意味のある変更のリビジョンが維持されます。ローカルヒストリーを使用すると、個人のバージョン管理システムとして機能し、プロジェクトでバ...
自動インポート
インポートされていないクラスを参照すると、PyCharm はこのファイルを見つけてインポートのリストに追加できます。設定に応じて、単一のクラスまたはパッケージ全体をインポートできます。import ステートメントが imports セクションに追加されますが、キャレットは現在の位置から移動せず、現在の編集セッションは中断されません。この機能はインポートアシスタントとして知られています。インポートアシスタントの使用は、PyCharm でのインポートを処理するための推奨される方法です。これは、インポ...
コードスタイル
スキーム：この領域では、コードスタイルスキームを選択し、必要に応じて変更します。コードスタイルスキームの設定は、PyCharm がコードを生成、リファクタリング、再フォーマットするたびに自動的に適用されます。IDE には、プロジェクトスキームとデフォルトスキームの 2 つの定義済みスキームが付属しています。プロジェクトスキームでは、構成する設定は現在のプロジェクトにのみ適用されます。これらの設定は、.idea の codeStyles フォルダーに保存され、VCS を介してプロジェクトと共有されます...
パート 6. Django 固有のナビゲーション
Django プラグインを有効にするこの機能は、デフォルトで PyCharm にバンドルされて有効になっている Django プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インストール済みタブを開き、Django プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。最後に、Django 固有のナビゲーションについて説明します。Pyramid や Flask などの他のフレーム...