builtins --- 組み込み関数と例外

すべての組み込み関数と例外をここで説明します。これらは builtins モジュールからも利用できます。

関数と型

abs(x: Any) Any

数値の絶対値を返します。引数は整数、浮動小数点数、または __abs__() を実装する任意のオブジェクトです。

all(iterable: Iterable[Any]) bool

iterable のすべての要素が真であれば(または iterable が空であれば) True を返します。

any(iterable: Iterable[Any]) bool

iterable のいずれかの要素が真であれば True を返します。iterable が空の場合は False を返します。

bin(x: int) str

整数を "0b" を接頭辞とする2進数の文字列に変換します。引数は Python の整数であるか、 __index__() を実装している必要があります。

class bool(x: Any = False)

ブール値、すなわち True または False のいずれかを返します。x は標準的な真偽判定の手順に従って変換されます。

class bytearray(source: int | str | Iterable[int] | bytes = b'', encoding: str = 'utf-8', errors: str = 'strict')

0〜255の範囲の整数からなる可変長シーケンスです。生成は bytes と同じ規則に従います。すなわち整数から(そのサイズのゼロ埋めバッファを作成)、整数の iterable から、 encoding 付きの文字列から、またはバッファプロトコルをサポートする任意のオブジェクトから生成できます。標準的なシーケンス操作に加えて、インプレースでの変更をサポートします。

classmethod fromhex(string: str) bytearray

16進数の数字ペアからなる文字列から bytearray を構築します。数字ペア間の空白はスキップされます。16進数でない文字があると ValueError が送出されます。

append(val: int) None

単一の値(0〜255の範囲の整数)を bytearray の末尾に追加し、1バイト分だけ伸長します。

center(width: int, fillbyte: bytes) bytes

width の長さのシーケンスの中央に配置し、fillbyte でパディングした内容のコピーを返します。CPython と異なり、fillbyte は必須です。width が現在の長さ以下の場合、データはそのまま返されます。

count(sub: bytes, start: int = 0, end: int = -1) int

スライス [start:end] 内で sub が重複せずに出現する回数を返します。

endswith(suffix: bytes, start: int = 0, end: int = -1) bool

内容が suffix で終わる場合に True を返します。CPython と異なり、suffix は値のタプルにはできません。

extend(iterable: Iterable[int]) None

iterable のすべての項目を bytearray の末尾に追加します。CPython の拡張として、バッファプロトコルをサポートする任意のオブジェクトを使用できます。

find(sub: bytes, start: int = 0, end: int = -1) int

スライス [start:end] 内で sub が見つかる最小のインデックスを返します。見つからない場合は -1 を返します。

format(*args: Any, **kwargs: Any) str

内容を書式文字列として用いて文字列の書式化操作を行い、書式化された結果を返します。

hex(sep: str = '') str

各バイトについて2桁の16進数からなる文字列を返します。省略可能な sep(長さ1の文字列)が指定された場合、連続するバイト値の間に挿入されます。

index(sub: bytes, start: int = 0, end: int = -1) int

find() と同様ですが、sub が見つからない場合は ValueError を送出します。

isalpha() bool

すべてのバイトが英字のASCII文字であり、かつ少なくとも1バイトある場合に True を返し、それ以外の場合は False を返します。

isdigit() bool

すべてのバイトがASCIIの10進数の数字であり、かつ少なくとも1バイトある場合に True を返し、それ以外の場合は False を返します。

islower() bool

大文字小文字の区別があるすべてのバイトが小文字であり、かつ少なくとも1つそのようなバイトがある場合に True を返し、それ以外の場合は False を返します。

isspace() bool

すべてのバイトがASCIIの空白文字であり、かつ少なくとも1バイトある場合に True を返し、それ以外の場合は False を返します。

isupper() bool

大文字小文字の区別があるすべてのバイトが大文字であり、かつ少なくとも1つそのようなバイトがある場合に True を返し、それ以外の場合は False を返します。

join(iterable: Iterable[bytes]) bytes

bytearray の内容を区切り文字として用いて、iterable の項目を連結した bytes オブジェクトを返します。

lower() bytes

すべてのASCII大文字を小文字に変換した内容のコピーを返します。

lstrip(chars: bytes | None = None) bytes

先頭のバイトを除去したコピーを返します。chars は除去するバイトの集合を指定します。省略されるか None の場合、ASCIIの空白文字が除去されます。

partition(sep: bytes) tuple

sep が最初に出現する箇所で分割し、 (head, sep, tail) を返します。sep が見つからない場合は、内容に続いて2つの空オブジェクトを返します。

replace(old: bytes, new: bytes, count: int = -1) bytes

old のすべての出現箇所を new で置き換えたコピーを返します。count が指定された場合、最初の count 個の出現箇所のみが置き換えられます。

rfind(sub: bytes, start: int = 0, end: int = -1) int

スライス [start:end] 内で sub が見つかる最大のインデックスを返します。見つからない場合は -1 を返します。

rindex(sub: bytes, start: int = 0, end: int = -1) int

rfind() と同様ですが、sub が見つからない場合は ValueError を送出します。

rpartition(sep: bytes) tuple

sep が最後に出現する箇所で分割し、 (head, sep, tail) を返します。sep が見つからない場合は、2つの空オブジェクトに続いて内容を返します。

rsplit(sep: bytes | None = None, maxsplit: int = -1) list

sep が出現する箇所で分割し、断片のリストにします。右側から数えて最大 maxsplit 回の分割を行います。sepNone であるか省略された場合、連続するASCIIの空白文字で分割します。

rstrip(chars: bytes | None = None) bytes

末尾のバイトを除去したコピーを返します。chars は除去するバイトの集合を指定します。省略されるか None の場合、ASCIIの空白文字が除去されます。

split(sep: bytes | None = None, maxsplit: int = -1) list

sep が出現する箇所で分割し、断片のリストにします。sepNone であるか省略された場合、連続するASCIIの空白文字で分割し、先頭と末尾の空白は無視されます。

splitlines(keepends: bool = False) list

\n\r\r\n で改行して、行のリストを返します。keepends が真でない限り、改行は除外されます。

startswith(prefix: bytes, start: int = 0, end: int = -1) bool

内容が prefix で始まる場合に True を返します。CPython と異なり、prefix はタプルにはできず、end は受け付けられますが無視されます。

strip(chars: bytes | None = None) bytes

先頭と末尾のバイトを除去したコピーを返します。chars は除去するバイトの集合を指定します。省略されるか None の場合、ASCIIの空白文字が除去されます。

upper() bytes

すべてのASCII小文字を大文字に変換した内容のコピーを返します。

class bytes(source: int | str | Iterable[int] = b'', encoding: str = 'utf-8', errors: str = 'strict')

0〜255の範囲の整数からなる不変シーケンスです。整数から(ゼロ埋めバッファ)、整数の iterable から、 encoding 付きの文字列から、またはバッファプロトコルをサポートする任意のオブジェクトから生成されます。bytes リテラルは b'...' の構文を使用します。

classmethod fromhex(string: str) bytes

16進数の数字ペアからなる文字列から bytes オブジェクトを構築します。数字ペア間の空白はスキップされます。16進数でない文字があると ValueError が送出されます。

center(width: int, fillbyte: bytes) bytes

width の長さのシーケンスの中央に配置し、fillbyte(パディングするバイトを与える長さ1の bytes)でパディングしたコピーを返します。CPython と異なり、fillbyte は必須です。width がその長さ以下の場合、元のオブジェクトはそのまま返されます。

count(sub: bytes, start: int = 0, end: int = -1) int

スライス [start:end] 内で sub が重複せずに出現する回数を返します。

decode(encoding: str = 'utf-8') str

bytes からデコードした str を返します。MicroPython では encoding 引数は受け付けられますが事実上無視されます(bytes はUTF-8として再解釈されます)。

endswith(suffix: bytes, start: int = 0, end: int = -1) bool

bytes が suffix で終わる場合に True を返します。CPython と異なり、suffix は試行する値のタプルにはできません。

find(sub: bytes, start: int = 0, end: int = -1) int

スライス [start:end] 内で部分列 sub が見つかる最小のインデックスを返します。見つからない場合は -1 を返します。

format(*args: Any, **kwargs: Any) str

bytes を書式文字列として用いて文字列の書式化操作を行い、書式化された結果を返します。

hex(sep: str = '') str

各バイトについて2桁の16進数からなる文字列を返します。省略可能な sep(長さ1の文字列)が指定された場合、連続するバイト値の間に挿入されます。

index(sub: bytes, start: int = 0, end: int = -1) int

find() と同様ですが、sub が見つからない場合は ValueError を送出します。

isalpha() bool

すべてのバイトが英字のASCII文字であり、かつ少なくとも1バイトある場合に True を返し、それ以外の場合は False を返します。

isdigit() bool

すべてのバイトがASCIIの10進数の数字であり、かつ少なくとも1バイトある場合に True を返し、それ以外の場合は False を返します。

islower() bool

大文字小文字の区別があるすべてのバイトが小文字であり、かつ少なくとも1つそのようなバイトがある場合に True を返し、それ以外の場合は False を返します。

isspace() bool

すべてのバイトがASCIIの空白文字であり、かつ少なくとも1バイトある場合に True を返し、それ以外の場合は False を返します。

isupper() bool

大文字小文字の区別があるすべてのバイトが大文字であり、かつ少なくとも1つそのようなバイトがある場合に True を返し、それ以外の場合は False を返します。

join(iterable: Iterable[bytes]) bytes

bytes オブジェクト自身を区切り文字として用いて、iterable の項目を連結した bytes オブジェクトを返します。

lower() bytes

すべてのASCII大文字を小文字に変換したコピーを返します。

lstrip(chars: bytes | None = None) bytes

先頭のバイトを除去したコピーを返します。chars は除去するバイトの集合を指定します。省略されるか None の場合、ASCIIの空白文字が除去されます。

partition(sep: bytes) tuple

sep が最初に出現する箇所で分割し、 (head, sep, tail) を返します。sep が見つからない場合は、bytes に続いて2つの空の bytes オブジェクトを返します。

replace(old: bytes, new: bytes, count: int = -1) bytes

old のすべての出現箇所を new で置き換えたコピーを返します。count が指定された場合、最初の count 個の出現箇所のみが置き換えられます。

rfind(sub: bytes, start: int = 0, end: int = -1) int

スライス [start:end] 内で sub が見つかる最大のインデックスを返します。見つからない場合は -1 を返します。

rindex(sub: bytes, start: int = 0, end: int = -1) int

rfind() と同様ですが、sub が見つからない場合は ValueError を送出します。

rpartition(sep: bytes) tuple

sep が最後に出現する箇所で分割し、 (head, sep, tail) を返します。sep が見つからない場合は、2つの空の bytes オブジェクトに続いて bytes を返します。

rsplit(sep: bytes | None = None, maxsplit: int = -1) list

sep が出現する箇所で分割し、断片のリストにします。右側から数えて最大 maxsplit 回の分割を行います。sepNone であるか省略された場合、連続するASCIIの空白文字で分割します。

rstrip(chars: bytes | None = None) bytes

末尾のバイトを除去したコピーを返します。chars は除去するバイトの集合を指定します。省略されるか None の場合、ASCIIの空白文字が除去されます。

split(sep: bytes | None = None, maxsplit: int = -1) list

sep が出現する箇所で分割し、断片のリストにします。sepNone であるか省略された場合、連続するASCIIの空白文字で分割し、先頭と末尾の空白は無視されます。

splitlines(keepends: bool = False) list

\n\r\r\n で改行して、行のリストを返します。keepends が真でない限り、改行は除外されます。

startswith(prefix: bytes, start: int = 0, end: int = -1) bool

bytes が prefix で始まる場合に True を返します。CPython と異なり、prefix はタプルにはできず、end は受け付けられますが無視されます。

strip(chars: bytes | None = None) bytes

先頭と末尾のバイトを除去したコピーを返します。chars は除去するバイトの集合を指定します。省略されるか None の場合、ASCIIの空白文字が除去されます。

upper() bytes

すべてのASCII小文字を大文字に変換したコピーを返します。

callable(obj: Any) bool

obj が呼び出し可能と思われる場合は True を、そうでない場合は False を返します。

chr(i: int) str

Unicode コードポイントが整数 i である1文字からなる文字列を返します。

classmethod(func: Callable[..., Any]) classmethod

メソッドをクラスメソッドに変換します。通常はデコレータとして使用されます。

compile(source: str | bytes, filename: str, mode: str) Any

sourceexec() または eval() で実行できるコードオブジェクトにコンパイルします。mode"exec""eval""single" のいずれかです。

class complex(real: float | str = 0, imag: float = 0)

実部と虚部から、または文字列から複素数を作成します。

delattr(obj, name: str) None

引数 name は文字列である必要があり、この関数は obj で与えられたオブジェクトから name という名前の属性を削除します。

class dict(*args, **kwargs)

新しい辞書を作成します。CPython の dict と同等です。

classmethod fromkeys(iterable: Iterable[Any], value: Any = None) dict

iterable から取得したキーを持ち、それぞれが value(既定値は None)に対応付けられた新しい辞書を作成します。型に対して呼び出します(例: dict.fromkeys(...))。

clear() None

辞書からすべての項目を削除し、空にします。辞書が固定(読み取り専用)の場合は TypeError を送出します。

copy() dict

辞書の浅いコピーを返します。返されるオブジェクトは元と同じ型(dict または OrderedDict)ですが、固定ではありません。

get(key: Any, default: Any = None) Any

key が辞書にある場合はその値を返し、それ以外の場合は default(その既定値は None であるため KeyError を送出しません)を返します。辞書は変更されません。

items() Any

(key, value) のペアに対する動的なビューオブジェクトを返します。これは辞書への後続の変更を反映し、反復処理、 len()in 演算子、集合比較演算子をサポートします。

keys() Any

キーに対する動的なビューオブジェクトを返します。これは辞書への後続の変更を反映し、反復処理、 len()in 演算子、集合比較演算子をサポートします。

pop(key: Any, default: Any = None) Any

key を辞書から削除し、その値を返します。key が存在しない場合、default が指定されていればそれを返し、それ以外の場合は KeyError を送出します。辞書が固定の場合は TypeError を送出します。

popitem() tuple

任意の (key, value) のペアを2要素のタプルとして削除して返します。通常の dict では選択されるペアは不定です。 OrderedDict では最後に挿入されたペアが削除されます(LIFO)。辞書が空の場合は KeyError を、固定の場合は TypeError を送出します。

setdefault(key: Any, default: Any = None) Any

key が辞書にある場合はその値を返します。それ以外の場合は key を値 default(既定値は None)で挿入し、その値を返します。辞書が固定の場合は TypeError を送出します。

update(*args: Any, **kwargs: Any) None

辞書をインプレースで更新します。位置引数は最大1つまで受け付けます。すなわち別の辞書か、2要素の (key, value) ペアの iterable(各要素はちょうど2項目を生成する必要があり、そうでない場合は ValueError が送出されます)のいずれかです。続いてキーワード引数が文字列キーのエントリとして追加されます。既存のキーは上書きされます。辞書が固定の場合は TypeError を送出します。

values() Any

値に対する動的なビューオブジェクトを返します。これは辞書への後続の変更を反映し、反復処理と len() をサポートします。

__getitem__(key: Any) Any

self[key] を返します。インデックス演算子 d[key] を実装します。key が存在しない場合は KeyError を送出します。

__setitem__(key: Any, value: Any) None

self[key]value を設定します。 d[key] = value を実装します。

__delitem__(key: Any) None

self[key] を削除します。 del d[key] を実装します。key が存在しない場合は KeyError を送出します。

dir(obj: Any = None) list

引数なしの場合、現在のローカルスコープ内の名前のリストを返します。引数を指定した場合、そのオブジェクトの有効な属性のリストを返します。

divmod(a: Any, b: Any) tuple

2つの(複素数でない)数値について、 (a // b, a % b) のペアをタプルとして返します。

enumerate(iterable: Iterable[Any], start: int = 0) Iterator[tuple]

iterable から (index, value) のペアを生成する enumerate オブジェクトを返します。インデックスは start から始まります。

eval(expression: str | bytes, globals: dict | None = None, locals: dict | None = None) Any

文字列として(またはコンパイル済みコードオブジェクトとして)与えられた Python の式を評価し、結果を返します。

exec(object: str | bytes, globals: dict | None = None, locals: dict | None = None) None

文字列またはコンパイル済みコードオブジェクトとして与えられた Python コードを動的に実行します。

filter(function: Callable[[Any], Any] | None, iterable: Iterable[Any]) Iterator[Any]

function が真を返す iterable の要素からイテレータを構築します。functionNone の場合、恒等関数が想定されます。

class float(x: str | bytes | int | float = 0.0)

数値または文字列 x から構築された浮動小数点数を返します。

class frozenset(iterable: Iterable[Any] = ())

新しい frozenset オブジェクトを返します。省略可能で iterable から取得した要素を含めることができます。 frozensetset の不変かつハッシュ可能な変種です。

copy() frozenset

frozenset の浅いコピーを返します。

difference(*others: Iterable[Any]) frozenset

frozenset の要素のうち、others のいずれにも含まれない要素からなる新しい frozenset を返します。各引数は任意の iterable です。

intersection(other: Iterable[Any]) frozenset

frozenset と other に共通する要素からなる新しい frozenset を返します。MicroPython では other 引数を1つだけ受け付けます(CPython は複数受け付けます)。

isdisjoint(other: Iterable[Any]) bool

frozenset が other と共通の要素を持たない場合に True を返します。

issubset(other: Iterable[Any]) bool

frozenset のすべての要素が other に含まれる場合に True を返します。

issuperset(other: Iterable[Any]) bool

other のすべての要素が frozenset に含まれる場合に True を返します。

symmetric_difference(other: Iterable[Any]) frozenset

frozenset または other のいずれか一方にのみ含まれる要素からなる新しい frozenset を返します。MicroPython では other 引数を1つだけ受け付けます。

union(other: Iterable[Any]) frozenset

frozenset と other の要素からなる新しい frozenset を返します。MicroPython では other 引数を1つだけ受け付けます(CPython は複数受け付けます)。

getattr(obj: Any, name: str, default: Any = None) Any

obj の指定された名前の属性の値を返します。属性が存在しない場合、default が指定されていればそれを返し、それ以外の場合は AttributeError が送出されます。

globals() dict

現在のモジュールのグローバルシンボルテーブルを表す辞書を返します。

hasattr(obj: Any, name: str) bool

obj が指定された name の属性を持つ場合に True を、そうでない場合に False を返します。

hash(obj: Any) int

obj のハッシュ値を(持っている場合)返します。ハッシュ値は整数で、辞書ルックアップ時に辞書のキーを素早く比較するために使用されます。

hex(x: int) str

整数を "0x" を接頭辞とする小文字の16進数文字列に変換します。

id(obj: Any) int

オブジェクトの識別値を返します。これは整数で、このオブジェクトの存続期間中、一意かつ一定であることが保証されます。

input(prompt: str = '') str

標準入力から1行を読み取り、文字列として(末尾の改行なしで)返します。prompt が指定された場合、まず末尾の改行なしで標準出力に書き込まれます。

class int(x: str | bytes | int | float = 0, base: int = 10)
classmethod from_bytes(bytes: bytes, byteorder: str) int

MicroPython では、byteorder パラメータは位置引数でなければなりません(これは CPython と互換です)。

to_bytes(size: int, byteorder: str) bytes

MicroPython では、byteorder パラメータは位置引数でなければなりません(これは CPython と互換です)。

注釈

CPython にある省略可能な signed キーワード引数はサポートされていません。MicroPython は現在、負の整数を符号付きとして、正の整数を符号なしとして変換します。(詳細

isinstance(obj: Any, classinfo: type | tuple) bool

objclassinfo またはそのいずれかのサブクラスのインスタンスである場合に True を返します。classinfo はクラスまたはクラスのタプルです。

issubclass(cls: type, classinfo: type | tuple) bool

clsclassinfo の(直接、間接、または仮想の)サブクラスである場合に True を返します。

iter(obj: Any, sentinel: Any = None) Iterator[Any]

イテレータオブジェクトを返します。引数が1つの場合、obj は反復処理プロトコルをサポートしている必要があります。引数が2つの場合、obj は呼び出し可能でなければならず、sentinel を返したときに反復処理が停止します。

len(obj: Any) int

コンテナ内の項目数を返します。

class list(iterable: Iterable[Any] = ())

新しいリストを構築します。省略可能で iterable の項目を投入できます。

append(object: Any) None

object をリストの末尾に追加します。

clear() None

リストからすべての項目を削除し、空にします。

copy() list

リストの浅いコピーを返します。

count(value: Any) int

リスト内で value に等しい要素の数を返します。

extend(iterable: Iterable[Any]) None

iterable のすべての項目をリストの末尾に追加します。iterable 自体がリストの場合はその項目が直接コピーされ、それ以外の場合は反復処理されます。

index(value: Any, start: int = 0, stop: int = -1) int

スライス [start:stop] を検索し、value に等しい最初の要素のインデックスを返します。value が存在しない場合は ValueError を送出します。

insert(index: int, object: Any) None

位置 index の前に object を挿入します。負の index は末尾からの相対位置として解釈され、インデックスは有効範囲に制限されます(そのため、いずれかの端を越える値は先頭または末尾に挿入されます)。

pop(index: int = -1) Any

index の位置にある項目(既定では最後の項目)を削除して返します。リストが空であるか index が範囲外の場合は IndexError を送出します。

remove(value: Any) None

value に等しい最初の要素を削除します。value が存在しない場合は ValueError を送出します。

reverse() None

リストの項目をインプレースで逆順にします。

sort(*, key: Callable[[Any], Any] | None = None, reverse: bool = False) None

リストの項目をインプレースでソートします。keyreverse はキーワード専用です。key は指定された場合、各要素に適用されて比較値を生成する関数です。reverse は降順にソートします。

注釈

CPython と異なり、MicroPython のリストソートは安定ではありません

locals() dict

現在のローカルシンボルテーブルを表す辞書を返します。

map(function: Callable[..., Any], *iterables: Iterable[Any]) Iterator[Any]

functioniterables のすべての項目に適用し、その結果を生成するイテレータを返します。

max(*args: Any, key: Callable[[Any], Any] | None = None, default: Any = None) Any

iterable 引数を1つ指定すると、その最大の項目を返します。引数を2つ以上指定すると、最大の引数を返します。

class memoryview(obj: Any)

obj を参照する memoryview を作成します。obj はバッファプロトコルをサポートしている必要があります(例: bytesbytearrayarray.array)。基になるメモリへのゼロコピーアクセスとスライスを可能にします。memoryview をスライスすると、コピーではなく別の memoryview が返されます。

min(*args: Any, key: Callable[[Any], Any] | None = None, default: Any = None) Any

iterable 引数を1つ指定すると、その最小の項目を返します。引数を2つ以上指定すると、最小の引数を返します。

next(iterator: Iterator[Any], default: Any = None) Any

iterator から次の項目を取得します。default が指定されていてイテレータが尽きている場合、 StopIteration を送出する代わりに default が返されます。

class object

新しい、特徴のないオブジェクトを返します。 object はすべてのクラスの基底クラスです。

oct(x: int) str

整数を "0o" を接頭辞とする8進数文字列に変換します。

open(file: str, mode: str = 'r', **kwargs) Any

file を開き、対応するファイルオブジェクトを返します。mode の既定値はテキスト読み取り用の "r" です。

ord(c: str) int

1文字からなる文字列 c の Unicode コードポイントを整数として返します。

pow(base: Any, exp: Any, mod: Any | None = None) Any

baseexp 乗を返します。mod が指定された場合、 base ** exp % mod を(明示的な形式よりも効率的に計算して)返します。

print(*objects: Any, sep: str = ' ', end: str = '\n', file: Any = None) None

objects をテキストストリーム file に、sep で区切り、end を末尾に付けて出力します。

property(fget: Callable[[Any], Any] | None = None, fset: Callable[[Any, Any], None] | None = None, fdel: Callable[[Any], None] | None = None, doc: str | None = None) property

プロパティ属性を返します。通常はデコレータとして使用され、クラス上で管理された属性を定義します。

range(*args: int) range

整数の不変シーケンスを返します。 range(stop)range(start, stop)range(start, stop, step) として呼び出されます。

repr(obj: Any) str

obj の印字可能な表現を含む文字列を返します。

reversed(seq: Any) Iterator[Any]

指定されたシーケンスの値に対する逆順イテレータを返します。

round(number: Any, ndigits: int | None = None) Any

number を小数点以下 ndigits 桁に丸めた値を返します。ndigits が省略された場合、最も近い整数を返します。

class set(iterable: Iterable[Any] = ())

新しい set オブジェクトを返します。省略可能で iterable から取得した要素を含めることができます。

add(elem: Any) None

要素 elem を集合に追加します。

clear() None

集合からすべての要素を削除します。

copy() set

集合の浅いコピーを返します。

difference(*others: Iterable[Any]) set

集合の要素のうち、others のいずれにも含まれない要素からなる新しい集合を返します。各引数は任意の iterable です。

difference_update(*others: Iterable[Any]) None

others のいずれかに含まれるすべての要素を集合から(インプレースで)削除します。

discard(elem: Any) None

要素 elem が存在する場合、集合から削除します。 remove() と異なり、elem が存在しなくてもエラーを送出しません。

intersection(other: Iterable[Any]) set

集合と other に共通する要素からなる新しい集合を返します。MicroPython では other 引数を1つだけ受け付けます(CPython は複数受け付けます)。

intersection_update(other: Iterable[Any]) None

集合を更新し、other にも含まれる要素のみを残します(インプレース)。MicroPython では other 引数を1つだけ受け付けます。

isdisjoint(other: Iterable[Any]) bool

集合が other と共通の要素を持たない場合に True を返します。

issubset(other: Iterable[Any]) bool

集合のすべての要素が other に含まれる場合に True を返します。

issuperset(other: Iterable[Any]) bool

other のすべての要素が集合に含まれる場合に True を返します。

pop() Any

集合から任意の要素を削除して返します。集合が空の場合は KeyError を送出します。

remove(elem: Any) None

要素 elem を集合から削除します。elem が集合に含まれない場合は KeyError を送出します。

symmetric_difference(other: Iterable[Any]) set

集合または other のいずれか一方にのみ含まれる要素からなる新しい集合を返します。MicroPython では other 引数を1つだけ受け付けます。

symmetric_difference_update(other: Iterable[Any]) None

集合を更新し、集合または other のいずれか一方にのみ含まれる要素のみを残します(インプレース)。MicroPython では other 引数を1つだけ受け付けます。

union(other: Iterable[Any]) set

集合と other の要素からなる新しい集合を返します。MicroPython では other 引数を1つだけ受け付けます(CPython は複数受け付けます)。

update(*others: Iterable[Any]) None

集合を更新し、others すべての要素を追加します(インプレース)。

setattr(obj: Any, name: str, value: Any) None

obj の指定された名前の属性に value を設定します。 getattr() の対をなすものです。

class slice

slice 組み込みは、slice オブジェクトが持つ型です。

sorted(iterable: Iterable[Any], key: Callable[[Any], Any] | None = None, reverse: bool = False) list

iterable の項目から新しいソート済みリストを返します。

staticmethod(func: Callable[..., Any]) staticmethod

メソッドを静的メソッドに変換します。通常はデコレータとして使用されます。

class str(object: Any = '', encoding: str = 'utf-8', errors: str = 'strict')

object の文字列バージョンを返します。object が bytes 風のオブジェクトの場合、encodingerrors 引数がデコードを制御します。

center(width: int) str

width のフィールドの中央に配置し、空白でパディングした文字列のコピーを返します。MicroPython では埋め文字として空白のみが使用され(埋め文字引数はありません)、width がその長さ以下の場合、元の文字列がそのまま返されます。

count(sub: str, start: int = 0, end: int = -1) int

スライス [start:end] 内で sub が重複せずに出現する回数を返します。空の sub は文字間の各すき間を数えます。

encode(encoding: str = 'utf-8', errors: str = 'strict') bytes

文字列をエンコードした bytes オブジェクトを返します。MicroPython は引数を事実上無視してUTF-8を使用します。errors は受け付けられますが処理されません。 bytes(s, "utf-8") と同等です。

endswith(suffix: str | tuple, start: int = 0, end: int = -1) bool

文字列が指定された suffix で終わる場合に True を返します。suffix は単一の文字列、または試行する文字列のタプルです。省略可能な startend で比較対象をスライス [start:end] に制限します。

find(sub: str, start: int = 0, end: int = -1) int

スライス [start:end] 内で部分文字列 sub が見つかる、文字列中の最小のインデックスを返します。見つからない場合は -1 を返します。

format(*args: Any, **kwargs: Any) str

文字列の書式化操作を行い、波括弧 {} で区切られた置換フィールドを argskwargs の値で置換します。標準の書式指定ミニ言語をサポートします。

index(sub: str, start: int = 0, end: int = -1) int

find() と同様ですが、部分文字列 sub がスライス [start:end] 内で見つからない場合は ValueError を送出します。

isalpha() bool

文字列内のすべての文字が英字であり、かつ文字列が空でない場合に True を返し、それ以外の場合は False を返します。

isdigit() bool

文字列内のすべての文字が数字であり、かつ文字列が空でない場合に True を返し、それ以外の場合は False を返します。

islower() bool

文字列が少なくとも1つの英字を含み、かつそのようなすべての文字が小文字である場合に True を返し、それ以外の場合は False を返します。

isspace() bool

文字列内のすべての文字が空白文字であり、かつ文字列が空でない場合に True を返し、それ以外の場合は False を返します。

isupper() bool

文字列が少なくとも1つの英字を含み、かつそのようなすべての文字が大文字である場合に True を返し、それ以外の場合は False を返します。

join(iterable: Iterable[str]) str

iterable 内の文字列を連結し、この文字列を要素間の区切り文字として挿入します。項目は文字列でなければならず、そうでない場合は TypeError が送出されます。

lower() str

すべての文字を小文字に変換した文字列のコピーを返します。

lstrip(chars: str | None = None) str

先頭の文字を除去した文字列のコピーを返します。chars が省略されるか None の場合、空白が除去されます。それ以外の場合、chars は除去する文字の集合として扱われます。

partition(sep: str) tuple

sep が最初に出現する箇所で文字列を分割し、3要素タプル (head, sep, tail) を返します。sep が見つからない場合は (self, "", "") を返します。空の sepValueError を送出します。

replace(old: str, new: str, count: int = -1) str

部分文字列 old のすべての出現箇所を new で置き換えた文字列のコピーを返します。count が指定され、かつ非負の場合、最初の count 個の出現箇所のみが置き換えられます。

rfind(sub: str, start: int = 0, end: int = -1) int

スライス [start:end] 内で部分文字列 sub が見つかる、文字列中の最大のインデックスを返します。見つからない場合は -1 を返します。

rindex(sub: str, start: int = 0, end: int = -1) int

rfind() と同様ですが、部分文字列 sub がスライス [start:end] 内で見つからない場合は ValueError を送出します。

rpartition(sep: str) tuple

sep が最後に出現する箇所で文字列を分割し、3要素タプル (head, sep, tail) を返します。sep が見つからない場合は ("", "", self) を返します。空の sepValueError を送出します。

rsplit(sep: str | None = None, maxsplit: int = -1) list

sep を区切り文字として用いて、文字列を右側から部分文字列のリストに分割し、最大 maxsplit 回の分割を行います。maxsplit がない場合(または負の場合)、 split() と同一に動作します。MicroPython では非負の n を指定した rsplit(None, n)NotImplementedError を送出します。

rstrip(chars: str | None = None) str

末尾の文字を除去した文字列のコピーを返します。chars が省略されるか None の場合、空白が除去されます。それ以外の場合、chars は除去する文字の集合として扱われます。

split(sep: str | None = None, maxsplit: int = -1) list

sep を区切り文字として用いて、文字列を部分文字列のリストに分割し、最大 maxsplit 回の分割を行います。sep が省略されるか None の場合、連続する空白で分割し、先頭の空白は無視されます。それ以外の場合、空の sepValueError を送出します。

splitlines(keepends: bool = False) list

\n\r\r\n で改行して、文字列中の行のリストを返します。keepends が真でない限り、改行は含まれません。

startswith(prefix: str | tuple, start: int = 0, end: int = -1) bool

文字列が指定された prefix で始まる場合に True を返します。prefix は単一の文字列、または試行する文字列のタプルです。省略可能な startend で比較対象をスライス [start:end] に制限します。

strip(chars: str | None = None) str

先頭と末尾の文字を除去した文字列のコピーを返します。chars が省略されるか None の場合、空白が除去されます。それ以外の場合、chars は除去する文字の集合として扱われます。

upper() str

すべての文字を大文字に変換した文字列のコピーを返します。

sum(iterable: Iterable[Any], start: Any = 0) Any

startiterable の項目を左から右へ合計し、その総和を返します。

super(type: type | None = None, obj_or_type: Any | None = None) Any

type の親クラスまたは兄弟クラスにメソッド呼び出しを委譲するプロキシオブジェクトを返します。クラス内でオーバーライドされた継承メソッドにアクセスするのに便利です。

class tuple(iterable: Iterable[Any] = ())

新しいタプルを構築します。省略可能で iterable の項目を投入できます。タプルは不変シーケンスです。

count(value: Any) int

タプル内で value に等しい要素の数を返します。

index(value: Any, start: int = 0, stop: int = -1) int

スライス [start:stop] を検索し、value に等しい最初の要素のインデックスを返します。value が存在しない場合は ValueError を送出します。

type(obj: Any) type

引数が1つの場合、obj の型を返します。返される値は型オブジェクトです。

zip(*iterables: Iterable[Any]) Iterator[tuple]

タプルのイテレータを返します。i 番目のタプルには、各引数 iterable の i 番目の要素が含まれます。反復処理は、最も短い入力 iterable が尽きたときに停止します。

例外

exception AssertionError

assert 文が失敗したときに送出されます。

exception AttributeError

属性の参照または代入が失敗したときに送出されます。

exception Exception

システムを終了させないすべての例外に共通の基底クラスです。

exception ImportError

import 文がモジュール定義を見つけられなかったときに送出されます。

exception IndexError

シーケンスの添字が範囲外のときに送出されます。

exception KeyboardInterrupt

ユーザがプログラムの実行を中断したとき(通常はREPLで Ctrl+C を押したとき)に送出されます。

ソフトブリック化(ブート失敗) の文脈も参照してください。

exception KeyError

マッピング(辞書)のキーが既存のキーの集合の中に見つからないときに送出されます。

exception MemoryError

操作がメモリ不足になったときに送出されます。

exception NameError

ローカルまたはグローバルの名前が見つからないときに送出されます。

exception NotImplementedError

抽象メソッドまたは未実装の機能が呼び出されたときに送出されます。

exception OSError

システム関数がシステム関連のエラーを返したときに送出されます。

exception RuntimeError

他のどのカテゴリにも当てはまらないエラーが検出されたときに送出されます。

exception StopIteration

next() およびイテレータの __next__() メソッドによって、それ以上の項目がないことを知らせるために送出されます。

exception SyntaxError

パーサが構文エラーに遭遇したときに送出されます。

exception SystemExit

sys.exit() によって、インタープリタの終了を要求するために送出されます。ほとんどの例外と異なり、捕捉されなくてもトレースバックを生成しません。

OpenMV Cam では、処理されない SystemExit は現在、MicroPython の ソフトリセット を引き起こします。

exception TypeError

不適切な型のオブジェクトに操作または関数が適用されたときに送出されます。

exception ValueError

組み込みの操作または関数が、正しい型ではあるが不適切な値の引数を受け取ったときに送出されます。

exception ZeroDivisionError

除算または剰余演算の第2引数がゼロのときに送出されます。