チュートリアル: PyCharm でデプロイ
このチュートリアルでは、PyCharm を使用してコードのデプロイを リモートホストに構成および管理する手順を段階的に説明します。
FTP/SFTP/WebDAV 接続プラグインを有効にする
この機能は、デフォルトで PyCharm にバンドルされて有効になっている FTP/SFTP/WebDAV 接続(英語)プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。
Ctrl+Alt+S を押して設定を開き、
を選択します。インストール済みタブを開き、FTP/SFTP/WebDAV 接続プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。
始める前に
以下を確認してください:
PyCharm バージョン 5.0 以降を使用しています。このチュートリアルは PyCharm 2024.1 で準備されています。
コードをデプロイするリモートホストへのアクセス権があります。
デプロイサーバーを構成する
新しいサーバーを追加する
Ctrl+Alt+S を押して設定を開き、
を選択します。または、メインメニューの
に移動します。をクリックし、作成するサーバーのタイプを選択します。この場合は、ローカルまたはマウント済みフォルダーです。
開いた新規サーバーの作成ダイアログでサーバー名を入力し、OK をクリックします。
新しいサーバーが追加されましたが、アップロードされたファイルを実際に参照する Web サーバー URL http://localhost のみが表示されます。
サーバーのルートフォルダーを指定する
フォルダーフィールドで、プロジェクトファイルをアップロードするディレクトリを指定します。
この場合、これは /Users/jetbrains/deployment ローカルフォルダーです。パスを手動で入力するか、Shift+Enter を押します。
後でこの構成をエクスポートできるようにするには、このプロジェクトでのみ表示するオプションを無効にします。
デプロイパスを指定する
次に、マッピングタブに切り替えます。
デフォルトでは、ローカルパスフィールドにはプロジェクトルートへのパスが含まれています。ただし、プロジェクトツリー内の他のディレクトリを選択することもできます。デフォルトのパスを使用しましょう。
デプロイメントパスフィールド (デフォルトでは空) で、PyCharm がローカルパスフィールドで指定されたフォルダーからデータをアップロードするサーバー上のフォルダーを指定します。
この例では、Application です。このパスは、Web サーバーのルートフォルダー ( Users/jetbrains/deployment) を基準として指定されます。
Web パスのデフォルトの / 値のままにします。
変更を適用すると、サーバーを使用できるようになります。
リモートホストの参照
サーバーが起動していることを確認するには、メインメニューでリモートホストツールウィンドウが表示されます。
を選択すると、PyCharm ウィンドウの右側に![リモートホストツールウィンドウ Remote Hosts tool window](https://resources.jetbrains.com/help/img/idea/2024.1/ij_deployment_remote_host.png)
ファイルのデプロイ
サーバーにファイルをアップロードする
まず、ファイルの 1 つをリモートサーバーにアップロードしましょう。
プロジェクトツールウィンドウ (Alt+1) で、アップロードするファイルを右クリックします。この場合、これは README.md ファイルです。
コンテキストメニューから
を選択し、アップロードを確認して、アップロード結果を確認します。
プロジェクト内の各ディレクトリの内容をアップロードすることもできます。プロジェクトツールウィンドウでアップロードするディレクトリを右クリックし、 を選択します。
リモートとローカルバージョンを比較する
README.md
ファイルにはローカルコピーとリモートコピーがあり、それらは同一です。ローカルバージョンを変更します。
リモートホストツールウィンドウツールウィンドウで、README.md を右クリックし、ローカルバージョンと比較を選択します。PyCharm によって差分ビューアーが開きます。
サーバーからファイルをダウンロードする
リモートホストツールウィンドウツールウィンドウで、README.md ファイルを右クリックし、ここからダウンロードを選択します。PyCharm に警告が表示されます。
はいをクリックします。
以前にサーバーにアップロードされている場合は、ディレクトリ全体をダウンロードすることもできます。
変更を同期する
Ctrl+Z を押して、README.md ファイルの変更を元に戻します。
README.md ファイルをクリックし、メインメニューから を選択します。
PyCharm は、個々の変更を承認または拒否できる差分ビューアーを表示します。
デフォルトのサーバーにファイルを自動的にアップロードする
PyCharm プロジェクトとまったく同じファイルをサーバー上に用意する必要がある場合、自動アップロードが役立ちます。自動アップロードとは、IDE で変更が発生するたびに、その変更がデフォルトのデプロイサーバーにデプロイされることを意味します。
変更されたファイルの自動アップロード中にその設定がデフォルトで適用される場合、デプロイサーバーはデフォルトと見なされます。
デフォルトサーバーを定義する
Ctrl+Alt+S を押して設定を開き、
を選択します。または、メインメニューの
に移動します。サーバーのリストからデフォルトにするサーバーを選択し、サーバーリストの上にあるツールバーの
をクリックします。
自動アップロードを有効にする
デフォルトサーバーが設定されると、このサーバーへのアップロードを自動化できます。
Ctrl+Alt+S を押して設定を開き、
を選択します。または、メインメニューの
に移動します。変更されたファイルのデフォルトサーバーへの自動アップロードドロップダウンリストから、次のオプションのいずれかを選択します。
常時 : 自動保存および明示的保存のたびにファイルをアップロードします。
明示的な保存操作時 : この保存が を選択するか、Ctrl+S を押して手動で呼び出された場合にのみ、保存後にファイルをアップロードします。
常時モードは、本番環境にデプロイすることは推奨されません。開発中に不完全なコードがアップロードされ、本番アプリケーションが壊れる可能性があります。
外部の変更をアップロードする
デフォルトでは、VCS ブランチの変更、SASS または LESS のコンパイル、ファイル監視などの外部プロセスによってファイルが変更された場合、PyCharm はファイルもアップロードします。この動作を変更して外部の変更をスキップするには、変更されたファイルをデフォルトサーバーにアップロードするを常時に設定し、外部変更をスキップするチェックボックスを選択します。
![外部変更をスキップする Skip external changes](https://resources.jetbrains.com/help/img/idea/2024.1/deployment_options_external_changes.png)
デプロイ設定のエクスポート / インポート
デプロイサーバーのセットアップがすべて完了したため、サーバー構成設定をエクスポートして、別のコンピューターにインポートできます。
設定を ZIP アーカイブにエクスポート
メインメニューからファイル | IDE 設定の管理 | 設定のエクスポートを選択します。
開いた設定のエクスポートダイアログで、Web サーバーチェックボックスが選択されていることを確認し、ターゲットアーカイブへのパスを指定します。
ZIP アーカイブから設定をインポートする
メインメニューからファイル | IDE 設定の管理 | 設定のインポートを選択します。
開いたダイアログで設定を含む ZIP アーカイブを選択してください。
開くインポートするコンポーネントの選択ダイアログで適用したい設定を選択し、OK をクリックします。
要約
この非常に基本的なチュートリアルに合格し、次のタスクを実行しました。
独自のサーバーを作成して構成しました。
ファイルとフォルダーのアップロードおよびダウンロード。
ローカルとリモートのバージョンを比較しました。
サーバーをデフォルトとして構成しました。
外部変更の自動アップロードを有効にしました。
関連ページ:
![](https://pleiades.io/icons/pycharm.png)
デプロイ: マッピングタブ
タブで、PyCharm で開かれたプロジェクト、このプロジェクトに対応するサーバードキュメントルートのフォルダー、およびそのフォルダーへの URL パス間のマッピングを指定する最も簡単な方法は、プロジェクトルートフォルダー全体をサーバードキュメントルートのフォルダーにマップすることです。この場合、プロジェクトフォルダー構造はサーバー上で再作成されます。ローカルパスこのフィールドには、ローカルプロジェクトフォルダーへの絶対パスを入力します。PyCharm は、このフィールドに現在開いているプロジェ...
![](https://resources.jetbrains.com/help/img/idea/2024.1/remote-host-options.png)
リモートホストツールウィンドウ
このツールウィンドウを使用して、対象の FTP/FTPS/SFTP サーバーのフォルダー構造とアップロードされたデータを表示します。リモートホストツールウィンドウを開く:。(以前にから開かれている場合にのみツールウィンドウリストで使用可能)。オプション:リモートホストツールウィンドウのオプションメニューには、一般オプションのほかに、ファイルサイズ、アクセス許可、最終変更日など、アップロードされたファイルに関するメタデータを表示するためのオプションが含まれています。ツールバー:リモートホスト
![](https://resources.jetbrains.com/help/img/idea/2024.1/git_widget.png)
Git ブランチの管理
Git では、ブランチは、たとえば機能の作業が必要な場合や、リリースのためにコードベースの特定の状態を固定する必要がある場合などに、メインの開発ラインから分岐できるようにする強力なメカニズムです。PyCharm では、ブランチによるすべての操作は Git ブランチポップアップで実行されます。これを呼び出すには、メインウィンドウのヘッダーで、現在チェックアウトされているブランチの名前を持つ Git ウィジェットをクリックします。Git ツールウィンドウのブランチペインで、ブランチを管理し、複数のブラン...
![](https://resources.jetbrains.com/help/img/idea/2024.1/ws_scss_example_project_structure.png)
Sass、SCSS、Less
PyCharm は、Sass、Less、SCSS コードを CSS に変換するコンパイラーと統合します。PyCharm でコンパイラーを使用するには、関連する事前定義済みテンプレートに基づいて、ファイル監視としてコンパイラーを構成する必要があります。始める前に:お使いのコンピューターに Node.js がインストールされていることを確認してください。設定 | プラグインページのインストール済みタブで、CSS、Sass、Less、ファイル監視の必須プラグインが有効になっていることを確認します。詳細について...
![](https://resources.jetbrains.com/help/img/idea/2024.1/ws_enable_global_watcher.png)
ファイル監視
ファイル監視は PyCharm ツールであり、IDE でファイルを変更または保存するときに、コンパイラー、フォーマッタ、リンターなどのコマンドラインツールを自動的に実行できます。ファイルウォッチャーには、2 つの専用コードインスペクションがあります。ファイル監視使用可能インスペクションは、あらかじめ定義されたファイル監視が適用されるすべてのファイルで実行されます。プロジェクトに関連するファイル監視が設定されていない場合、PyCharm はファイルウォッチャーを追加することを提案します。ファイル監...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_edit_file_remote1.png)
リモートホスト上の個々のファイルを編集する
リモートホストとの同期を設定したら、ローカルプロジェクトに追加 / ダウンロードすることなく、リモートホストから直接個々のファイルを開いて PyCharm で編集できます。デバッグ、リファクタリング、その他の PyCharm 機能は、そのようなファイルではサポートされません。高度な PyCharm 機能を利用するには、プロジェクトにファイルを含めることを検討してください。詳細については、サーバー上のファイルにアクセスするを参照してください。リモートホスト上のファイルを編集するデフォルトのリモート...