PyCharm 2024.3 ヘルプ

コマンドラインからファイルをフォーマットする

PyCharm は、構成されたコードスタイル設定に従ってコードをフォーマットできます。コマンドラインから指定したファイルにコードスタイルの書式を適用することもできます。

コマンドラインフォーマッタは、バックグラウンドで PyCharm のインスタンスを起動し、フォーマットを適用します。PyCharm の別のインスタンスがすでに実行されている場合は機能しません。この場合、実行中のインスタンスからコードスタイルのフォーマットを実行できます。コマンドラインフォーマッタを使用して、多くのコントリビューターがいる大規模なコードベースの自動定期保守を行い、一貫したコーディングスタイルを確保します。

ファイルをフォーマットできるようにするには、PyCharm の対応するファイルタイプをサポートするプラグインをインストールして有効にします(たとえば、シェルスクリプトファイルをフォーマットするシェルスクリプトプラグイン)。

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

構文
pycharm64.exe format [<options>] <path ...>
サンプル

デフォルトのコードスタイル設定を使用して、C:\Data\src ディレクトリから 2 つの特定のファイルをフォーマットします。

pycharm64.exe format -allowDefaults C:\Data\src\hello.html C:\Data\src\world.html

デフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む C:\Data\src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。

pycharm64.exe format -allowDefaults -r C:\Data\src

C:\Data\settings.xml のコードスタイル設定を使用して、C:\Data\src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。

pycharm64.exe format -s C:\Data\settings.xml -m *.xml,*.html C:\Data\src

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

構文
./format.sh [<options>] <path ...>
サンプル

デフォルトのコードスタイル設定を使用して、~/Data/src ディレクトリから 2 つの特定のファイルをフォーマットします。

./format.sh -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html

デフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む ~/Data/src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。

./format.sh -allowDefaults -r ~/Data/src

~/Data/settings.xml のコードスタイル設定を使用して、~/Data/src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。

./format.sh -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

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

構文
pycharm.sh format [<options>] <path ...>
サンプル

デフォルトのコードスタイル設定を使用して、~/Data/src ディレクトリから 2 つの特定のファイルをフォーマットします。

pycharm.sh format -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html

デフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む ~/Data/src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。

pycharm.sh format -allowDefaults -r ~/Data/src

~/Data/settings.xml のコードスタイル設定を使用して、~/Data/src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。

pycharm.sh format -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

オプション

オプション

説明

-h

ヘルプメッセージを表示して終了します。

-m|-mask

処理するファイルを定義するファイルマスクのコンマ区切りリストを指定します。* (任意の文字列)および ? (任意の 1 文字)ワイルドカードを使用できます。

-r|-R

指定されたディレクトリを再帰的に処理します。

-s|-settings

フォーマットに使用するコードスタイル設定ファイルを指定します。これは次のいずれかです。

  • エクスポートされたコードスタイル設定を含むファイル: 設定 Ctrl+Alt+Sエディター | コードスタイルページを開き、The Show Scheme Actions button をクリックして、エクスポートを選択します。

  • プロジェクトディレクトリに格納されている .idea/codeStyleSettings.xml ファイル(PyCharm バージョン 2017.2 以前の場合)。

  • プロジェクトディレクトリに格納されている .idea/codeStyles/Project.xml ファイル(PyCharm バージョン 2017.3 以降用)。

また、フォーマッタは親ディレクトリで .editorconfig ファイルを検索し、PyCharm コードスタイル設定に基づいてフォーマットに適用します。この場合、EditorConfig のフォーマットがコードスタイルスキームの設定と重複する場合、PyCharm は EditorConfig の設定を使用します。残りの設定は、コードスタイルスキームから取得されます。詳細については、EditorConfig を使用してディレクトリレベルでコードスタイルを管理するを参照してください。

このオプションが指定されていない場合、ファイルはスキップされます。親フォルダーの 1 つにプロジェクトがある場合、その設定は EditorConfig と同様に暗黙的に使用されます。

-allowDefaults

ファイルまたはファイルのグループに対してコードスタイルが定義されていない場合、つまり -s が設定されておらず、ファイルがどのプロジェクトにも属していない場合は、デフォルトのコードスタイル設定を使用します。それ以外の場合、ファイルは無視されます。

-charset

エンコーディングを保持し、ソースファイルの読み取りと書き込みに文字セットを適用します(例: -charset ISO-8859-15)。

このオプションは、コマンドラインフォーマッタがソースファイル内の特殊文字を正しく処理できない場合に役立ちます。

-d|-dry

フォーマッタを検証モードで実行します。フォーマッタはメモリ内で同じフォーマット操作を実行し、フォーマットされたファイルのいずれかが元のファイルと異なる場合、ゼロ以外のステータスで終了します。

関連ページ:

コードの再フォーマットと再配置

PyCharm を使用すると、現在のコードスタイルスキームまたは .editorconfig ファイルで指定した要件に従ってコードを再フォーマットできます。で定義されていないものがあれば、プロジェクト設定から取得されます。コードの一部、ファイル全体、ファイルのグループ、ディレクトリ、モジュールを再フォーマットできます。また、コードの一部または一部のファイルを再フォーマットから除外することもできます。PyCharm は、Python コードの配置とフォーマットに関する PEP 8 のルールと要件に準拠して...

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

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

コードスタイルの構成

特定のコーディングガイドラインが企業内に存在する場合は、ソースコードを作成する際に、このガイドラインに従わなければなりません。PyCharm は、必要なコードスタイルを維持できます。IDE には、プロジェクトスキームとデフォルトスキームの 2 つの定義済みスキームが付属しています。プロジェクトスキームでは、構成する設定は現在のプロジェクトにのみ適用されます。これらの設定は、.idea の codeStyles フォルダーに保存され、VCS を介してプロジェクトと共有されます。プロジェクトのコードスタイ...

コマンドラインからファイルをマージする

マージダイアログを開いて、コマンドラインから 3 方向または 2 方向のマージを実行します。PyCharm を実行するための実行可能ファイルは、bin のインストールディレクトリにあります。この実行可能ファイルをコマンドラインランチャーとして使用するには、コマンドラインインターフェースの説明に従って、システムに追加します。構文 pycharm64.exe merge <path1> <path2> [<base>] <output> サンプル 3 者間マー...