コマンドラインからファイルをフォーマットする
PyCharm は、設定されたコードスタイル設定に従って コードをフォーマットできます。 コマンドラインから指定したファイルにコードスタイルの書式を適用することもできます。
コマンドラインフォーマッタは、バックグラウンドで PyCharm のインスタンスを起動し、フォーマットを適用します。 PyCharm の別のインスタンスがすでに実行されている場合は動作しません。 この場合、実行中のインスタンスからコードスタイルのフォーマットを実行できます。 コマンドラインフォーマッタを使用して、多くのコントリビューターがいる大規模なコードベースの自動定期保守を行い、一貫したコーディングスタイルを確保します。
ファイルをフォーマットできるようにするには、PyCharm の対応するファイルタイプをサポートするプラグインをインストールして有効にします（たとえば、シェルスクリプトファイルをフォーマットするための Shell Script プラグイン）。
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\srcC:\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
オプション
オプション | 説明 |
|---|---|
| ヘルプメッセージを表示して終了します。 |
| 処理するファイルを定義するファイルマスクのコンマ区切りリストを指定します。 |
| 指定されたディレクトリを再帰的に処理します。 |
| フォーマットに使用するコードスタイル設定ファイルを指定します。 これは次のいずれかです。
また、フォーマッタは親ディレクトリで .editorconfig ファイルを検索し、PyCharm コードスタイル設定の上位にあるフォーマットとして適用します。 この場合、EditorConfig のフォーマット設定がコードスタイルスキームの設定と重複する場合、PyCharm は EditorConfig の設定を使用します。 残りの設定は、コードスタイルスキームから取得されます。 詳細については、 EditorConfig を使用してディレクトリレベルでコードスタイルを管理する を参照してください。 このオプションが指定されていない場合、ファイルはスキップされます。 親フォルダーの 1 つにプロジェクトがある場合、その設定は EditorConfig と同様に暗黙的に使用されます。 |
| ファイルまたはファイルのグループに対してコードスタイルが定義されていない場合、つまり |
| エンコーディングを保持し、ソースファイルの読み取りと書き込みに文字セットを適用します（例: このオプションは、コマンドライン フォーマッターがソース ファイル内の特殊文字を正しく処理できない場合に便利です。 |
| フォーマッタを検証モードで実行します。 フォーマッタはメモリ内で同じフォーマット操作を実行し、フォーマットされたファイルのいずれかが元のファイルと異なる場合、ゼロ以外のステータスで終了します。 |
をクリックして、