W3cubDocs

/pandas 2

pandas.api.types.is_iterator

pandas.api.types.is_iterator(obj)

Check if the object is an iterator.

This is intended for generators, not list-like objects.

Parameters:
obj:The object to check
Returns:
is_iter:bool

Whether obj is an iterator.

Examples

>>> import datetime
>>> from pandas.api.types import is_iterator
>>> is_iterator((x for x in []))
True
>>> is_iterator([1, 2, 3])
False
>>> is_iterator(datetime.datetime(2017, 1, 1))
False
>>> is_iterator("foo")
False
>>> is_iterator(1)
False

© 2008–2011, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team
© 2011–2025, Open source contributors
Licensed under the 3-clause BSD License.
https://pandas.pydata.org/pandas-docs/version/2.3.0/reference/api/pandas.api.types.is_iterator.html