The Sequence
and Iterable
abstract base classes (can also be used as type annotations) mostly* follow Python’s definition of sequence and iterable. To be specific:
- Iterable is any object that defines
__iter__
or__getitem__
. - Sequence is any object that defines
__getitem__
and__len__
. By definition, any sequence is an iterable. TheSequence
class also defines other methods such as__contains__
,__reversed__
that calls the two required methods.
Some examples:
list
,tuple
,str
are the most common sequences.- Some built-in iterables are not sequences. For example,
reversed
returns areversed
object (orlist_reverseiterator
for lists) that cannot be subscripted.
* Iterable
does not exactly conform to Python’s definition of iterables — it only checks if the object defines __iter__
, and does not work for objects that’s only iterable via __getitem__
(see this table for details). The gold standard of checking if an object is iterable is using the iter
builtin.