PyCharm 2019.1ヘルプ

Vagrant

PyCharmはVagrant(英語)と統合されており、Vagrantfile 構成ファイルで定義された再現可能な開発環境を作成できます。仮想ボックスの作成と削除Vagrantボックスの初期化、Vagrant設定ファイルからの設定の読み取りによるリモート Pythonインタープリターの設定、およびIDEを移動せずに他のVagrantコマンドの実行を行うことができます。vagrant upコマンドを実行するときに複数の仮想ボックスから選択することもできます(複数Vagrant構成)。

PyCharmの文脈では、次の用語はバラント特有の概念を示すために使用されます。

  • PyCharmユーザーインターフェースのVagrantボックス、または現在のドキュメントのVagrantベースボックスは、ネイティブVagrant用語のボックス(英語)です。これは純粋なイメージ(スケルトン)を表し、その上で特定の環境がカスタマイズ、プロビジョニング、およびマシンにデプロイされます。

  • インスタンス仮想マシンです。つまり、Vagrantベースボックスをベースにして Vagrantfileに従ってお客様のマシン上でカスタマイズ、プロビジョニング、およびデプロイされた特定の環境です。他の同様の製品および資料では、インスタンス仮想マシンと呼ばれることがあります。

  • インスタンスフォルダーは、初期化後に関連する Vagrantfile が保存され、PyCharmがそれを探すフォルダーです。デフォルトでは、プロジェクトのルートフォルダーです。

Vagrantでの作業の準備

始める前に、以下のステップとチェックが行われていることを確認してください。

  1. コンピューターにVagrant(英語)OracleのVirtualBox(英語)がインストールされていて、実行可能ファイルの親フォルダーがシステム PATH 変数に追加されていることを確認してください。標準インストール手順に従った場合、これらのフォルダーは自動的に追加されます。

  2. 次の実行可能ファイルの親フォルダーがシステムPATH変数に追加されていることを確認します。
    • Vagrantからvagrant.bat または vagrant を選択してください。これは、Vagrantインストーラによって自動的に実行されます。

    • VBoxManage.exe または VBoxManage を使用してください。

設定/環境設定ダイアログ(Ctrl+Alt+S)で、Vagrant設定を確認または変更します。

  1. ツールVagrantをクリックします。Vagrantページページが開きます。

  2. Vagrant実行ファイルを指定してください。実行可能ファイルの親フォルダーはすでにシステムPATH変数に追加されているため、実行可能ファイルの名前だけを入力してください。

  3. インスタンス・フォルダーフィールドに、Vagrantfile が初期設定されて保管されているディレクトリーへの完全修飾パスを指定します。 Vagrantfile は必要なインスタンス仮想マシン )を定義する設定ファイルです。このファイルには、仮想IPアドレス、ポートマッピング、および割り当てるメモリサイズが含まれています。ファイルは、どのフォルダーを共有し、どのサードパーティソフトウェアをインストールするかを指定できます。 Vagrantfile によると、インスタンス仮想マシン )は構成され、関連するVagrantベースボックスに対してプロビジョニングされ、コンピューターにデプロイされます。 Vagrantfilevagrant init コマンドによって作成されます。

    インスタンス仮想マシン )の作成が vagrant up コマンドまたはツール | Vagrant | Upメニュー・オプションのいずれかを介して呼び出されると、PyCharmはインスタンス・フォルダーフィールドで指定されたディレクトリー内で Vagrantfile を探します。詳しくは、http://docs.vagrantup.com/v2/vagrantfile/(英語)を参照してください。

    Vagrantfile を任意のディレクトリーに作成し、それをインスタンスフォルダーとして指定することができます。このフィールドが空の場合、PyCharmはプロジェクトルートインスタンスフォルダーとして扱い、その中で Vagrantfile を探します。

  4. Vagrantボックス領域で、PyCharmで利用可能な定義済みVagrantベースボックス(英語)のリストを設定します。各項目は、Vagrantがそのインスタンス仮想マシン )を構成し起動するVagrantベースボックスを表します。このリストのエントリは、コマンド vagrant box listの出力に対応しています。

    • 新しいベースボックスをダウンロードするには、追加ボタン Add the base boxをクリックしてください。表示されたダイアログで、ベースボックスにアクセスするためのURLアドレスとPyCharmでそれを参照するための名前を指定します。デフォルトでは、PyCharmはlucid32ボックスへのURLを提案します。

      このコマンドは vagrant box add <name> <URL>に対応しています。その結果、指定されたベースボックスがあなたのマシンにダウンロードされます。

    • ベースボックスを削除するには、リストからそれを選択して削除ボタン Remove the base boxをクリックします。ベースボックスとネストされたファイルはディスクから物理的に削除されます。このコマンドは vagrant box remove <name>に対応しています。

  5. PyCharmは Vagrantfile 構文を認識します。デフォルトの配色またはコードスタイルの構文を変更するには、設定/環境設定 | エディターに切り替えて、カラー・スキームの切り替えおよびコード・スタイルダイアログで対応する設定を調整します。

Vagrantファイルの初期化

Vagrantfile は必要なインスタンス仮想マシン )を定義する設定ファイルです。このファイルには、仮想IPアドレス、ポートマッピング、および割り当てるメモリサイズが含まれています。ファイルは、どのフォルダーを共有し、どのサードパーティソフトウェアをインストールするかを指定できます。 Vagrantfile によると、インスタンス仮想マシン )は構成され、関連するVagrantベースボックスに対してプロビジョニングされ、コンピューターにデプロイされます。 Vagrantfilevagrant init コマンドによって作成されます。

Vagrantfile は任意のフォルダーで初期化できます。このフォルダーは設定環境設定ダイアログのVagrantページでインスタンスフォルダーとして指定する必要があることに注意してください。そうでない場合、PyCharmはインスタンス仮想マシン )の作成中に関連する Vagrantfile を見つけることができません。

Vagrantfileを初期化するには、次のいずれかを行います。

Vagrantファイルを初期化する

  1. Vagrantfile をプロジェクトルートに作成するには、メインメニューでツール | Vagrant | プロジェクトルートの初期化を選択し、表示されたリストからターゲットプロジェクトルートを選択します。 init コマンドの出力は、実行ツールウィンドウに表示されます。

  2. Vagrantfile を特定のフォルダーに作成するには、内蔵ターミナルAlt+F12)を開き、次のコマンドを入力します。

    cd <directory to initialize the Vagrantfile in> vagrant init <base box name> <base box url>

Vagrantfile が作成された後、エディターでそれをプレビューすることができます:それは利用可能な設定オプションの詳細なリストを含みます。必要に応じて構成設定を変更または追加します。コード補完がVagrantfileに対して有効になっていることに注意してください。

The initial view of the newly created Vagrantfile

Vagrantfile の初期化が正常に完了したら、ベースボックスをインポートし、Vagrantfileに従ってプロビジョニングおよび配置して、独自のインスタンス仮想マシン )を作成する準備が整いました。

インスタンスの作成と起動 (仮想マシン)

インスタンス仮想マシン )を作成することは、インスタンスフォルダーにある Vagrantfile に従ってベースボックスをインポートしてプロビジョニングすることを意味します。

インスタンスを作成し、次の手順に従います。

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

    • インスタンスをプロジェクトルートに作成するには、ツール | Vagrant | Upに進みます。

    • 特定のフォルダーにインスタンスを作成するには、埋め込みターミナルAlt+F12)を開き、次のコマンドを入力します。

      cd <instance folder> vagrant up
  2. 候補リストから目的の仮想マシン構成を選択します。

インスタンスの停止、一時停止、再開、再ロード、破棄 (仮想マシン)

インスタンスをリロードする

  • Vagrantfile に何らかの変更を加え、それに従って実行中の仮想マシンを更新したい場合は、メインメニューでツール | Vagrant | 再ロードを選択するか、内蔵ターミナルで次のコマンドを実行してください。

    vagrant reload
    詳細は、http://docs.vagrantup.com/v2/cli/reload.html(英語)を参照してください。

インスタンスを中断する

  • 実行中の仮想マシン( ゲストマシン )上のオペレーティングシステムを一時的に停止し、現時点の環境の正確な状態を保存してこの時点から正確に再開できるようにするには、メインメニューでツール | Vagrant | 中断を選択するか、次のコマンドを実行します: 埋め込まれたターミナルでは:

    vagrant suspend
    詳細は、http://docs.vagrantup.com/v2/cli/suspend.html(英語)を参照してください。

インスタンスを再開する

  • 仮想マシン( ゲストマシン )上で以前に一時停止したオペレーティングシステムを再開し、一時停止時に保存した状態から実行するには、メインメニューでツール | Vagrant | 再開を選択するか、内蔵ターミナルで次のコマンドを実行します。

    vagrant resume
    詳細は、http://docs.vagrantup.com/v2/cli/resume.html(英語)を参照してください。

インスタンスをシャットダウンする

  • 仮想マシン( ゲストマシン )上のオペレーティングシステムをシャットダウンするには、メインメニューでツール | Vagrant | 停止を選択するか、または内蔵ターミナルで次のコマンドを実行します。

    vagrant halt
    詳細は、http://docs.vagrantup.com/v2/cli/halt.html(英語)を参照してください。

  • 仮想マシン( ゲストマシン )上のオペレーティングシステムをシャットダウンし、仮想マシン自体を停止し、作成中に仮想マシンにプロビジョニングされたリソースを削除する(vagrant up)には、メインメニューでツール | Vagrant | 破棄を選択するか、組み込みターミナルで次のコマンドを実行します: :

    vagrant destroy
    詳細は、http://docs.vagrantup.com/v2/cli/destroy.html(英語)を参照してください。

最終更新日: 2019年7月15日

関連事項

プロシージャー:

リファレンス:

チュートリアルと例: