[question] Proper way to implement `ExceptionGroup.derive` method with the existing overloads?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 5.1k
- Forks
- 2.1k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 82
Descripción
Good afternoon,
I was working to implement some custom exception groups in an application that I work on and have had a really hard time getting the types for the derive function to work correctly. Based on reading the documentation linked below, derive is a required method when overriding an exception group to return an instance of it's own class.
Reference
https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.derive
Reproduction / Example
To reproduce this error, I'll use the example shows in the BaseExceptionGroup page, but with type hints:
from __future__ import annotations
from collections.abc import Sequence
from typing import TypeVar
_ExceptionT_co = TypeVar("_ExceptionT_co", bound=Exception, covariant=True)
_ExceptionT = TypeVar("_ExceptionT", bound=Exception)
class MyGroup(ExceptionGroup[_ExceptionT_co]):
def derive(self, excs: Sequence[_ExceptionT]) -> MyGroup[_ExceptionT]:
return MyGroup(self.message, excs)
Mypy output:
❯ mypy ~/Desktop/example.py
/Users/kkirsche/Desktop/example.py:11: error: Signature of "derive" incompatible with supertype "BaseExceptionGroup" [override]
/Users/kkirsche/Desktop/example.py:11: note: Superclass:
/Users/kkirsche/Desktop/example.py:11: note: @overload
/Users/kkirsche/Desktop/example.py:11: note: def [_ExceptionT <: Exception] derive(self, Sequence[_ExceptionT], /) -> ExceptionGroup[_ExceptionT]
/Users/kkirsche/Desktop/example.py:11: note: @overload
/Users/kkirsche/Desktop/example.py:11: note: def [_BaseExceptionT <: BaseException] derive(self, Sequence[_BaseExceptionT], /) -> BaseExceptionGroup[_BaseExceptionT]
/Users/kkirsche/Desktop/example.py:11: note: Subclass:
/Users/kkirsche/Desktop/example.py:11: note: def [_ExceptionT <: Exception] derive(self, excs: Sequence[_ExceptionT]) -> MyGroup[_ExceptionT]
Found 1 error in 1 file (checked 1 source file)
Given that this is working off an exception group rather than a base exception group, I'm unclear on what the proper way to fix this would be and was wondering if the team here was able to provide an example that satisfies mypy / typeshed's overrides for BaseExceptionGroup's derive function.
Thoughts
Would it potentially make sense to add a derive method to ExceptionGroup which returns Self rather than a hardcoded ExceptionGroup? This seems to align with how the documentation describes using this behavior, but I'm not confident I understand fully to submit a pull request with recommended change(s).
Thanks for your time and help, hope you all are having a great day.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza comparando la documentación de BaseExceptionGroup.derive con el ejemplo reportado de MyGroup y la salida de mypy; después, inspecciona las sobrecargas existentes de typeshed para BaseExceptionGroup.derive. Se considera terminado cuando se haya establecido una anotación compatible o un cambio justificado en el stub que resuelva el conflicto de override, con validación frente a la reproducción.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- tooling
- Tipo de issue
- Error
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100