summaryrefslogtreecommitdiff
path: root/Doc/reference/datamodel.rst
diff options
context:
space:
mode:
authorEthan Furman <ethan@stoneleaf.us>2014-01-05 06:50:30 -0800
committerEthan Furman <ethan@stoneleaf.us>2014-01-05 06:50:30 -0800
commite641780c824ad6d15a29cb206a21dc7745e6c066 (patch)
tree5655d79fbdb90b0536d0ae70ba08125b9da12192 /Doc/reference/datamodel.rst
parent37f2b5f5fb6ea2b8ec4cbdd809503f33dc6ce146 (diff)
downloadcpython-e641780c824ad6d15a29cb206a21dc7745e6c066.tar.gz
Issue19995: %o, %x, %X now only accept ints
Diffstat (limited to 'Doc/reference/datamodel.rst')
-rw-r--r--Doc/reference/datamodel.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 26d93a6baa..4f19b37cd2 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -2080,9 +2080,17 @@ left undefined.
.. method:: object.__index__(self)
- Called to implement :func:`operator.index`. Also called whenever Python needs
- an integer object (such as in slicing, or in the built-in :func:`bin`,
- :func:`hex` and :func:`oct` functions). Must return an integer.
+ Called to implement :func:`operator.index`, and whenever Python needs to
+ losslessly convert the numeric object to an integer object (such as in
+ slicing, or in the built-in :func:`bin`, :func:`hex` and :func:`oct`
+ functions). Presence of this method indicates that the numeric object is
+ an integer type. Must return an integer.
+
+ .. note::
+
+ When :meth:`__index__` is defined, :meth:`__int__` should also be defined,
+ and both shuld return the same value, in order to have a coherent integer
+ type class.
.. _context-managers: