【Python開発環境】VSCodeの使い方いろいろ

今回はVSCodeでPythonに必要な開発環境を揃えてみます。
知っておくと便利なものの使い方も含めてご紹介しておきます。

育てるとかなり優れた開発環境になることは確かです。
育てられるかどうかがキモですね。

前提条件

Python・VSCodeのインストールが済んでいることが前提です。
インストールがまだの方はインストールをお願いいたします。

Python開発環境をつくっていきますので
Python関連の拡張機能はまだ入っていません。

Japanese Language Pack for Visual Studio Code
日本語化用
Paste Image
マークダウンで画像貼り付け用
vscode-icons
エクスプローラー部のアイコン用
vscode-pets
癒し

現状の僕の拡張機能一式です。Pythonの開発には影響の無いもののみです。
これからPython関連を入れていきます。

Python関係の拡張機能を入れずにVSCodeで実行

Pythonファイルを作る

エクスプローラーエリアで.pyの拡張子のファイルを作成してみます。
アイコンはよく見るPythonの蛇。
拡張機能vscode-iconsのおかげですね。

実行ボタンも普通にありますが残念ながら実行できません。

拡張機能 Pythonのインストール

Pythonそのものズバリの名前の拡張機能を入れます。

Pylanceもついでに入る模様。

実行

以下を入力し実行してみます。
デバッグ実行もしくは F5。
デバッグなしで実行(Ctrl+F5)でも構いません

print("こんにちは世界")

実行できました。

デバッグ実行

以下を入力します。

class SampleClass:

    def print_test(self, msg):
        print(msg)

def main():

    tmp = SampleClass()
    tmp.print_test("こんにちは世界")

if __name__ == '__main__':
    main()

ブレークポイントを貼ってみます。
ブレークポイントを貼りたい位置にカーソルを持って行ってF9。
もしくは以下の領域を左クリック。

デバッグの開始(またはF5)
F5を覚えてしまう方がスムーズです。

ステップイン(F11)。
関数の中に入ります。
F11を覚えてしまう方がスムーズです。

ステップオーバー(F10)。
関数の中に入らずステップ実行。
F10を覚えてしまう方が。。。（略）

ウォッチに追加

デバッグ実行中に変数を選択 → 右クリック → ウォッチに追加も良いですね。
以前に比べて見やすくなってる気がする。
変数をドラッグ＆ドロップができないのが残念。

インテリセンス

tmp.と入力する。.(ドット)を入力された段階でメニューが出ます。
うまく出なければCtrl + Space。
インテリセンスも良いですね。

入力補助

関数ヘッダなどのコメント補助

関数ヘッダのテンプレートを簡単に作ってほしい場合は以下の拡張機能。

拡張機能：autoDocstring

"""(ダブルクォート×3)を入力しGenerate Docstringを選択

イイ感じに自動生成してくれます。

関数ヘッダを整える

インテリセンス時の説明にも関数ヘッダ情報が表示されます。

一気にコメントアウト

これは意外と使うやつです。
僕もこれを知るまでアホみたいに一つずつコメントアウトしていました。

ソースコードを選択します。

編集 → 行コメントの切り替え(もしくは Ctrl + /)

一気にコメントアウトされました。

戻したければ同じように選択して
編集 → 行コメントの切り替え(もしくは Ctrl + /)

コードスニペット

しょっちゅう書き方忘れるメイン関数。
自動で作ってくれたらいいのに・・・。
そんな時はコードスニペット。自分で作れます。

ファイル → ユーザー設定 → ユーザースニペット

コマンドパレットでpyと入力
Pythonが出てくるので選択

サンプルが書かれていますね。
どうでも良いので無視。

以下の文字列を追加します。

    "main": {
        "prefix": "main",
        "body": [
            "if __name__ == '__main__':",
            "\t${0:pass}"
        ],
        "description": "main"
    },

こんな感じ。保存してください。

Pythonファイルに戻ってmainと打ち込みます。
前からいますけど？みたいな感じでいる変なアイコンのmainを選択します。

出たー。

ついでにClassのテンプレートも作っておきます。
便利なSnippetとか集めたら一つネタになるのではなかろうか。

    "class": {
        "prefix": "class",
        "body": [
            "class ${0:ClassName}(object):",
            "",
            "\tdef __init__(self):",
            "\t\t${1:pass}",
        ],
        "description": "class"
    },

まとめ

VSCodeめっちゃええやん。という感じです。
拡張機能Pythonが色々統合していて優秀です。
昔に比べてだいぶ構築が楽になっています。

また、拡張機能を入れていけば
他のIDE(統合開発環境)ではできないようなこともできます。
何なら自力でつくることもできます。

ただ初心者（特に独学）の方は
一式揃っているIDEを僕はおススメします。

Pythonの開発環境で迷われている方は以下をどうぞ。ご参考まで。
【2022年版】Pythonの開発環境おススメ

【Python開発環境構築】VSCodeでPython開発

おわり