Dictionary length interface¶

What interface is this?¶

The length property returns the length of dictionary keys.

Basic usage¶

The length property interface returns the Int value. There is no setter interface.

import apysc as ap

ap.Stage()
dict_1: ap.Dictionary = ap.Dictionary({"a": 10, "b": 20})
assert dict_1.length == 2
assert isinstance(dict_1.length, ap.Int)

Note for the len function¶

The Python built-in len function is not supported and raises an exception:

import apysc as ap

dict_1: ap.Dictionary = ap.Dictionary({"a": 10, "b": 20})
len(dict_1)

Exception: Dictionary instance can't apply len function. Please use length property instead.

length property API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface summary]

Get length of this dictionary values.

[Returns]

• length: Int

  • This dictionary value’s length.

[Examples]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> dictionary: ap.Dictionary = ap.Dictionary({"a": 1, "b": 2})
>>> dictionary.length
Int(2)