インストール - PyCharm

概要

PyCharmは、JetBrainsが提供しているマルチプラットホームなPython向けIDEである。

JetBrainsのIDEは、IntelliJ IDEAというJava IDEがベースとなっており、
PyCharmはそのPythonプラグインとして開発されている。

PyCharmには、JS、CSS、HTML等のWeb開発関連のプラグインも付属しているので、フロントエンド開発も同じ環境で開発できる。

PyCharmのインストール

公式サイトからPyCharmをダウンロードする。

ダウンロードしたファイルを解凍する。

tar -xf pycharm-community-<バージョン>.tar.gz
または
tar -xf pycharm-professional-<バージョン>.tar.gz

PyCharmの起動

ここでは、ホームディレクトリにPyCharmをインストールしているものとする。

cd pycharm-<バージョン>/bin
./pycharm.sh

PyCharmの設定

行番号と空白文字の表示

[File] - [Settings] - [Editor] - [General] - [Appearance]を選択する。
[Show line numbers]チェックボックスと[Show whitespaces]チェックボックスにチェックを入力する。

Samba上にプロジェクトを置く場合

External file changes sync may be slowを表示させないために、
[File] - [Settings] - [Appearance & Behavior] - [Notifications]から[File Watcher Messages]を[No popup]にする。

ショートカットの作成

デスクトップエントリファイルの作成は、GNOMEやKDE等の共通の設定である。
/home/ユーザ名/.local/applications/org.pycharm-pro-<バージョン>.desktopファイルを作成する。

vi /home/ユーザ名/.local/applications/org.pycharm-pro-<バージョン>.desktop

# /home/ユーザ名/.local/applications/org.pycharm-pro-<バージョン>.desktopファイル
[Desktop Entry]
Type=Application
Name=Pycharm Professional 2019.3.1
GenericName=PyCharm Professional
Comment=Develop with pleasure
Exec="/home/ユーザ名/pycharm_pro_2019.3.1/bin/pycharm.sh" %F
Icon=/home/ユーザ名/pycharm_pro_2019.3.1/bin/pycharm.png
StartupWMClass=jetbrains-pycharm-pro
Terminal=false
Categories=Development;IDE;PyCharm;

PyCharmの日本語化

PyCharmは非常に強力なIDEであり、2020/05/01現在、Jetbrains公式の日本語化プラグイン(Japanese Language Packプラグイン)が提供されている。
Japanese Language PackプラグインまたはPleiadesプラグイン(PyCharm 2020.1以降は非推奨)を利用することで、PyCharmを日本語化することができる。

ここでは、PyCharmを日本語化する手順を記載する。

PyCharm 2020.1以降の場合

PyCharm 2020.1以降から、純正のJapanese Language Packプラグインが存在するので、それをインストールする。
Pleiadesは非推奨となった。

1. こちらの公式Webサイトから、Japanese Language Packプラグインをダウンロードする。
2. ダウンロードしたプラグインファイルを、<PyCharmのインストールディレクトリ>/pluginsディレクトリに配置する。
3. PyCharmのメイン画面のメニューバーから、[Settings]または[Preferences] - [Plugins]を選択する。
4. [Settings]画面の上側にある歯車ボタンから、[Install Plugin from Disk...]を選択する。
5. 上記でダウンロードしたJapanese Language Packプラグインファイルを選択してインストールする。
6. インストール完了後、PyCharmを再起動して、正常に日本語化できているか確認する。

PyCharm 2020.1以前の場合

• Pleiadesプライグインのダウンロード
  1. こちらのWebサイトにアクセスする。
  2. All in Oneパッケージではなく、Pleiadesプラグイン本体のみをダウンロードする。
  3. Pleiadesプラグイン・ダウンロードからプラットフォームを選択して、ダウンロードする。

• PyCharmの日本語化
  1. 上記でダウンロードしたファイルを解凍する。
  2. 解凍したディレクトリ内のpluginsディレクトリにあるjp.sourceforge.mergedoc.pleiadesを、
     PyCharmのインストールディレクトリ(.PyCharmCExxxx.xディレクトリ)にコピーする。
  3. PyCharmを起動して、適当なプロジェクトを新規作成するか既存のプロジェクトを開く。
     PyCharmの起動後、[Help]メニュー - [Edit Custom VM Options]を選択する。
     もし、"構成ファイルが存在しませんが新規作成しますか？"メッセージが表示される場合、[Create]ボタンを押下する。
     ※構成ファイルは、(PyCharmのインストールディレクトリ)/configディレクトリに存在するpycharm64.vmoptionsファイルである。
  4. 構成ファイルに、以下の2行を末尾に追記する。
     -Xverify:none
     -javaagent:(PyCharmのインストールディレクトリ)/jp.sourceforge.mergedoc.pleiades/pleiades.jar
  5. 構成ファイルを上書き保存する。
  6. PyCharmを再起動して、日本語化されているか確認する。

リモート開発

まず、リモート先PCにおいて、SSHの設定を行う。
PyCharmでは、OpenSSHキーのRFC4716形式はサポートされていないため、ECDSA形式またはED25519形式で鍵を作成する必要がある。

# ECDSA形式
ssh-keygen -t ecdsa

# ED25519形式
ssh-keygen -t ed25519

SSHの設定は、設定 - SSHまたは設定 - SSHの公開鍵認証を参照すること。

1. PyCharmの[ファイル]メインメニュー - [設定] - [プロジェクト:〜] - [Pythonインタープリター] - [歯車アイコン] - [追加]を選択する。
2. [Pythonインタープリターの追加]画面が開くので、画面左にある[SSHインタープリター]を選択する。
3. [Pythonインタープリターの追加]画面右にある[新規サーバー構成]を選択して、サーバー情報（ホスト、ポート、ユーザ名）を指定した後、[次へ]ボタンを押下する。
4. 次の画面にて、リモート先PCに接続するための認証を入力する。
   パスワードまたは鍵ペア(OpenSSLまたはPuTTY)を選択して、パスワードまたはパスフレーズ(必要な場合)を入力する。
   鍵ペア(OpenSSLまたはPuTTY)を選択した場合は、以下の項目を設定する。

   秘密鍵ファイル : 秘密鍵ファイルのフルパス

   パスフレーズ : 秘密鍵にパスフレーズを設定した場合

5. 次の画面にて、[Interpreter:]項目から、リモート先PCのPythonインタープリタへのパスを確認する。
   
6. ローカルプロジェクトとサーバ間のパスマッピングを構成する。
   これは、[フォルダーの同期:]項目右にある[...]を選択して、ローカルプロジェクトディレクトリへのパスとリモート先PC上のディレクトリへのパスを入力する。
7. [プロジェクトファイルをサーバーに自動的にアップロードする]チェックボックスを選択することにより、リモート先PCへのローカルファイル変更時の自動アップロードを有効にすることもできる。
8. また、スーパユーザ権限を使用してSSHインタープリターを実行する場合、[このインタープリターを使用してsudoのroot権限でコードを実行する]チェックボックスを選択する。
   これは、スーパユーザ権限は、SSHインタープリターを起動する時のみ有効になる。
   ファイルのアップロード等は、一般ユーザ権限でリモート先PCにアップロードされる。
9. 最後に、[完了]ボタンを押下する。