型ヒントサポート

Amplify SDK は全ての関数、メソッド、アトリビュートに型アノテーションを定義しています。これにより、Visual Studio Code 等の IDE や Google Colaboratory でコードを補完でき、型チェックによってコードのエラーを検出できます。

ヒント

Visual Studio Code を使用している場合は Python 拡張機能をインストールし、次の設定を追加することでコード補完と型チェックが有効になります。

settings.json

{
    "python.languageServer": "Pylance",
    "python.analysis.typeCheckingMode": "basic",
}

ヒント

呼び出すメソッドや関数によっては、型や配列の次元を確定できない場合があります。

例えば amplify.einsum() 関数は、引数の値によって Poly または PolyArray を返します。そのため型を確定できず、型チェッカーはエラーや警告を出すことがあります。このような場合は、次のように型を明示的に指定するとエラーを回避できます。

from amplify import Poly, einsum

# 引数 "ij,ki,kj->" により Poly (スカラー) を返すことが期待されるが型チェッカーには判別できない
objective: Poly = einsum("ij,ki,kj->", d, q1, q2)  # type: ignore