mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-04 11:49:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Merged revisions 66085 (with modifications) via svnmerge from

Browse source 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r66085 | nick.coghlan | 2008-08-31 23:10:50 +1000 (Sun, 31 Aug 2008) | 1 line

  Issue 2235: document the ability to block inheritance of __hash__ in the language reference
........
This commit is contained in:
Nick Coghlan 2008-08-31 13:21:24 +00:00
parent 3a5d7e34ad
commit 73c96dbf34
1 changed files with 20 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

23
Doc/reference/datamodel.rst
View file

@ -1239,12 +1239,29 @@ Basic customization
be in the wrong hash bucket). be in the wrong hash bucket).
User-defined classes have :meth:`__cmp__` and :meth:`__hash__` methods User-defined classes have :meth:`__cmp__` and :meth:`__hash__` methods
by default; with them, all objects compare unequal and ``x.__hash__()`` by default; with them, all objects compare unequal (except with themselves)
returns ``id(x)``. and ``x.__hash__()`` returns ``id(x)``.
Classes which inherit a :meth:`__hash__` method from a parent class but
change the meaning of :meth:`__cmp__` or :meth:`__eq__` such that the hash
value returned is no longer appropriate (e.g. by switching to a value-based
concept of equality instead of the default identity based equality) can
explicitly flag themselves as being unhashable by setting
``__hash__ = None`` in the class definition. Doing so means that not only
will instances of the class raise an appropriate :exc:`TypeError` when
a program attempts to retrieve their hash value, but they will also be
correctly identified as unhashable when checking
``isinstance(obj, collections.Hashable)`` (unlike classes which define
their own :meth:`__hash__` to explicitly raise :exc:`TypeError`).
If a class that overrrides :meth:`__cmp__` or :meth:`__eq__` needs to
retain the implementation of :meth:`__hash__` from a parent class,
the interpreter must be told this explicitly by setting
``__hash__ = <ParentClass>.__hash__``. Otherwise the inheritance of
:meth:`__hash__` will be blocked, just as if :attr:`__hash__` had been
explicitly set to :const:`None`.
.. method:: object.__bool__(self) .. method:: object.__bool__(self)
.. index:: single: __len__() (mapping object method) .. index:: single: __len__() (mapping object method)
Called to implement truth value testing, and the built-in operation ``bool()``; Called to implement truth value testing, and the built-in operation ``bool()``;