PyCharmで開発する手順メモ(Git, Virtualenv)

作者: コーリー・アルソフ,清水川貴之監訳,清水川貴之,新木雅也
出版社/メーカー: 日経BP社
発売日: 2018/02/24
メディア: 単行本
この商品を含むブログを見る

はじめに

f:id:nwpct1:20141110135056p:plain

この前PyCharmのProfessionalを入れたので、PyCharmの使い方を確認しながらプログラム書いてみる。この記事は、今後PyCharmで開発を行うときにスムーズに開発するためのメモなので僕以外には分かりにくいかもです。ちなみにPyCharmの設定や機能については以前まとめました。

VimからPyCharmに乗り換え(機能の把握と設定) - c-bata web

プロジェクトの作成

f:id:nwpct1:20141110135143p:plain

PyCharmを立ち上げてProject name等を入力。InterpreterはドロップダウンからCreate VirtualEnvを選択し、search_engineを作成して選択。

Gitの設定

メニューの「VCS」>「Enable Version Control Integration Dialog」から「Git」を選択。

GitHub連携

f:id:nwpct1:20141110135220p:plain

「VCS」>「Import into Version Control」>「Share Project on Github」を選択
ログインダイアログが出るのでユーザ名とパスワードを入力してログイン
「specify master password for the password database」と書かれたダイアログが表示される。ここは「Cancel」を選択した。
Repository NameやDescriptionを入力
ProjectをPushするために、Initial Commitを促されるがまだ中途半端でコミットしたくなかったのでキャンセル．
Successfully created empty on GitHub SearchEngineと表示される
SearchEngineのところをクリックするとGiHubのページにジャンプできる

リポジトリが作成されてる事が確認できた。

.gitignoreの設定

Project Structureパネルのプロジェクト名を右クリックして「New」>「File」から「.gitignore」を作成する。.gitignoreを追加すると「.gitignore support plugins」がオススメされるのでインストール。.gitignoreはとりあえず↓のようにした。

$ cat .gitignore
__pycache__/
*.py[cod]

次に、intelliJやPyCharmの.ideaディレクトリをgitでignoreするべきなのかという事に関しては↓の記事で詳しく解説されていたので、この記事のオススメ設定を使わせていただきます。

第35回バージョン管理 ─プロジェクト管理ファイルについて［後編］：Android Studio最速入門～効率的にコーディングするための使い方｜gihyo.jp … 技術評論社

$ cat .idea/.gitignore 
*.xml

!/codeStyleSettings.xml
!/copyright/*.xml
!/fileColors.xml
!/encodings.xml
!/gradle.xml
!/runConfigurations/*.xml

!/inspectionProfiles/*.xml
/inspectionProfiles/profiles_settings.xml

!/scopes/*.xml
/scopes/scope_settings.xml

!/templateLanguages.xml
!/vcs.xml

Git操作

「VCS」>「Commit Changes」でdiffが見れたり、コミットできたりする。ふと思ったんだけどcommitやpushは無理にIDEの機能を使わず、慣れているものを使ったほうがいいかもしれない。今までTerminal上で全てGit管理してきたので、Terminalウィンドウからコミットした。SourceTreeとか使ってる人はそちらを使ってもいいと思う。

$ git status
$ git add .
$ git commit -m "initial commit"
$ git config -l | grep github
github.user=mejiro
remote.origin.url=https://github.com/mejiro/SearchEngine.git
$ git push -u origin master

インタプリタの切り替え、パッケージ管理

f:id:nwpct1:20141115181801p:plain

「Preferences」の「Project Interpreter」からInterpreterの切り替えやvirtualenvの作成等が出来る。「＋」ボタンでパッケージのインストールも出来る。

その他便利機能

Command+N

これはAndroid Studioを使っていて知ったことなんだけど、コンストラクタやgetter、setterを作りたい時は、「Command+N」から自動生成できる。
Shiftダブルクリック

intelliJ系のIDEではおなじみの検索機能
自動フォーマット(整形)

Command + Alt + L
Documentation Blockの自動生成

メソッドの下で Alt + Enter
Unittestを自動生成
py.testやnosetestsを実行

「Run」>「Edit Configulations ...」から「python tests」>「py.test」を選択する. ここではnosetestsとかも選択できる.あとはnameをpytestとか指定しとくと、 Shiftダブルクリックからpytestで実行できる。簡単！

Creating and running a Python unit test - PyCharm - Confluenceに書いてある