Coc.nvimを触ってみようアドベントカレンダー 16日目 – coc-pydocstring

とっても楽しいcoc.nvimを触ってみようというアドベントカレンダーです。16日目はcoc-pydocstring。pydoc書いてない関数に対してpydocを追記しなくちゃいけなくなったという状況であれば、この拡張が(内容はさておき)一気に解決してくれます。
2021.12.16

Coc.nvimを触ってみよう Advent Calendar 2021 16日目です。

今回は coc-pydocstring です。

coc-pydocstring について

pythonでpydocを追記するかどうかは人それぞれかもしれません。必ず何らかのpydocを記載をする方針となった場合に(正直避けたい状況ですが)、悩むよりも先に書くという勢いにて記載されていない関数に対して一気に追記してくれるのがdoq。coc-pydocstringはそのdoqをvim上で手軽に非同期実行できる拡張となります。

coc.nvimではない、つまり非同期には行わないタイプのvim-pluginであるvim-pydocstringもありますが、今回は割愛します。

なお、すでに何らかのpydocが記載されている関数についてはそのままとなります。

coc-pydocstring をインストールする

vimを起動した状態で以下のコマンドを実行します。

:CocInstall coc-pydocstring

doqがインストールされない場合、初回はインストールするようにメッセージがでます。

インストールすることで準備完了です。

使ってみる

対象のpyファイルを開いて、以下のコマンドを実行します。

:CocCommand pydocstring.runFile

一瞬でpydocが記載されます。差分をハイライトなりでわかりやすくしていると一目瞭然です。

あとは必要に応じてコメントを書き換えるなどしましょう。

あとがき

pydocがないことでチェックに引っかかるタイプのlinter等もありますが、この拡張はその部分を内容はさておき一気に賄ってくれます。関数名と引数を羅列しただけのpydocを手作業で追記していた場合にはおすすめの拡張です。