]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-37913: document that __length_hint__ can return NotImplemented (GH-15383)
authorSteve Dower <steve.dower@python.org>
Tue, 10 Sep 2019 14:31:26 +0000 (15:31 +0100)
committerGitHub <noreply@github.com>
Tue, 10 Sep 2019 14:31:26 +0000 (15:31 +0100)
Doc/reference/datamodel.rst

index 8813f57587f01ad12477c8c0964ce9a8aa529a77..c6c6e4075039cdb7a1ab5b06ce00b5438b451773 100644 (file)
@@ -2155,7 +2155,9 @@ through the container; for mappings, :meth:`__iter__` should be the same as
 
    Called to implement :func:`operator.length_hint`. Should return an estimated
    length for the object (which may be greater or less than the actual length).
-   The length must be an integer ``>=`` 0. This method is purely an
+   The length must be an integer ``>=`` 0. The return value may also be
+   :const:`NotImplemented`, which is treated the same as if the
+   ``__length_hint__`` method didn't exist at all. This method is purely an
    optimization and is never required for correctness.
 
    .. versionadded:: 3.4