What exactly is Python’s iterator protocol?

by

It’s located here in the docs:

One method needs to be defined for container objects to provide iteration support:

container.__iter__()

Return an iterator object. The object is required to support the iterator protocol described below. If a container supports different types of iteration, additional methods can be provided to specifically request iterators for those iteration types. (An example of an object supporting multiple forms of iteration would be a tree structure which supports both breadth-first and depth-first traversal.) This method corresponds to the tp_iter slot of the type structure for Python objects in the Python/C API.

The iterator objects themselves are required to support the following two methods, which together form the iterator protocol:

iterator.__iter__()

Return the iterator object itself. This is required to allow both containers and iterators to be used with the for and in statements. This method corresponds to the tp_iter slot of the type structure for Python objects in the Python/C API.

iterator.__next__()

Return the next item from the container. If there are no further items, raise the StopIteration exception. This method corresponds to the tp_iternext slot of the type structure for Python objects in the Python/C API.

More Related Contents:

  1. What is the fastest and pythonic way to generate a list [(0,0), (0,1), (0,2)…(0,100)]? [closed]
  2. how to can i go over a file twice?
  3. List Element without iteration
  4. Python Error with iteration, for loop
  5. What exactly are iterator, iterable, and iteration?
  6. Does pandas iterrows have performance issues?
  7. Are for-loops in pandas really bad? When should I care?
  8. Iterating through a range of dates in Python
  9. Iterating on a file doesn’t work the second time
  10. Is there a way in Pandas to use previous row value in dataframe.apply when previous value is also calculated in the apply?
  11. Iterating each character in a string using Python
  12. Loop that also accesses previous and next values
  13. Iterate over object attributes in python [duplicate]
  14. recursive iteration through nested json for specific key in python
  15. How to loop over grouped Pandas dataframe?
  16. How to recursively find specific key in nested JSON?
  17. Is generator.next() visible in Python 3?
  18. Converting a list of tuples into a dict
  19. How to loop backwards in python? [duplicate]
  20. How to transform string of space-separated key,value pairs of unique words into a dict
  21. Iteration over list slices
  22. “For” loop first iteration
  23. Set iteration order varies from run to run
  24. Python: Adding element to list while iterating
  25. How can I collect the results of a repeated calculation in a list, dictionary etc. (make a copy of a list with each element modified)?
  26. What is the meaning of list[:] in this code? [duplicate]
  27. Customizing unittest.mock.mock_open for iteration
  28. range(len(list)) or enumerate(list)? [duplicate]
  29. Do python’s variable length arguments (*args) expand a generator at function call time?
  30. Iterate over a string 2 (or n) characters at a time in Python

Leave a Comment