PyCharmで良いコードを書くためのTips 7選

この記事はQiitaのAdvent Calendar 2020のPythonその2の12月25日分です。
Qiita Advent Calendar 2020 Python その2

PyCharmで良いコードを書くためのTipsを紹介します。
環境はMacです。


1. コード修正サジェスト

  • ⌥⏎ でコード修正のサジェストリストが表示されます。 

以下の例では、if文のand条件で両方とも同じ変数について評価しています。1つにまとめたほうがわかりやすいので、⌥⏎ を押して「Simplify chained comparison」を選択します。自動でコードを簡素化してくれます。

インスペクションの波線が表示されている。⌥⏎を押す。
Simplify chained comparisonを選択する。
if文が自動で簡素化される。

他にも、不要な変数やカッコを削除したり、クラス内のStaticメソッド見つけたり、様々なコード検査をしてくれます。

PyCharmのコード修正機能はとても強力なので、これを使うだけで読みやすく、良いコードが書けると思います。


2. コード補完

  • ^Space のショートカットで候補リストが表示されます。
  • [PyCharm] – [Preferences…] – [Editor] – [General] – [Code Completion] を開き、 [Auto-display code completion] にチェックを入れると、コードの入力中に、自動でコード補完されるようになります。

コード補完を多用することでタイポする確率が低くなります。また、コードを書くスピードもアップします。


3. 宣言にジャンプ・実装にジャンプ

  • 対象にカーソルを合わせ、 ⌘B で宣言元のクラスやメソッドにジャンプできる。
Path にカーソルを合わせて ⌘ B を押す
Path クラスまでジャンプできる
  • 対象にクラスにカーソルを合わせ、 ⌥⌘B で実装しているクラス(サブクラス)にジャンプできる。
Userにカーソルを合わせて ⌥⌘B を押す
候補が出てくるので選択するとジャンプできる。

既存コードを読む時に便利です。


4. リファクター(リネーム)

  • 変数名を変更するとき、カーソルを合わせて ⇧F6 を押すと一斉に変数名を変更することができます。
sum_num にカーソルを合わせて⇧ F6を押す
新しい変数名を入れる
変更される

変更箇所の漏れを防ぐことができます。


5. クラス・メソッド情報の取得

  • クラスやメソッドにカーソルを合わせて、⇧⌘I を押すとクラスやメソッドの定義が表示されます。
Student(User) の User部分にカーソルを合わせて⇧⌘Iを押す
User クラスの定義が表示される
  • メソッドにカーソルを合わせて、⌘P を押すと、パラメータの情報が表示される。
numpy の concatenate の引数を調べる

引数名や型を忘れた時に便利です。ネットで検索する手間を省けます。


6. 再フォーマット

  • ⌥⌘L を押すと、再フォーマットしてくれます。
① スペースがなく、詰まっている
② 改行が2つもされている
③改行が1つしかない
④ = の前後にスペースがなく、詰まっている
⌥⌘L を押すと、①~④が全て綺麗にフォーマットされる

簡単に見やすいコードになります。


7. Docstringの自動生成

  • メソッド内でダブルクオートを3つ入力してエンターを押すと、自動でDocstringが生成されます。
ダブルクオートを3つ入力してエンターを押す
Docstringの雛形が自動生成される

Docstringに関数の説明を少しでも書いておくと、後から見た時に理解しやすいです。引数が多い時にはこのショートカットがとても便利です。


まとめ

 説明ショートカット
コード修正の提案⌥⏎
コード補完^Space
宣言にジャンプ⌘B
実装にジャンプ⌥⌘B
リファクタ(リネーム)⇧F6
クラス・メソッドの情報表示⇧⌘I
パラメータの情報表示⌘P
再フォーマット⌥⌘L

PyCharmは便利機能がまだまだあるので、そのような内容の記事も投稿していきたいです!

関連記事

このエントリーをはてなブックマークに追加