PyCharm 2020.3 ヘルプ

コードスタイルの構成

特定のコーディングガイドラインが企業内に存在する場合は、ソースコードを作成する際に、このガイドラインに従わなければなりません。PyCharm は、必要なコードスタイルを維持できます。

コードスタイルは、プロジェクトレベルIDE レベル(グローバル)で定義されます。

  • プロジェクトレベルでは、設定はプロジェクトスキームにグループ化されます。これは事前定義されており、太字でマークされています。プロジェクトスタイルスキームは現在のプロジェクトにのみ適用されます。

    IDE にコピーコマンドを使用して、プロジェクトスキームを IDE レベルにコピーすることができます。

  • IDE レベルでは、設定は事前定義されたデフォルトスキーム(太字で表示)、および複製コマンドによってユーザーが作成したその他のスキーム(プレーンテキストとして表示)にグループ化されています。グローバル設定は、ユーザーがプロジェクトでコードスタイル設定を保持して共有したくない場合に使用されます。

    プロジェクトにコピーコマンドを使用して、IDE スキームを現在のプロジェクトにコピーできます。

言語のコードスタイルを設定する

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイルに進み、プログラミング言語のページを開きます。

  2. 選択した言語のカスタムコードスタイルのベースとして使用するコードスタイルスキームを選択します。

  3. 選択した言語ページのタブをブラウズし、その言語スタイルの設定を行います。

他の言語からコードスタイル設定をコピーする

ほとんどのサポートされている言語では、他の言語やフレームワークのコードスタイル設定をコピーできます。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイルに進み、プログラミング言語のページを開きます。

  2. 表示されるリストから、コードスタイルをコピーする言語を選択します。

    Set code style

コードスタイル設定のコピーを作成する

あらかじめ定義されているものとは異なるコードスタイルを定義できます。これらのコードスタイルスキームは、ユーザホームディレクトリの config/codestyles フォルダーにある XML ファイルに格納されています。作成したコピーをコードスタイルの変更およびエクスポートに使用できます。

プロジェクト以外のコードスタイルスキームを選択すると、このコードスタイルがプロジェクト用に保存されます。プロジェクトごとにグローバル(IDE)コードスタイルを割り当てることができます。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイルに移動します。

  2. スキームリストから目的のスキームを選択して、the Scheme Settings icon をクリックします。

  3. 次のいずれかのオプションを選択します。

    • IDE にコピー - 選択したスキームをグローバルレベルで保存するには、このオプションを選択します。

      PyCharm は PyCharm ホームディレクトリ下の config/codestyles/<code_style_name>.xml ファイルに指定した名前の新しいコードスタイルを保存します。

    • プロジェクトにコピー - 選択したスキームをプロジェクトレベルで保存するには、このオプションを選択します。

      選択したコードスタイルは、ファイル codeStyleSettings.xml.idea ディレクトリに保存されます。

    • 複製 - このオプションを選択して、選択したスキームのコピーを作成し、同じレベルに保存します。

  4. スキームフィールドに新しいスキームの名前を入力し、Enter を押して変更を保存します。

コードスタイルスキームを管理する

  1. コードスタイルページで、目的のスキームを選択して manage profiles をクリックします。

  2. 次のいずれかのオプションを選択します。

    • 名前の変更 - このオプションを選択して、選択したスキームの名前を変更します。

    • エクスポート - このオプションを選択して、コードスタイル設定を目的の場所にエクスポートします。

    • スキームをインポート - PyCharm XML コードスタイル設定、JSCS 設定ファイル、または Eclipse XML プロファイルをインポートするには、このオプションを選択します。

  3. スキームフィールドに新しいスキームの名前を入力し、Enter を押して変更を保存します。

EditorConfig を使用してディレクトリレベルでコードスタイルを管理する

PyCharm を使用すると、EditorConfig(英語) をサポートする(設定 / 環境設定ダイアログ Ctrl+Alt+S でデフォルトで有効になっている)個々のファイルセットのすべてのコードスタイル設定を管理できます。必要なのは定義したいコードスタイルのファイルを含むルートディレクトリに .editorconfig ファイルを置くことです。プロジェクト内には必要な数の .editorconfig ファイルを含めることができるため、モジュールごとに異なるスタイルを指定できます。

.editorconfig ファイルからのすべてのオプションは、それが存在するディレクトリと現在のプロジェクトコードスタイルの上にあるそのすべてのサブディレクトリに適用されます。 .editorconfig で何も定義されていない場合は、プロジェクト設定から取得されます。

.editorconfig ファイルのすべてのオプションは、以下のカテゴリに分類されます。

  • indent_sizeindent_style などの標準オプション。これらのオプションには、ドメイン固有のプレフィックスはありません。

  • ij_ という接頭辞を持ち、すべての言語に適用可能な一般的な IntelliJ オプション

    • ij_visual_guides

    • ij_formatter_off_tag

    • ij_formatter_on_tag

    • ij_formatter_tags_enabled

    • ij_wrap_on_typing

    • ij_continuation_indent_size

    • ij_smart_tabs

  • 多くの(全部ではない)言語でサポートされている共通の IntelliJ オプション。それらは ij_any_brace_style のように、ij_any プレフィックスで始まります。

  • <lang> は言語ドメイン ID(通常は小文字の言語名)である ij_<lang>_ 接頭部で始まる IntelliJ 言語固有のオプション、たとえば ij_java_blank_lines_after_imports

.editorconfig ファイルを追加する

  1. プロジェクトビューで、コードスタイルを定義するファイルを含むソースディレクトリを右クリックして、コンテキストメニューから新規 | EditorConfig を選択します。

  2. PyCharm がスタブを作成するように定義するプロパティを選択するか、必要なプロパティを手動で追加するにはすべてのチェックボックスを空白のままにします。

  3. コードスタイル設定の変更が実際のソースファイルにどのように影響するかをプレビューするには、.editorconfig ファイルのガターで the eye icon をクリックし、影響を受けるソースファイルを選択します。プレビューが右側に開きます。

    editorconfig preview

    プレビューペインを変更して、ソースコードに不要な変更を加えることを気にせずに構成の変更がどのように反映されるかを試すことができます。これらの変更はすべて .editorconfig ファイルを閉じると破棄されます。

関連ページ:

コードスタイル

スキーム:この領域では、コードスタイルスキームを選択し、必要に応じて変更します。コードスタイルスキームの設定は、PyCharm がコードを生成、リファクタリング、または再フォーマットするたびに自動的に適用されます。コードスタイルは、プロジェクトレベルと IDE レベル(グローバル)で定義されます。プロジェクトレベルでは、設定はプロジェクトスキームにグループ化されます。これは事前定義されており、太字でマークされています。プロジェクトスタイルスキームは現在のプロジェクトにのみ適用されます。IDE に...

プラグインを管理する

このサイトのメニューやアクション名表記は日本語です。PyCharm を日本語化するには、日本語言語パックのインストールを参照してください。プラグインは以下に示すように PyCharm のコア機能を拡張します。バージョン管理システム、アプリケーションサーバー、およびその他のツールとの統合を提供する、さまざまな言語とフレームワークのコーディング支援サポートを追加する、ショートカットヒント、ライブプレビュー、ファイルウォッチャーなどで生産性を向上、コーディング演習と検証で新しいプログラミング言語を学ぶ...

PyCharm 設定の構成

PyCharm では、プロジェクトレベルとグローバルの 2 つのレベルで設定を構成できます。グローバル設定は、PyCharm の特定のインストールまたはバージョンのすべてのプロジェクトに適用されます。このような設定には、IDE の外観(テーマ、配色、メニュー、ツールバー)、通知設定、インストールされ有効になっているプラグインのセット、デバッガー設定、コード補完などが含まれます。IDE を構成するには、macOS の場合は、Windows および Linux の場合はを選択します。または、を押す...

色とフォントの構成

開発者として、エディターのソースコード、検索結果、デバッガー情報、コンソールの入出力など、多くのテキストリソースを使用します。色とフォントスタイルは、このテキストのフォーマットに使用され、一目で理解しやすくなります。PyCharm は、好適な色とフォントを定義するカラースキームを使用しています。事前定義された配色を使用するか、あなたの好みに合わせてカスタマイズすることができます。スキームを共有することも可能です。配色を選択設定 / 環境設定ダイアログで、を選択します。配色を選択するには、スキー...