型指定をしていない時にエラーを出したい

Question

実現したいこと

Visual Studio Codeで型指定をしていない時にエラーを出したいです。
sum1のような書き方を強制させたいです。
sum3についての解決方法を探しています。

該当のソースコード

setting.json

{
  "python.analysis.typeCheckingMode": "basic"
}

main.py

# 期待する正しい例。
def sum1(a: int, b: int) -> int:
  return a + b

# 誤った例。関数の引数の型を指定していない。
def sum2(a, b) -> int:
  return a + b

# 誤った例。関数戻り値の型として「int」を指定していない。
def sum3(a: int, b: int):
  return a + b

試したこと

sum2について

reportMissingParameterTypeを追加する事で解決しました。

setting.json

{
  "python.analysis.typeCheckingMode": "basic",

  "python.analysis.diagnosticSeverityOverrides": {
   "reportMissingParameterType": "error",
}

sum3について

解決方法がわかりませんでした。
解決方法を探しています。

補足情報（FW/ツールのバージョンなど）

• Windows 11 64 bit 21H2
• Visual Studio Code 1.70.0
• Python v2022.16.1 (VS Code拡張機能）
• Pylance v2023.1.10 (VS Code拡張機能）

Answer 1

普段はEmacsを使っていて，VSCodeは常用していませんがEmacsで利用しているmypyの拡張が使えないか調べてみました。
手持ちの環境が

• Ubuntu 20.04.3 LTS
• Visual Studio Code 1.81.1
• Python v2023.14.0(機能拡張。識別子:ms-python.python)
• Pylance v2023.8.40(機能拡張。識別子:ms-python.vscode-pylance)

のubuntu版なので，あまり参考にならないかもしれません。

次の2通りが考えられます。

1. Python: Select Linterからmypyを使う方法

手順は次の通りです。

1. mypy(VSCodeではなくPythonの拡張モジュール)のインストール→pip install mypyでmypyモジュールをインストールします。
2. mypyが既にインストール済みの時はバージョンを確認し，1未満の時はpip install -U mypyでアップデートします。
   この操作は，古いバージョンのmypyではタイプ未指定の検出に対応していない可能性を考慮してのことです。
3. コマンドパレットからPython: Select Linterを入力し，mypyを選択します。
4. ソースリストのどこかに# mypy: disallow-untyped-defsの行を入力します。

次の例はソースファイルの最終行あたりに記入した例です。

# 期待する正しい例。
def sum1(a: int, b: int) -> int:
  return a + b

# 誤った例。関数の引数の型を指定していない。
def sum2(a, b) -> int:
  return a + b

# 誤った例。関数戻り値の型として「int」を指定していない。
def sum3(a: int, b: int):
  return a + b
  
# mypy: disallow-untyped-defs

なお，自分が使っている環境ではPython: Select Linterが将来的に廃止となるため非推奨と表示が出ています。
一応settings.jsonの内容です。

{
    "python.linting.mypyEnabled": true,
    "python.linting.enabled": true
}

2. Mypy Type Checker(拡張機能。識別子 ms-python.mypy-type-checker)を使う方法

「Mypy Type Checker」はMicrosoftが開発しているmypy拡張機能で今後はこれが推奨とのことです。

1. Mypy Type Checkerの拡張機能をインストールします。なお，最終的には別バージョンをインストールします。
2. Mypy Type Checkerのプレリリースバージョンをインストールします。
   日本語化している環境では「プレリリースバージョンへの切り替え」を選択します。
   この理由はMypy Type Checkerに含まれるmypyのバージョンをより新しいものを選択したいためです。
3. 拡張機能の再読み込みをします。
4. 前項のように# mypy: disallow-untyped-defsの行を入力します。
5. もしくは次のように設定します。
6. 時々うまく指摘しないことがあるのでコマンドパレットからMypy: Restart Serverを実行します。

5.の設定のsettings.jsonは次の通りです。

{
    他の設定...,
    "mypy-type-checker.args": [
        "--disallow-untyped-defs"
    ],
}

5.の設定画面は次の通りです。

と以上のような感じです。
VSCodeのバージョンが古そうなので，「1.」の方がいいでしょうか？私にはよく分かりません。

なお結果画面は次のような感じです。(2.の設定での実行例)

Comments

[johnwick]

ありがとうございます。2の方法で実現できました。
pylanceを利用せずmypyを利用する必要があるのですね。
（探しても見つからなかったのでおそらくpylanceは戻り値型チェックには対応していない・・・？）

しかし、現時点ではあまり安定しないようです。。。
以下GIF動画のようにVSCode起動直後からエラーが出るまで少し時間がかかっています。
Pythonファイルが動画は1ファイルだけですが、ファイルが多い環境だと更に遅いかもしれません（試していません）
また、GIF動画の通りsum2を修正するとsum3のエラーが出て欲しいところも一緒に消えてしまうようです。
まだリリースされて間もないようですので、安定して動作するまでしばらく待ちたいと思います。
https://ddjkaamml8q8x.cloudfront.net/questions/2023-08-25/999b2937-8eac-4105-b799-e2105cea061f.gif