Release v4.4.0

Author: imjoehaines

CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+## v4.4.0 (2023-02-21)
+
+### Enhancements
+
+* Sub-exceptions will now be reported when an `ExceptionGroup` or `BaseExceptionGroup` is passed to `bugsnag.notify`. This includes support for the backports provided by the `exceptiongroup` package
+  [#332](https://github.com/bugsnag/bugsnag-python/pull/332)
+  [#338](https://github.com/bugsnag/bugsnag-python/pull/338)
+
 ## v4.3.0 (2022-11-02)
 
 ### Enhancements

bugsnag/event.py

@@ -17,6 +17,15 @@
 
 __all__ = ('Event',)
 
+if sys.version_info < (3, 11):
+    try:
+        from exceptiongroup import BaseExceptionGroup
+    except ImportError:
+        # we're on Python < 3.11 and exceptiongroup isn't installed
+        # an empty tuple can be passed to 'isinstance' safely and will
+        # always return false, so we default to that
+        BaseExceptionGroup = ()
+
 
 class Event:
     """
@@ -254,6 +263,21 @@ def _generate_error_list(
                 )
             )
 
+        # unwrap BaseExceptionGroups so that their contained exceptions are
+        # also reported
+        # we don't recurse into nested BaseExceptionGroups or cause/context
+        # here because there's a big risk of that leading to a huge number of
+        # exceptions, which is difficult to reason about
+        if isinstance(self._original_error, BaseExceptionGroup):
+            for sub_exception in self._original_error.exceptions: # type: ignore # noqa
+                error_list.append(
+                    Error(
+                        class_name(sub_exception),
+                        str(sub_exception),
+                        self._generate_stacktrace(sub_exception.__traceback__)
+                    )
+                )
+
         return error_list
 
     def _generate_stacktrace(

bugsnag/utils.py

@@ -240,13 +240,17 @@ def is_json_content_type(value: str) -> bool:
     return type == 'application' and (subtype == 'json' or suffix == 'json')
 
 
+_ignore_modules = ('__main__', 'builtins')
+
+
 def fully_qualified_class_name(obj):
     module = inspect.getmodule(obj)
-    if module is not None and module.__name__ != "__main__":
-        return module.__name__ + "." + obj.__class__.__name__
-    else:
+
+    if module is None or module.__name__ in _ignore_modules:
         return obj.__class__.__name__
 
+    return module.__name__ + '.' + obj.__class__.__name__
+
 
 def package_version(package_name):
     try:

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name='bugsnag',
-    version='4.3.0',
+    version='4.4.0',
     description='Automatic error monitoring for django, flask, etc.',
     long_description=__doc__,
     author='Simon Maynard',

tests/conftest.py

@@ -1,9 +1,26 @@
 import pytest
-from bugsnag import Breadcrumbs
+import bugsnag
+import bugsnag.legacy as global_setup
+from tests.utils import FakeBugsnagServer
 
 
 # resize the breadcrumb list to 0 before each test to prevent tests from
 # interfering with eachother
 @pytest.fixture(autouse=True)
 def reset_breadcrumbs():
-    Breadcrumbs(0).resize(0)
+    bugsnag.Breadcrumbs(0).resize(0)
+
+
+@pytest.fixture
+def bugsnag_server():
+    server = FakeBugsnagServer(wait_for_duplicate_requests=False)
+    bugsnag.configure(endpoint=server.url, api_key='3874876376238728937')
+
+    yield server
+
+    # Reset shared client config
+    global_setup.configuration = bugsnag.Configuration()
+    global_setup.default_client.configuration = global_setup.configuration
+    global_setup.default_client.uninstall_sys_hook()
+
+    server.shutdown()

tests/fixtures/__init__.py

@@ -1,4 +1,6 @@
 # flake8: noqa
+import sys
+from ..utils import is_exception_group_supported
 
 from .start_and_end_of_file import (
     start_of_file,
@@ -13,3 +15,12 @@
     exception_with_no_cause,
     raise_exception_with_no_cause,
 )
+
+if is_exception_group_supported:
+    from .exception_groups import (
+        exception_group_with_no_cause,
+        base_exception_group_subclass,
+        exception_group_with_nested_group,
+        exception_group_with_implicit_cause,
+        exception_group_with_explicit_cause,
+    )

tests/fixtures/exception_groups.py

@@ -0,0 +1,77 @@
+# flake8: noqa
+try:
+    from exceptiongroup import ExceptionGroup, BaseExceptionGroup # noqa
+except ImportError:
+    # if we're here and 'exceptiongroup' isn't installed, it must mean we're on
+    # Python 3.11+ and have support natively
+    pass
+
+from .caused_by import exception_with_explicit_cause
+
+# this creates an exception with a very small __traceback__, so it's easier to
+# assert against in tests
+def generate_exception(exception_class, message):
+    try:
+        raise exception_class(message)
+    except BaseException as exception:
+        return exception
+
+
+def raise_exception_group_with_no_cause():
+    raise ExceptionGroup('the message of the group', [generate_exception(Exception, 'exception #1'), generate_exception(ArithmeticError, 'exception #2'), generate_exception(NameError, 'exception #3'), generate_exception(AssertionError, 'exception #4')])
+
+
+try:
+    raise_exception_group_with_no_cause()
+except BaseExceptionGroup as exception_group:
+    exception_group_with_no_cause = exception_group
+
+
+class MyExceptionGroup(BaseExceptionGroup):
+    pass
+
+
+def raise_base_exception_group_subclass_with_no_cause():
+    raise MyExceptionGroup('my very easy method just speeds up (n)making exception groups', [generate_exception(GeneratorExit, 'exception #1'), generate_exception(ReferenceError, 'exception #2'), generate_exception(NotImplementedError, 'exception #3')])
+
+
+try:
+    raise_base_exception_group_subclass_with_no_cause()
+except BaseExceptionGroup as exception_group:
+    base_exception_group_subclass = exception_group
+
+
+def raise_exception_group_with_nested_group():
+    raise ExceptionGroup('the message of the group', [generate_exception(Exception, 'exception #1'), exception_group_with_no_cause, generate_exception(ArithmeticError, 'exception #3')])
+
+
+try:
+    raise_exception_group_with_nested_group()
+except BaseExceptionGroup as exception_group:
+    exception_group_with_nested_group = exception_group
+
+
+def raise_exception_group_with_implicit_cause():
+    try:
+        raise_exception_group_with_nested_group()
+    except BaseExceptionGroup as exception_group:
+        raise ExceptionGroup('group with implicit cause', [exception_with_explicit_cause, generate_exception(NameError, 'exception #2')])
+
+
+try:
+    raise_exception_group_with_implicit_cause()
+except BaseExceptionGroup as exception_group:
+    exception_group_with_implicit_cause = exception_group
+
+
+def raise_exception_group_with_explicit_cause():
+    try:
+        raise_exception_group_with_implicit_cause()
+    except BaseExceptionGroup as exception_group:
+        raise ExceptionGroup('group with explicit cause', [generate_exception(NameError, 'exception #1'), exception_with_explicit_cause]) from exception_group
+
+
+try:
+    raise_exception_group_with_explicit_cause()
+except BaseExceptionGroup as exception_group:
+    exception_group_with_explicit_cause = exception_group

tests/integrations/conftest.py

@@ -1,13 +1,12 @@
 import pytest
-from tests.utils import FakeBugsnagServer
-
-import bugsnag.legacy as global_setup
 import bugsnag
+import bugsnag.legacy as global_setup
+from tests.utils import FakeBugsnagServer
 
 
 @pytest.fixture
 def bugsnag_server():
-    server = FakeBugsnagServer()
+    server = FakeBugsnagServer(wait_for_duplicate_requests=True)
     bugsnag.configure(endpoint=server.url, api_key='3874876376238728937')
 
     yield server