関数の引数の型ヒントをカイゼンするFlake8 pluginを作りました！！

関数の引数の型ヒントをカイゼンするFlake8 pluginを作りました！！

Event:

みんなのPython勉強会#109 LT

Presented:

2024/10/17 nikkie

お前、誰よ

../_images/uzabase-white-logo.png

Pythonの型ヒント

書いている方🙋‍♂️

Python 3.5 から型ヒントが書けるように！

文字列 name を受け取り、文字列を返す関数 greeting
def greeting(name: str) -> str:
    return "Hello " + name

greeting("stapy")  # 'Hello stapy'

🏃‍♂️ 拙ブログ 型ヒントの出自を調べた記事

型ヒントは型チェッカが使う

  • Python処理系が実行するとき、型ヒントは無視

  • 型チェッカ（例：mypy）で 型ヒントをチェック する

# error: Argument 1 to "greeting" has ↵
# incompatible type "int"; expected "str"  [arg-type]
greeting(42)

実行時に無視されても、書くと便利（IMO）

  • 処理系で実行する前に エラーになることに気づける

  • 型チェッカではなく 人が読む前提 で型ヒントを書くことで情報量を増やせる

この型ヒントは、Python公式ドキュメントで 好ましい？ 好ましくない？ クイズ！！！！

要素に1を加える関数の型ヒント

def plus_one(numbers: list[int]) -> list[int]:
    return [n + 1 for n in numbers]

plus_one([1, 2, 3])  # [2, 3, 4]

Python公式ドキュメントで 好ましい？ 好ましくない？

ヒント：引数の型ヒント

def plus_one(
    numbers: list[int]
) -> list[int]:
    return [n + 1 for n in numbers]

Python公式ドキュメントで 好ましい？ 好ましくない？

答え：好 ま し く な い 🙅‍♀️ ！！

Note that to annotate arguments, it is preferred to use an abstract collection type such as Sequence or Iterable rather than to use list or typing.List.

https://docs.python.org/ja/3/library/typing.html#typing.List

意訳

関数の引数を型ヒントするとき、listよりも SequenceやIterableのような抽象コレクション型 を使うのが好ましい

公式ドキュメントを元にした私の考え

+from collections.abc import Iterable

def plus_one(
-    numbers: list[int]
+    numbers: Iterable[int]
) -> list[int]:
    return [n + 1 for n in numbers]

Iterable

その引数の型ヒント、本当に list ですか？

  • list を渡して関数を呼び出してはいる

  • タプルを渡しても 動く（range やジェネレータでも。これらは皆イテラブル）

  • 表したいのは「整数を要素としていて forで回せる」なのでは？

関数の引数の型ヒントをカイゼンするFlake8 pluginを作りました！！

$ pip install flake8-kotoha

https://pypi.org/project/flake8-kotoha/

リンター Flake8

  • コードを実行せずに解析（＝静的解析）して、スタイルや問題を指摘

  • プラグインを書ける ので、「その引数の型ヒント、本当に list か」問うプラグインをこのたび実装

flake8-kotoha「引数の型ヒントをlistにしてはいけません」

$ uv tool install flake8 --with flake8-kotoha
$ flake8 example.py
example.py:1:14: KTH101 Type hint with abstract type `collections.abc.Iterable` or `collections.abc.Sequence`, instead of concrete type `list`

なぜRuffでなくてFlake8？

  • Rust実装の高速なリンター兼フォーマッタ Ruff （Python Monthly Topics）がFlake8・Black・isortなどを置き換えていっているように映る

  • Ruffにplugin機構が現時点でなさそう だからです（あったらやりたいので情報求ム）

まとめ🌯 関数の引数の型ヒントをカイゼンするflake8 pluginを作りました！！

  • 関数の引数に list を渡していたとしても、list を使った型ヒントが好ましいとは 限らない

  • 自作した flake8-kotoha 「引数の型ヒントをlistにしてはいけません」

ご清聴ありがとうございました

Kaizen Type Hint💪

ftnext/kotoha-python-linter

Appendix

関連アウトプット

関連記事

スライドの秘密 〜お前、誰よ 補足〜

attakeiさんの sphinx-revealjs に以下の 自作拡張 を組み合わせて実現

EOF