Fix typings of `ExceptionGroup` and `BaseExceptionGroup` #9230

sobolevn · 2022-11-20T14:08:36Z

There are a lot of things going on in this PR:

Methods no longer return Self type, because of how C implementation works
split and subgroup require Self argument to be in callable, because of how C implementation works
Some casts from BaseExceptionGroup to and from ExceptionGroup are supported. But not all of them

This is a very complex PR. I would love to provide any of my help to the reviewers.

sobolevn · 2022-11-20T14:12:35Z

Ok, pyright has only 10 problems:

/home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:28:13 - error: "assert_type" mismatch: expected "BaseExceptionGroup[BaseException] | None" but received "BaseExceptionGroup[KeyboardInterrupt | SystemExit] | None" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:57:13 - error: "assert_type" mismatch: expected "ExceptionGroup[Exception] | None" but received "ExceptionGroup[ValueError | KeyError] | None" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:88:5 - error: "assert_type" mismatch: expected "tuple[BaseExceptionGroup[BaseException] | None, BaseExceptionGroup[SystemExit] | None]" but received "tuple[BaseExceptionGroup[KeyboardInterrupt | SystemExit] | None, BaseExceptionGroup[SystemExit] | None]" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:173:13 - error: "assert_type" mismatch: expected "ExceptionGroup[Exception] | None" but received "ExceptionGroup[ValueError | KeyError] | None" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:198:5 - error: "assert_type" mismatch: expected "tuple[ExceptionGroup[Exception] | None, ExceptionGroup[ValueError | KeyError] | None]" but received "tuple[ExceptionGroup[TypeError | IndexError] | None, ExceptionGroup[ValueError | KeyError] | None]" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:252:13 - error: "assert_type" mismatch: expected "BaseExceptionGroup[BaseException] | None" but received "BaseExceptionGroup[KeyboardInterrupt | SystemExit] | None" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:255:13 - error: "assert_type" mismatch: expected "ExceptionGroup[Exception] | None" but received "ExceptionGroup[KeyError | TypeError] | None" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:279:13 - error: "assert_type" mismatch: expected "tuple[ExceptionGroup[Exception] | None, BaseExceptionGroup[ValueError] | None]" but received "tuple[ExceptionGroup[TypeError | IndexError] | None, BaseExceptionGroup[ValueError] | None]" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:328:13 - error: "assert_type" mismatch: expected "ExceptionGroup[Exception] | None" but received "ExceptionGroup[KeyError | TypeError] | None" (reportGeneralTypeIssues)
  /home/runner/work/typeshed/typeshed/test_cases/stdlib/builtins/check_exception_group.py:347:13 - error: "assert_type" mismatch: expected "tuple[ExceptionGroup[Exception] | None, ExceptionGroup[ValueError] | None]" but received "tuple[ExceptionGroup[TypeError | IndexError] | None, ExceptionGroup[ValueError] | None]" (reportGeneralTypeIssues)
10 errors, 0 warnings, 0 informations

I will add a version guard later on.

sobolevn · 2022-11-20T14:39:47Z

Looks like we need some other solution for unused # type: ignore comments.

 Running mypy --platform darwin --python-version 3.11 on the test cases for 'invoke'... success
Running mypy --platform darwin --python-version 3.11 on the test cases for 'requests'... success
Running mypy --platform darwin --python-version 3.11 on the standard library test cases... success
Running mypy --platform darwin --python-version 3.10 on the test cases for 'invoke'... success
Running mypy --platform darwin --python-version 3.10 on the test cases for 'requests'... success
Running mypy --platform darwin --python-version 3.10 on the standard library test cases... failure

test_cases/stdlib/builtins/check_exception_group.py:47: error: Unused "type: ignore" comment
test_cases/stdlib/builtins/check_exception_group.py:48: error: Unused "type: ignore" comment
test_cases/stdlib/builtins/check_exception_group.py:67: error: Unused "type: ignore" comment
test_cases/stdlib/builtins/check_exception_group.py:71: error: Unused "type: ignore" comment
...

test_cases/stdlib/builtins/check_exception_group.py

JelleZijlstra · 2022-11-20T15:01:34Z

test_cases/stdlib/builtins/check_exception_group.py

+
+    # `BaseExceptionGroup` can work with `Exception`:
+    beg2 = BaseExceptionGroup("x", [ValueError()])
+    # FIXME: this is not right, runtime returns `ExceptionGroup` instance instead,


Should be doable by overriding __new__ (python/mypy#7188), did you try that?

We have three cases:

BaseExceptionGroup.__new__ can return BaseExceptionGroup for _BaseExceptionT_co

BaseExceptionGroup.__new__ can return ExceptionGroup for _ExceptionT_co

BaseExceptionGroup.__new__ can return custom subclass

Either the first two work or the third one. Suggestions are welcome

test_cases/stdlib/builtins/check_exception_group.py

AlexWaygood · 2022-11-21T13:47:21Z

I have an idea for how to fix the test cases on mypy; I'll get to work on a fix.

For flake8: would an alternative fix be to have from builtins import BaseExceptionGroup, ExceptionGroup at the top of the file?

sobolevn · 2022-11-21T14:08:06Z

@AlexWaygood, thank you, flake8 idea worked!

github-actions · 2022-11-21T17:51:51Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

AlexWaygood · 2022-11-21T17:55:17Z

Hooray, CI is finally green 🎉

sobolevn · 2022-11-23T07:55:49Z

I really hope this is correct now! Ping me in case of any problems.

sobolevn and others added 2 commits November 20, 2022 17:05

Fix typings of ExceptionGroup and BaseExceptionGroup

3412cdd

[pre-commit.ci] auto fixes from pre-commit.com hooks

d6090ed

This comment has been minimized.

Sign in to view

JelleZijlstra and others added 2 commits November 20, 2022 06:29

only in 3.11

4e37a93

[pre-commit.ci] auto fixes from pre-commit.com hooks

5daa26c

This comment has been minimized.

Sign in to view

JelleZijlstra reviewed Nov 20, 2022

View reviewed changes

sobolevn and others added 4 commits November 21, 2022 16:32

Address review

9c06c0a

Fix pyright

0eaf7b8

[pre-commit.ci] auto fixes from pre-commit.com hooks

7e57c9c

Fix flake8

aba41b9

This comment has been minimized.

Sign in to view

Fix flake8

7416e6a

[pre-commit.ci] auto fixes from pre-commit.com hooks

caccf63

This comment has been minimized.

Sign in to view

AlexWaygood mentioned this pull request Nov 21, 2022

Allow adding test cases testing version-dependent Python features #9238

Merged

AlexWaygood added 2 commits November 21, 2022 16:58

Merge remote-tracking branch 'upstream/main' into issue-9219

7c6735b

Add the magic suffix to the test-case filename

93a4638

This comment has been minimized.

Sign in to view

AlexWaygood mentioned this pull request Nov 21, 2022

check_consistent.py: Allow having weird filenames in the test_cases directory #9239

Merged

Merge branch 'main' into issue-9219

8828619

JelleZijlstra merged commit ae58142 into python:main Nov 23, 2022

AlexWaygood mentioned this pull request Nov 23, 2022

Return types for (Base)ExceptionGroup.derive(), .subgroup(), and .split() should not use Self #9219

Closed

jakkdl mentioned this pull request Aug 6, 2023

Add types to _core._run python-trio/trio#2733

Merged

A5rocks mentioned this pull request Aug 10, 2023

misclick python-trio/trio#2748

Closed

jakkdl mentioned this pull request Jan 28, 2025

BaseExceptionGroup should return ExceptionGroup if initialized with non-base exceptions #12972

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix typings of `ExceptionGroup` and `BaseExceptionGroup` #9230

Fix typings of `ExceptionGroup` and `BaseExceptionGroup` #9230

sobolevn commented Nov 20, 2022 •

edited

Loading

sobolevn commented Nov 20, 2022

This comment has been minimized.

sobolevn commented Nov 20, 2022

This comment has been minimized.

JelleZijlstra Nov 20, 2022

sobolevn Nov 21, 2022 •

edited

Loading

AlexWaygood commented Nov 21, 2022 •

edited

Loading

This comment has been minimized.

sobolevn commented Nov 21, 2022

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Nov 21, 2022

AlexWaygood commented Nov 21, 2022

sobolevn commented Nov 23, 2022

Fix typings of ExceptionGroup and BaseExceptionGroup #9230

Fix typings of ExceptionGroup and BaseExceptionGroup #9230

Conversation

sobolevn commented Nov 20, 2022 • edited Loading

sobolevn commented Nov 20, 2022

This comment has been minimized.

sobolevn commented Nov 20, 2022

This comment has been minimized.

JelleZijlstra Nov 20, 2022

Choose a reason for hiding this comment

sobolevn Nov 21, 2022 • edited Loading

Choose a reason for hiding this comment

AlexWaygood commented Nov 21, 2022 • edited Loading

This comment has been minimized.

sobolevn commented Nov 21, 2022

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Nov 21, 2022

AlexWaygood commented Nov 21, 2022

sobolevn commented Nov 23, 2022

Fix typings of `ExceptionGroup` and `BaseExceptionGroup` #9230

Fix typings of `ExceptionGroup` and `BaseExceptionGroup` #9230

sobolevn commented Nov 20, 2022 •

edited

Loading

sobolevn Nov 21, 2022 •

edited

Loading

AlexWaygood commented Nov 21, 2022 •

edited

Loading