mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 19:12:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

#1582: document __reversed__, patch by Mark Russell.

Browse source
This commit is contained in:
Georg Brandl 2008-01-06 16:17:56 +00:00
parent ec32b6bce7
commit 81de0d24d5
3 changed files with 24 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/reference/datamodel.rst
View file

@ -1796,6 +1796,22 @@ sequences, it should iterate through the values.
Iterator objects also need to implement this method; they are required to return
themselves. For more information on iterator objects, see :ref:`typeiter`.
.. method:: object.__reversed__(self)
Called (if present) by the :func:`reversed` builtin to implement
reverse iteration. It should return a new iterator object that iterates
over all the objects in the container in reverse order.
If the :meth:`__reversed__` method is not provided, the
:func:`reversed` builtin will fall back to using the sequence protocol
(:meth:`__len__` and :meth:`__getitem__`). Objects should normally
only provide :meth:`__reversed__` if they do not support the sequence
protocol and an efficient implementation of reverse iteration is possible.
.. versionadded:: 2.6
The membership test operators (:keyword:`in` and :keyword:`not in`) are normally
implemented as an iteration through a sequence. However, container objects can
supply the following special method with a more efficient implementation, which