Commit 85157cd8 authored by Serhiy Storchaka's avatar Serhiy Storchaka Committed by GitHub

bpo-15718: Document the upper bound constrain on the __len__ return value. (#1256)

parent 997a4ade
......@@ -2011,6 +2011,14 @@ through the container; for mappings, :meth:`__iter__` should be the same as
:meth:`__bool__` method and whose :meth:`__len__` method returns zero is
considered to be false in a Boolean context.
.. impl-detail::
In CPython, the length is required to be at most :attr:`sys.maxsize`.
If the length is larger than :attr:`!sys.maxsize` some features (such as
:func:`len`) may raise :exc:`OverflowError`. To prevent raising
:exc:`!OverflowError` by truth value testing, an object must define a
:meth:`__bool__` method.
.. method:: object.__length_hint__(self)
......@@ -2021,6 +2029,7 @@ through the container; for mappings, :meth:`__iter__` should be the same as
.. versionadded:: 3.4
.. note::
Slicing is done exclusively with the following three methods. A call like ::
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment