【VS Code】Visual Studio Code ~ Python拡張 ~

■ はじめに

https://dk521123.hatenablog.com/entry/2019/10/20/230323
https://dk521123.hatenablog.com/entry/2019/10/24/000000

の続き。

VS CodeでPythonを使う上で便利な拡張機能、
特に、Python で PEP8フォーマット や Docstring に対応できるようにする

PEP8

* 読み方だが、「ペップエイト」だと思ったが、
 「ペペエイト(PePEight)」って言ってる、、、

https://www.youtube.com/watch?v=nVvvDpK5sdE
https://www.youtube.com/watch?v=wf-BqAjZb8M
https://www.youtube.com/watch?v=Hwckt4J96dI
https://www.youtube.com/watch?v=Sm0wwmEwqpI&feature=youtu.be

目次

【1】autoDocstring
【2】flake8
【3】Pylance (2021/03/09追加)

【1】autoDocstring

Pythonのdocstring をサポートする機能

なお、「autoDocstring」について、以下の関連記事を参照のこと。

https://dk521123.hatenablog.com/entry/2019/10/23/212149

実行方法

『[Ctrl]+[Shift]+[2]キー』押下で
コメントのフォーマットを自動生成する

https://www.atmarkit.co.jp/ait/articles/1806/19/news026.html#autodocstring

Googleスタイルに変更するには...
https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

の「Custom Docstring Templates」に記載されている。

[1] 以下の サイトから対象のスタイルをダウンロードする

https://github.com/NilsJPWerner/autoDocstring/tree/master/src/docstring/templates

[2] VS code の「Ctrl + ","キー」押下
[3] 検索欄に「customTemplatePath」を入力
[4] 「Auto Docstring: Custom Template Path」の入力欄に
      [1]でダウンロードしたファイルのフルパスを入力する

【2】flake8

コードスタイルがPEP8準拠かチェック

設定方法
https://qiita.com/psychoroid/items/2c2acc06c900d2c0c8cb

を参考に。

[1] 「Ctrl + ","キー」押下
[2] 検索欄で「python.linting.flake8Enabled」を入力し、チェックを付け、flake8を導入する
[3] 検索欄で「python.linting.pylintEnabled」を入力し、チェックを外し、pylintを無効にする
[4] 検索欄で「python.linting.lintOnSave」を入力し、チェックを付け、保存時のチェックを有効にする
[5] 検索欄で「python.formatting.provider」を入力し、「autopep8」を選択し、自動整形時に「pep8」を指定する

※ 自動整形の実行の仕方について
 => 右クリックで「Format Document」または「Shift +Alt + F」キー押下で実行される

ルール変更1:行数79 を変更するには...

エラー「line too long (86 > 79 characters)flake8(E501)」を
行数79 をもう少し増やすには...
 => 「--max-line-length=XX」で変更する

settings.json

{
  "python.linting.flake8Enabled": true,
  "python.linting.flake8Args": [
    "--max-line-length=85", 
  ],
}

ルール変更2:ルール自身を無視する...

* 「--ignore=EXXX,...」で無視するルールを追記していく

settings.json

{
  "python.linting.flake8Enabled": true,
  "python.linting.flake8Args": [
    "--ignore=E402,F841,F401,E302,E305",
  ],
}

https://stackoverflow.com/questions/50177173/how-do-i-get-flake8-to-reliably-ignore-rules-in-vs-code

【3】Pylance

* Python 開発する上での便利ツール
* Microsoft製

主な機能

* 変数の型チェック
* 入力補完
* 必要なモジュールの自動インポート
など

参考文献
https://usimaru.net/vscode-start-pylance/
https://kamatimaru.hatenablog.com/entry/2020/12/28/043129

関連記事

Python ~ 入門編 ~
https://dk521123.hatenablog.com/entry/2014/08/07/231242
Visual Studio Code ~ 入門編 ~
https://dk521123.hatenablog.com/entry/2019/10/20/230323
Visual Studio CodePythonを設定する ~
https://dk521123.hatenablog.com/entry/2019/10/24/000000
Python の環境設定周りのトラブルシューティング
https://dk521123.hatenablog.com/entry/2020/06/22/174238
Python統合開発環境IDE
https://dk521123.hatenablog.com/entry/2019/09/09/122954
flake8 ~ Pythonコードチェック ~
https://dk521123.hatenablog.com/entry/2020/02/07/000000