PyCharm 2024.1 ヘルプ

Django 構造ツールウィンドウ

Django プラグインを有効にする

この機能は、デフォルトで PyCharm にバンドルされて有効になっている Django プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。

  1. Ctrl+Alt+S を押して設定を開き、プラグインを選択します。

  2. インストール済みタブを開き、Django プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。

Django の構造ツールウィンドウは、Django プロジェクトの主要コンポーネントを作成、リファクタリング、移動するための迅速な方法を提供します。

プロジェクト構造を表示する

  • 左側の Django の構造をクリックしてツールウィンドウを開きます。

    Django structure tool window

    ツールウィンドウのアイコンが表示されない場合は、 他のツールウィンドウをクリックし、リストから Django の構造を選択します。

  • Django の構造ツールウィンドウには、次のコンポーネントがリストされます。

    • モデル

    • 管理者クラス

    • ビュー

    デフォルトでは、モデルのみが表示されます。他のコンポーネントを有効にするには、ツールバーで 表示オプションをクリックし、表示セクションで選択します。

  • デフォルトでは、コンポーネントはアプリごとにグループ化されています。コンポーネントタイプ別にグループ化するには、ツールバーで 表示オプションをクリックし、コンポーネントを選択します。

    類似した名前のコンポーネントについては、アプリケーション名も表示されます。

    Django structure grouped by component type
  • コンポーネントに移動するには、それをダブルクリックします。含まれているファイルがエディターで開かれ、キャレットが対応するクラス宣言または関数定義に設定されます。

    Jumping to a Django component from the Django Structure tool window

プロジェクト設定にアクセスする

  • Django の構造ツールウィンドウで、Settings 設定をダブルクリックします。Django プロジェクト設定ファイル (たとえば、settings.py) がエディターで開きます。

アプリの管理

Django の構造ツールウィンドウを使用して、新しいアプリを作成し、移行を実行できます。

アプリを作成する

  1. 以下のいずれか 1 つを実行します:

    • Django の構造ツールウィンドウのツールバーで新しい Django アプリをクリックします。

      Creating a Django app in the Django Structure tool window
    • 既存のアプリを右クリックします。アプリがまだない場合は、アプリを作成リンクをクリックします。

      コンテキストメニューから新しい Django アプリを選択します。

  2. 開いたターミナルでアプリの名前を指定し、Enter を押します。

    Specifying the app name in the manage.py console

アプリの移行を実行する

  1. Django の構造ツールウィンドウでアプリを右クリックし、コンテキストメニューから移行を行うを選択します。

  2. 開いたターミナルでアプリ名を入力し、押します Enter

  3. Django の構造ツールウィンドウに戻り、アプリを右クリックし、コンテキストメニューからマイグレーションを選択します。

  4. 開いたターミナルでアプリ名を入力し、押します Enter

  • Django の構造ツールウィンドウでアプリを右クリックし、コンテキストメニューからプロジェクトビューで開くを選択します。

  • アプリディレクトリがプロジェクトツールウィンドウで開きます。

    Opening the app directory in the Project tool window

モデルの管理

Django の構造ツールウィンドウを使用すると、モデルに対して次の操作を実行できます。

モデルを作成する

  1. Django の構造ツールウィンドウで、モデルノードまたは既存のモデルを右クリックします。

  2. コンテキストメニューから新しいモデルを選択します。

    Creating a new model in the Django Structure tool window
  3. アプリにモデルを含む複数のファイル (たとえば、モデルを含むディレクトリや Python モジュール) が含まれている場合、PyCharm は新しいモデルのファイルを選択するように求めます。

    Choosing the location for the new model
  4. モデルを含むファイル ( models.py など) がエディターで開きます。

    新しいモデルの名前を指定して Enter を押すと、pass の代わりにフィールドと他のモデルコードを追加して続行できます。

    New model is created in the file with models

管理インターフェースでモデルを登録する

  1. Django の構造ツールウィンドウでモデルを右クリックし、コンテキストメニューから Django 管理者に登録するを選択します。

    Registering a model in the admin interface
  2. admin.py がエディターで開かれ、@admin.register デコレーターを備えた新しいモデル管理クラスが追加されます。

    The model is registered in admin.py

    Enter を押してクラスの作成を確認します。

モデルが管理インターフェースに登録されると、対応するモデル管理クラスが Django の構造ツールウィンドウの管理ノードにリストされます。

プロジェクトにモデルの登録にまだ使用されていないモデル管理クラスが含まれている場合、それらは Django の構造ツールウィンドウでグレー表示されます。

Unused admin classes

コンテキストメニューを使用して、モデルをそのようなモデル管理クラスに登録できます。

未使用の管理者にモデルを登録する

  1. Django の構造ツールウィンドウでモデル管理クラスを右クリックし、コンテキストメニューから Django 管理者に登録するを選択します。

    Registering a model with an unused model admin class
  2. ポップアップでモデルを選択します。未登録のモデルがない場合は、全モデル登録済みメッセージが表示されます。

    Selecting a model register with the admin class
  3. admin.py がエディターで開かれ、@admin.register デコレーターがモデル管理クラスに追加されます。

管理ノードのモデル管理クラスのコンテキストメニューを使用して、モデル管理クラスの使用箇所を検索し、リファクタリングし、対応するモデルに移動することもできます。

  1. Django の構造ツールウィンドウでモデル管理クラスを右クリックし、コンテキストメニューからモデルに移動を選択します。

    Navigating to a model from the model admin class
  2. 選択した管理クラスに複数のモデルが登録されている場合は、ポップアップでモデルを選択する必要があります。

    Selecting a model to navigate from the admin class

モデルをリファクタリングする

  1. Django の構造ツールウィンドウでモデルを右クリックします。

  2. 開いたコンテキストメニューでリファクタリングを選択し、リストからリファクタリングを選択します。

    Refactoring a model in the Django Structure tool window

モデルの使用方法を見つける

  • Django の構造ツールウィンドウでモデルを右クリックし、コンテキストメニューから使用箇所の検索を選択します。

    Finding usages of a model in the Django Structure tool window

    「検索」ツールウィンドウが開き、検索結果が表示されます。詳細については、プロジェクトの使用箇所を見つけるを参照してください。

ビューの管理

Django の構造ツールウィンドウを使用すると、ビューを使用して次の操作を実行できます。

ビューを作成する

  1. Django の構造ツールウィンドウで、ビューノードまたは既存のビューを右クリックします。

  2. コンテキストメニューから新しいビューを選択します。

  3. ビューの種類を選択します。

    Choosing the view type
  4. アプリにビューを含む複数のファイルが含まれている場合、PyCharm は新しいビューのファイルを選択するように求めます。

  5. ビューを含むファイル ( views.py など) がエディターで開かれます。

    新しいビューの名前を指定して Enter を押すと、ビューコードの追加に進むことができます。

    New view is created in the file with views

ビューのリファクタリング

  1. Django の構造ツールウィンドウでビューを右クリックします。

  2. 開いたコンテキストメニューでリファクタリングを選択し、リストからリファクタリングを選択します。

    Refactoring a view in the Django Structure tool window

ビューの使用方法を見つける

  • Django の構造ツールウィンドウでビューを右クリックし、コンテキストメニューから使用箇所の検索を選択します。

    Finding usages of a model in the Django Structure tool window

    「検索」ツールウィンドウが開き、検索結果が表示されます。詳細については、プロジェクトの使用箇所を見つけるを参照してください。

関連ページ:

Django のサポート

Django プラグインを有効にするこの機能は、デフォルトで PyCharm にバンドルされて有効になっている Django プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インストール済みタブを開き、Django プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。前提条件:Django フレームワークと対応する Python インタープリターがマシンに正しくインストールされて...

Python インタープリターを構成する

PyCharm の Python インタープリター:PyCharm で Python コードを操作するには、少なくとも 1 つの Python インタープリターを構成する必要があります。Python インストールで利用可能なシステムインタープリターを使用できます。Virtualenv、pipenv、Poetry、conda 仮想環境を作成することもできます。仮想環境は、基本インタープリターとインストールされたパッケージで構成されます。PyCharm Professional では、SSH、Vagr...

プロジェクト要件を管理する

PyCharm は、プロジェクト内の満たされていない依存関係を追跡することを可能にし、requirements.txt や Pipfile の使用を含む依存関係管理の主要な手段との統合を提供します。requirements.txt には、アプリケーションが依存する一連のパッケージが含まれています。この名前のファイルがルートプロジェクトディレクトリに追加されると、Python 統合ツールによって自動的に検出されます。詳細な手順については、requirements.txt の使用を参照してください。Pip...

エンドポイントの管理

Django プラグインを有効にするこの機能は、デフォルトで PyCharm にバンドルされて有効になっている Django プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インストール済みタブを開き、Django プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。Django REST フレームワークアプリケーションのエンドポイントをプレビュー、変更、作成、テストできます。...