PEP 654 introduced exception groups: "a combination of multiple unrelated exceptions". This changes how exceptions are handled by the user:
def some_method():
ex1 = ValueError("value_error")
ex2 = TypeError("type_error")
raise ExceptionGroup("exception_group", [ex1, ex2])
try:
some_method()
except (ValueError, TypeError):
print("This will not run")
except Exception:
print("This will run")
try:
some_method()
except ExceptionGroup:
print("This will run")
try:
some_method()
except* (ValueError, TypeError):
print("This will run")Making it important to warn users that they should either catch ExceptionGroup or use except*.
The relevant styleguide section doesn't yet mention exception groups. What would be the correct way to document this?
The docstring below may lead users to not catch ExceptionGroup or use except*, causing their code to break.
def some_method():
"""
My method.
Raises:
ValueError: Some value error.
TypeError: Some type error.
"""The docstring below doesn't make sense for two main reasons:
- The PEP itself describes an exception group as "a combination of multiple unrelated exceptions". How would one describe an exception group that doesn't throw anything in particular?
- The user may want to catch different exception types raised by the exception groups to handle them separately. To do so they would need to open the method itself, defeating the purpose of documenting the exception type.
def some_method():
"""
My method.
Raises:
ExceptionGroup: ???
"""I think we may need entirely new guidelines for exception groups. Maybe something like:
def some_method():
"""
My method.
Raises:
ExceptionGroup:
ValueError: Some value error.
TypeError: Some type error.
"""or
def some_method():
"""
My method.
Raises:
*ValueError: Some value error.
*TypeError: Some type error.
"""
PEP 654 introduced exception groups: "a combination of multiple unrelated exceptions". This changes how exceptions are handled by the user:
Making it important to warn users that they should either catch
ExceptionGroupor useexcept*.The relevant styleguide section doesn't yet mention exception groups. What would be the correct way to document this?
The docstring below may lead users to not catch
ExceptionGroupor useexcept*, causing their code to break.The docstring below doesn't make sense for two main reasons:
I think we may need entirely new guidelines for exception groups. Maybe something like:
or