python-coding-style

name	python-coding-style
description	Pythonコードを作成・修正するときに使用。

全般

• できるだけ型ヒントを付ける。
  • できるだけ汎用的な型ヒントをつける。たとえばlistでもsetでも良いならば、CollectionやIterableを使う。
  • 特に理由がない限り、objectやAnyは避ける。
• docstring は Google スタイルで記述する。
• ログメッセージやコメントは日本語で記述する
• 戻り値をtupleで返そうとする場合は、NamedTuple, dataclass, pydantic modelの使用を検討して、本当にtupleが適切かどうかを判断する。
• モジュールレベルの定数、クラス属性、インスタンス属性などには直後に docstring として記述する。VSCodeのtooltipに表示させるため。
• dictから値を取得する際、必須なキーならばブラケット記法を使う。キーが必須がどうか分からない場合は、必須とみなす。
• match文が利用できる箇所では、if文よりもmatch文を使用する。
  • 必要ならば annofabapi.util.type_util.assert_noreturn を使用して、match文の網羅性を保証する。