※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

Dictionary クラスの get インターフェイス

このページではDictionaryクラスのgetメソッドのインターフェイスについて説明します。

インターフェイス概要

getメソッドは引数に指定されたキーの値を返却します。もし指定されたキーが辞書内に存在しなければデフォルトの値を返却します（キーが無くともエラーにはなりません）。

基本的な使い方

getメソッドはkey（辞書のキー）の第一引数を必要とします。第二引数のdefault引数は省略可で、もし指定されなければNoneがデフォルト値となります。

from typing import Any, Optional

import apysc as ap

ap.Stage()
dict_val: ap.Dictionary = ap.Dictionary({"a": 10})
got_val_1: int = dict_val.get(key="a", default=0)
assert got_val_1 == 10

got_val_2: int = dict_val.get(key="b", default=0)
assert got_val_2 == 0

got_val_3: Optional[Any] = dict_val.get(key="b")
assert got_val_3 is None

get API

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] get(self, key: Union[~_Key, apysc._type.expression_string.ExpressionString], *, default: Union[~DefaultType, NoneType] = None) -> ~DefaultType

[インターフェイス概要]

指定されたキーの辞書内の値を取得します。もし指定されたキーが辞書に存在しない場合、このインターフェイスはデフォルト値を返却します。

[引数]

  • key: _Key

    • 対象のキー。

  • default: DefaultType or None, optional

    • 任意のデフォルト値の値。

[返却値]

  • result_value: Any

    • 抽出された値もしくはデフォルト値。

[コードサンプル]

>>> from typing import Optional
>>> import apysc as ap
>>> _ = ap.Stage()
>>> dictionary: ap.Dictionary = ap.Dictionary({"a": 10})
>>> value_1: Optional[int] = dictionary.get("a")
>>> value_1
10

>>> value_2: Optional[int] = dictionary.get("b")
>>> print(value_2)
None

>>> value_3: int = dictionary.get("c", default=0)
>>> value_3
0