Browse Source

bpo-37913: document that __length_hint__ can return NotImplemented (GH-15383)

pull/15860/head
Jeroen Demeyer 7 years ago
committed by Steve Dower
parent
commit
009ef2955d
  1. 6
      Doc/reference/datamodel.rst

6
Doc/reference/datamodel.rst

@ -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

Loading…
Cancel
Save