VSCodeの拡張機能でPython docstringを生成する

前回の記事ではVSCodeによるPythonのテストとデバッグについて紹介しました。
Pythonのdocstringですが、書き方を忘れてしまったり、書くのが面倒だったりしますよね。
今回は面倒なdocstringを少しでも楽に記述する為の拡張機能を紹介します。

環境情報

拡張機能のインストール

今回使用するPython docstring用の拡張機能VSCodeにインストールします。

marketplace.visualstudio.com

docstringの生成

拡張機能のインストールが作成できたら、関数が書かれた適当な.pyファイルを開きます。
今回は以下の関数でdocstringを作成してみました。

from typing import Optional, Union


def func(a: str, b: Union[int, float], c: int = 1) -> int:
    return b

まずは、関数の先頭に"""を挿入します。
そうすると「Generate Docstring」と表示されるため、これを選択します。 f:id:gri-blog:20210617151453p:plain

すると...

f:id:gri-blog:20210617152152p:plain

docstringのテンプレートが挿入されました!
あとは、ハイライトされている箇所の説明を書くだけです!
Tabキーを押すと編集箇所を切り替える事が可能です。
型ヒントを書いていると型情報についても自動で記載してくれるので手間が大きく省けますね!

Styleの変更

デフォルトでは「Google Style」のdocstringとなっていますが、「Numpy Style」などの他のフォーマットにも対応しています。 設定のAuto Docstring: Docstring Formatから変更可能です。 f:id:gri-blog:20210617152501p:plain

おわりに

docstringを書く習慣を付けて、技術的負債を少しでも減らしましょう!

仲田 勇太