You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Clarify the behavior of __eq__() returning NotImplemented #72971
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee=Noneclosed_at=Nonecreated_at=<Date2016-11-24.08:14:24.477>labels= ['type-feature', 'docs']
title='Clarify the behavior of __eq__() returning NotImplemented'updated_at=<Date2017-01-22.04:45:40.037>user='https://github.com/pkch'
Currently, there's no clear statement as to what exactly the fallback is in case __eq__ returns NotImplemented. It would be good to clarify the behavior of NotImplemented; at least for __eq__, but perhaps also other rich comparison methods. For example: "When NotImplemented is returned from a rich comparison method, the interpreter behaves as if the rich comparison method was not defined in the first place." See http://stackoverflow.com/questions/40780004/returning-notimplemented-from-eq for more discussion.
My understanding of how it works in general is that NotImplemented is just a simple object like None. It doesn’t have any special behaviour on its own. Similarly, if you call a special method like __eq__() manually, there is no fallback, you just get the NotImplemented object. The interpreter calls special methods like __eq__() when evaluating expressions, but the specific behaviour and how NotImplemented is interpreted varies subtly.
To evaluate a == b, if b’s class is a strict subclass of a’s class, b.__eq__(a) is tried first, otherwise a.__eq__(b) is tried first. If that call returns NotImplemented, the first fallback is to try the call. Failing that, the final fallback is the default behaviour for object() instances.
To evaluate a != b, there is another set of fallbacks in the chain, which is to try “not a.__eq__(b)”. So for __eq__(), the fallback depends on the class hierarchy, on whether a reversed call has already been made, and on whether you are evaluating == or !=.
The documentation for comparison operations was cleaned up a while ago (bpo-12067). But there is probably more room for improvement. I think the best thing would be to document the above sort of behaviour as being directly associated with operations like as == and !=, and only indirectly associated with the NotImplemented object and the __eq__() method.
pkch commented on Nov 24, 2016
pkchmannequin
MannequinAuthor
More actions
Martin - what you suggest is precisely what I had in mind (but didn't phrase it as well):
to document the above sort of behaviour as being directly associated with operations like as == and !=, and only indirectly associated with the NotImplemented object and the __eq__() method
Also a minor typo: you meant "If that call returns NotImplemented, the first fallback is to try the *reverse* call."
Activity
pkch commentedon Nov 24, 2016
Currently, there's no clear statement as to what exactly the fallback is in case
__eq__returnsNotImplemented. It would be good to clarify the behavior ofNotImplemented; at least for__eq__, but perhaps also other rich comparison methods. For example: "WhenNotImplementedis returned from a rich comparison method, the interpreter behaves as if the rich comparison method was not defined in the first place." See http://stackoverflow.com/questions/40780004/returning-notimplemented-from-eq for more discussion.vadmium commentedon Nov 24, 2016
The documentation of this that comes to mind is spread over <https://docs.python.org/3.6/reference/datamodel.html#object.\_\_eq__\> and <https://docs.python.org/3.6/reference/expressions.html#value-comparisons\>.
My understanding of how it works in general is that NotImplemented is just a simple object like None. It doesn’t have any special behaviour on its own. Similarly, if you call a special method like __eq__() manually, there is no fallback, you just get the NotImplemented object. The interpreter calls special methods like __eq__() when evaluating expressions, but the specific behaviour and how NotImplemented is interpreted varies subtly.
To evaluate a == b, if b’s class is a strict subclass of a’s class, b.__eq__(a) is tried first, otherwise a.__eq__(b) is tried first. If that call returns NotImplemented, the first fallback is to try the call. Failing that, the final fallback is the default behaviour for object() instances.
To evaluate a != b, there is another set of fallbacks in the chain, which is to try “not a.__eq__(b)”. So for __eq__(), the fallback depends on the class hierarchy, on whether a reversed call has already been made, and on whether you are evaluating == or !=.
The documentation for comparison operations was cleaned up a while ago (bpo-12067). But there is probably more room for improvement. I think the best thing would be to document the above sort of behaviour as being directly associated with operations like as == and !=, and only indirectly associated with the NotImplemented object and the __eq__() method.
pkch commentedon Nov 24, 2016
Martin - what you suggest is precisely what I had in mind (but didn't phrase it as well):
Also a minor typo: you meant "If that call returns NotImplemented, the first fallback is to try the *reverse* call."
vadmium commentedon Nov 25, 2016
Correct, I meant to say the first fallback is the other call.
BTW your suggested text might hold for __eq__(), but for __ne__(), returning NotImplemented seems to bypass the “not a.__eq__(b)” fallback.
[-]Clarify the behavior of NotImplemented[/-][+]Clarify the behavior of __eq__() returning NotImplemented[/+]gh-72971: Clarify the special no-TypeError behavior for equality (#11…
pythongh-72971: Clarify the special no-TypeError behavior for equality (
pythongh-72971: Clarify the special no-TypeError behavior for equality (
[3.12] gh-72971: Clarify the special no-TypeError behavior for equali…
[3.11] gh-72971: Clarify the special no-TypeError behavior for equali…
erlend-aasland commentedon Mar 3, 2024
Resolved by:
pythongh-72971: Clarify the special no-TypeError behavior for equality (
pythongh-72971: Clarify the special no-TypeError behavior for equality (
pythongh-72971: Clarify the special no-TypeError behavior for equality (