summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2012-10-07 08:29:32 (GMT)
committerArmin Ronacher <armin.ronacher@active-4.com>2012-10-07 08:29:32 (GMT)
commit74b38b190faae988b4951cf46d83f853589aa530 (patch)
tree3259a32fff2a205c6d3d74d9a04c165eb5908686 /Doc
parent96e936712f2d926fb566c8680958a07fc6b84c71 (diff)
downloadcpython-74b38b190faae988b4951cf46d83f853589aa530.zip
cpython-74b38b190faae988b4951cf46d83f853589aa530.tar.gz
cpython-74b38b190faae988b4951cf46d83f853589aa530.tar.bz2
Issue #16148: Small improvements and cleanup. Added version information
to docs.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/object.rst2
-rw-r--r--Doc/library/operator.rst2
-rw-r--r--Doc/reference/datamodel.rst9
3 files changed, 13 insertions, 0 deletions
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 8458fe8..e4769b3 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -349,6 +349,8 @@ is considered sufficient for this determination.
returning the default value. On error ``-1`` is returned. This is the
equivalent to the Python expression ``operator.length_hint(o, default)``.
+ .. versionadded:: 3.4
+
.. c:function:: PyObject* PyObject_GetItem(PyObject *o, PyObject *key)
Return element of *o* corresponding to the object *key* or *NULL* on failure.
diff --git a/Doc/library/operator.rst b/Doc/library/operator.rst
index 93f33ff..1cd87fc 100644
--- a/Doc/library/operator.rst
+++ b/Doc/library/operator.rst
@@ -241,6 +241,8 @@ their character equivalents.
actual length, then an estimate using ``__length_hint__``, and finally
returning the default value.
+ .. versionadded:: 3.4
+
The :mod:`operator` module also defines tools for generalized attribute and item
lookups. These are useful for making fast field extractors as arguments for
:func:`map`, :func:`sorted`, :meth:`itertools.groupby`, or other functions that
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 6b23d3f..111ad8b 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1805,6 +1805,15 @@ through the container; for mappings, :meth:`__iter__` should be the same as
considered to be false in a Boolean context.
+.. method:: object.__length_hint__(self)
+
+ Called to implement ``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.
+
+ .. versionadded:: 3.4
+
.. note::
Slicing is done exclusively with the following three methods. A call like ::