]> granicus.if.org Git - python/commitdiff
bpo-37913: document that __length_hint__ can return NotImplemented (GH-15383)
authorJeroen Demeyer <J.Demeyer@UGent.be>
Tue, 10 Sep 2019 14:01:13 +0000 (16:01 +0200)
committerSteve Dower <steve.dower@python.org>
Tue, 10 Sep 2019 14:01:13 +0000 (15:01 +0100)
Doc/reference/datamodel.rst

index 8813f57587f01ad12477c8c0964ce9a8aa529a77..6b9325da2f39afc44699bbfb26c9e9f6deb74cb7 100644 (file)
@@ -2155,8 +2155,10 @@ 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
-   optimization and is never required for correctness.
+   The length must be an integer ``>=`` 0. The return value may also be
+   *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