はじめに

Pythonは動的型付け言語であり、その柔軟性が特徴ですが、型の不一致によるバグが発生しやすい側面もあります。

Pyrightは、Microsoftが開発した高速かつ効率的なPythonの静的型チェッカーで、型アノテーションを利用してコードの問題を事前に検出することができます。Pyrightは単体でも使用可能で、VSCodeとの統合によるシームレスな型チェックもサポートしています。

この記事では、Pyrightの基本的な使い方から、実践的な活用例までをわかりやすく解説します。

Pyrightとは

Pyrightは、Pythonコードの型チェックを行う静的解析ツールです。以下のような特徴があります：

以下のコマンドを使用してPyrightをインストールします：

npm install -g pyright

注: PyrightはNode.js環境が必要です。未インストールの場合は、Node.js公式サイトからインストールしてください。

Pyrightが正しくインストールされたかを確認するには、以下を実行します：

pyright --version

以下は型アノテーションを含むPythonコードの例です：

example.py

def add_numbers(a: int, b: int) -> int:
    return a + b

以下のコマンドで型チェックを実行します：

pyright example.py

例えば、以下のようなコードがあった場合：

def multiply(a: int, b: int) -> int:
    return a * b

result = multiply(5, "10")  # 間違った型

Pyrightは次のようなエラーを表示します：

error: Argument of type "str" cannot be assigned to parameter "b" of type "int" in function "multiply"

Pyrightは、pyrightconfig.jsonを使ってプロジェクト全体の設定を管理できます。

pyrightconfig.json

{
  "include": ["src"],
  "exclude": ["tests"],
  "strict": true
}

Pyrightは型アノテーションがない場合でも、型を自動で推論します。

def greet(name):
    return f"Hello, {name}!"

型アノテーションがない場合、PyrightはnameをAny型として扱います。

TypedDictを使って、辞書型のカスタム型を定義できます。

from typing import TypedDict

class User(TypedDict):
    name: str
    age: int

def get_user() -> User:
    return {"name": "Alice", "age": 30}

ジェネリクスを使うことで、汎用的な型を定義できます。

from typing import TypeVar, List

T = TypeVar("T")

def get_first_item(items: List[T]) -> T:
    return items[0]

Pyrightは、VSCodeの拡張機能として利用可能です。以下の手順でインストールします：

型アノテーションの適切な追加
型アノテーションを過剰に使用すると、コードが冗長になる場合があります。
外部ライブラリの型サポート
一部の外部ライブラリには型定義がない場合があります。その際は、pyrightconfig.jsonで設定を調整してください。
実行時の影響はない
Pyrightは静的解析ツールであり、実行時には影響を与えません。