20_PyCharm - hiroshi-yamada-jp/public GitHub Wiki

• 公式：PyCharm | ダウンロード | ガイド

• 参考:PyCharm：HTTP プロキシ

1. 設定> 外観 > システム設定 > HTTPプロキシ を選択
2. Proxyサーバを設定: 例：手動プロキシー構成で設定: HTTP: proxy.xxx.com PORT: 8008　プロキシなし：localhost等
3. 接続確認ボタンで接続確認：　接続先例 https://pypi.org/

• 設定方法：ファイル・エンコード

• 複数OS環境ではLinux形式に統一する

• 関数定義でDocstringを挿入すると自動で指定形式のひな型を作成してくれる

• PyCharm公式:Gitリポジトリをセットアップする
• PyCharm公式:GitHub でホストされているプロジェクトを管理する

1. Git初期設定: 60_Gitを参照
2. PyCharmのプロキシ設定　※　必要な場合のみ実施
3. GitHub(GitLab)からリポジトリを、pycharmプロジェクトのTopディレクトリ以下にクローンする

# 保管場所に移動(通常、PycharmプロジェクトのTopディレクトリ以下）し、git clone
cd  C:\Users\xxxx\PycharmProjects
git clone https://url/xxx.git 　　
 or
git clone -b <branch_name> https://url/xxx.git　　　# 特定ブランチを利用する場合

4. PycharmからCloneしたディレクトリを開き、動作環境を設定する(git連携先の確認/Python環境など)

1. 変換対象フォルダー（またはファイル）を選択
2. ファイル > ファイルプロパティ > 行セパレータ　を選択
3. 変換したい改行コードを選択すると、指定フォルダー（またはファイル）の改行コードが一括変換される

1. 対象コードを選択状態で、Alt Enterを入力
2. 「型ヒントを追加」　を選択

1. ファイル > 設定 > 言語＆フレームワーク > マークダウン　を選択
2. マークダウン拡張機能ボタンでPlantUMLを有効にする
3. MDファイルでPlantUML 記法を記載し、プレビューで動作確認する

1. 　ファイル > 設定 > Plugin　を選択
2. 「Mermaid」プラグインが有効になっていることを確認
3. MDファイルでマーメイド記法を記載し、プレビューで動作確認する

• pycharm公式:poetry 環境を構成する

<要点>
1. poetryのインストール　(Powershell)
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
2.  poetryのパスを通す(Path変数の追加例)：　C:\Users\xxxx\AppData\Roaming\Python\Scripts\
3.  poetryの確認：　poetry -V poetry --help
4. pycharmの新規プロジェクトダイアログでpoetry を設定する 

# Windowsの場合：~/.virtualenvs/xxx : xxxが仮想環境名
# WSL(Ubuntu)の場合：~/.virtualenvs/xxx : xxxが仮想環境名
cd ~/.virtualenvs/
ls -l

# 1. Proxy環境の設定
set HTTP_PROXY=http://user:[email protected]:8080
set HTTPS_PROXY=http://user:[email protected]:8080
# 2. 仮想環境に入る
venv\Scripts\activate.bat
# 3. pipコマンドを仮想環境で実行する
pip install -r requirements.txt
pip install -U numpy
# 4. 仮想環境から抜け出す
venv\Scripts\deactivate.bat

• 問題の参考:relative imports of a subfolder package from a non-package script are not recognized by PyCharm
• Ans1: 実行するソースのTopディレクトリをソースルートとしてマーキングする（指定フォルダーを選択し、右クリックでディレクトリをマーキング） これにより上位からの絶対パス指定のimport文がpycharmでエラー認識されなくなる
• Ans2: Pychramのワーニングを無視する

1. 実行ファイルを選択　> 実行構成の変更　を選択
2. インタープリタオプション欄に次の文字列を設定して起動: -m streamlit run

• 上記設定により、次の実行と同じ意味になる：python -m streamlit run <file-name>

• 参考：公式:WSLを使用してインタープリターを構成

<概略>

1. WSL上にPython仮想環境を構築

1-1. 設定 > Pythonインタープリタ > インタープリタの追加でWSLを選択
1-2. Linuxディストリビューションを確認し、次へを選択
1-3. Virtualenv環境を選択し、基本インタープリタのバージョンを選択後に新規インタプリタを作成 ※　複数バージョンのPythonが存在しなければpython3でOK

2. Python仮想環境に必要パッケージをインストール

• 方法1. PycharmのGUIで必要パッケージを追加
• 方法2. WSLのPython仮想環境に入り、必要パッケージをコマンドで追加　※　こちらの手順のほうが楽かも

3. 環境構築完了後、Pychramから指定ファイルを実行する

<概略>

1. リモートサーバのSSH接続設定：　リモートサーバとSSH接続を有効にする設定を行う
2. リモートサーバのpythonインタプリタを設定：　リモートサーバ上のPythonインタプリタを利用する設定を行う
3. リモートサーバへローカルファイルを転送、またはgit clone：　リモートサーバにローカル環境と同じディレクトリ構成になる様にファイル転送する
4. 任意ファイルのデバッグを行う
5. バグが出たら、ローカルファイルを修正し、再度3～4を繰り返す。

<注意>

• SSHサーバの二段階認証を使う場合は、.sshファイルを設定する

1-1. SSHサーバ設定

• 参考：SSH構成を作成する

  1. ファイル > 設定 > ツール > SSH 構成を選択
  2. +クリックで設定を新規作成
  3. 接続パラメータを設定
  • ホスト名：IP address
  • ユーザ名：ログインアカウント名
  • 認証方法：キーペア　※　秘密鍵を設定
  4. 接続テストを実行し、接続設定を確認

1-2. SSHサーバの接続

• 参考：SSH ターミナルを実行
  1. ツール > SSHセッションの開始を選択
  2. 接続先のサーバを選択する
  3. サーバに接続されたターミナルが表示される

2-1. 初期設定

• 参考：SSH を使用してインタープリターを構成する
  1. ファイル > 設定 > プロジェクト > Python インタープリター を選択
  2. 次に、歯車アイコンをクリックして、追加を選択
  3. Python インタープリターの追加ダイアログの左側のペインで、SSH インタープリターをクリック
  4. 既存サーバー構成を選択し、SSH接続設定したサーバを選択
  5. ターゲットサーバーに接続するための認証の詳細を入力
  6. 次のダイアログウィンドウで、目的の Python インタープリターへのパスを確認(例：/usr/bin/python3)
  7. インタープリターの追加を完了するには、完了をクリック

• 参考：ファイルのアップロードとダウンロード

• 方法1

  1. アップロード対象のファイルまたは、ディレクトリを選択する
  2. 次に、ツール > デプロイ > アップロード を選択する。
  3. 次に、アップロード先のメニューが表示されるので、アップロード先のサーバを選択する

• 方法2

  1. アップロード対象のファイルまたは、ディレクトリを選択し、右クリックする
  2. 次に、デプロイ > アップロード を選択する。
  3. 次に、アップロード先のメニューが表示されるので、アップロード先のサーバを選択する