fix: avoid conversion to bool in debug response

[geeshta]

Pull Request Checklist

• New code has 100% test coverage
• (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
• (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR

Description

Avoid implicit conversion to bool in _debug_response.py as this causes problems with some sqlalchemy classes, where instead of the original DB error being propagated, a TypeError is raised. See #2381

Close Issue(s)

Closes #2381

[peterschutt]

I suggest adding a test - this is the type of thing that a tool, or an overzealous refactor might reverse at some point down the track without realizing why it is why it is.

This reproduces it:

from inspect import getinnerframes

from litestar.middleware.exceptions._debug_response import get_symbol_name


def test_get_symbol_name_where_type_doesnt_support_bool() -> None:
    class Test:
        def __bool__(self) -> bool:
            raise TypeError("This type doesn't support bool")

        def method(self) -> None:
            raise RuntimeError("Oh no!")

    try:
        Test().method()
    except Exception as e:
        exc = e

    frame = getinnerframes(exc.__traceback__, 2)[-1]
    assert get_symbol_name(frame) == "Test.method"

[geeshta]

I suggest adding a test - this is the type of thing that a tool, or an overzealous refactor might reverse at some point down the track without realizing why it is why it is.

This reproduces it:

from inspect import getinnerframes

from litestar.middleware.exceptions._debug_response import get_symbol_name


def test_get_symbol_name_where_type_doesnt_support_bool() -> None:
    class Test:
        def __bool__(self) -> bool:
            raise TypeError("This type doesn't support bool")

        def method(self) -> None:
            raise RuntimeError("Oh no!")

    try:
        Test().method()
    except Exception as e:
        exc = e

    frame = getinnerframes(exc.__traceback__, 2)[-1]
    assert get_symbol_name(frame) == "Test.method"

I've added the test. I added some type guards because pyright complained about exc being potentially unbound and __traceback__ being potentially None... other solution would by just # type: ignore them.

[peterschutt]

Thanks for this!

[github-actions]

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2384

[peterschutt]

@all-contributors add @geeshta for code bug

[allcontributors]

@peterschutt

I've put up a pull request to add @geeshta! 🎉