python / python/cpython

richcompare suppresses all errors raised from descriptors of comparison special methods

Open
#131,151 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

interpreter-core type-bug
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Bug report

Bug description:

This is reporting possibly incorrect suppression of all errors generated by descriptors for the comparison special methods __eq__, __lt__, etc. (and possibly some other special methods). This only affects errors during the __get__ stage, while errors from the actual call propagate as expected.

I say possibly incorrect because I can see this being one of those sensitive underbellies that could affect existing behavior for some libraries. However, this seems inconsistent relative to some other special methods like __contains__, __bool__, etc., and since it suppresses all errors like SystemExit, MemoryError, KeyboardInterrupt, etc. it can hide underlying problems or behaviors that are hard to diagnose.

Minimal example

Minimal demonstration of the issue below is a descriptor which always raises an exception during __get__. The result of comparison through == returns False instead of raising the error. The type of error raised from __get__ is not important, it could have been from exit() or anything else down the stack. However, other special methods like __bool__ do raise the exception, as does directly accessing __eq__ as a method.

class BadDescriptor:
  def __get__(self, obj, cls=None):
    assert False

class BadBase:
  __eq__ = BadDescriptor()
  __bool__ = BadDescriptor()

b = BadBase()

print(f"{b == 1=}")
print(f"{b.__eq__(1)=}")
b == 1=False
Traceback (most recent call last):
  File "bad_descriptor.py", line 24, in <module>
    print(f"{b.__eq__(1)=}")
             ^^^^^^^^
  File "bad_descriptor.py", line 14, in __get__
    assert False
           ^^^^^
AssertionError

Suspected cause and proposed resolution

The source of this behavior appears to be in Objects/typeobject.c function slot_tp_richcompare. Currently if an error occurs while getting the comparison method from a descriptor the error is cleared and NotImplemented is returned. Looking at some of the other special methods it seems like there is some inconsistency, some check for PyErr_Occurred and propagate the exception (EG slot_nb_bool), while others clear the error and default to some other action (E.G. slot_tp_repr).

    if (func == NULL) {
        PyErr_Clear();
        Py_RETURN_NOTIMPLEMENTED;
    }

A couple experimental resolutions were attempted to look at the consequence. The first was to treat errors similar to slot_nb_bool, propagating them instead of suppressing.

    if (func == NULL) {
        if(PyErr_Occurred()){
            return NULL;
        }

        Py_RETURN_NOTIMPLEMENTED;
    }

However, this caused a failed test which seems to be checking that raising AttributeError should lead to suppression and default comparison. It is not clear to me if that actually should be the expected behavior, and the comment in the test seems to indicate that it may actually be testing for some internal regression:

======================================================================
ERROR: testForExceptionsRaisedInInstanceGetattr2 (test.test_class.ClassTests.testForExceptionsRaisedInInstanceGetattr2)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/cdodd/proj/contrib/cpython/Lib/test/test_class.py", line 592, in testForExceptionsRaisedInInstanceGetattr2
    E() == E() # In debug mode, caused a C-level assert() to fail
    ^^^^^^^^^^
  File "/home/cdodd/proj/contrib/cpython/Lib/test/test_class.py", line 580, in booh
    raise AttributeError("booh")
AttributeError: booh

But, as a compromise the following alternative checking specifically for AttributeError passes all tests enabled for my current platform. Depending on feedback here I am willing to contribute a pull request once I have a better idea as to what is expected/desired in these cases.

    if (func == NULL) {
        PyObject* exc = PyErr_Occurred();

        if (exc != NULL){
          if (PyErr_GivenExceptionMatches(exc, PyExc_AttributeError)){
            // NOTE: suppresses only "attribute" errors
            PyErr_Clear();
          }else{
            return NULL;
          }
        }

        Py_RETURN_NOTIMPLEMENTED;
    }
CPython versions tested on:

3.14, CPython main branch

Operating systems tested on:

Linux

Linked PRs
  • gh-131187

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Objects/typeobject.c and slot_tp_richcompare, then read test/test_class.py, especially testForExceptionsRaisedInInstanceGetattr2 and its booh helper. Review linked PR gh-131187 and determine the intended handling of descriptor errors during comparison lookup; done means the behavior is decided and the relevant test suite passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.