From: Serhiy Storchaka <storchaka@gmail.com>
Date: Sun, 23 Apr 2017 05:37:58 +0000 (+0300)
Subject: bpo-15718: Document the upper bound constrain on the __len__ return value. (#1256)
X-Git-Tag: v3.7.0a1~914
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=85157cd89a6edac347a5b6871fcf20c500c6fbbf;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 095a2380b379..35925a065fd4 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -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 ::