utilizar - traceback(most recent call last) python

Tipo de Python insinuando con excepciones

Question

Tengo una función que se parece a esto:

def check_for_errors(result):
    if ''success'' in result:
        return True

    if ''error'' in result:
        raise TypeError

    return False

Al ejecutar con éxito esta función, debería obtener un bool , pero si hay un error, debería obtener un TypeError , lo cual está bien porque lo trato en otra función.

Mi primera línea de función se ve así:

def check_for_errors(result: str) -> bool:

Mi pregunta es: ¿Debo mencionar el error en mis sugerencias de tipo?

Answer 1

Generalmente es una buena idea documentar el error. Esto significa que otro desarrollador que use su función podrá manejar sus errores sin tener que leer su código.

Answer 2

Tipo de insinuación no puede decir nada acerca de las excepciones. Están totalmente fuera del alcance de la función. Sin embargo, todavía puede documentar la excepción en la cadena de documentos.

Desde PEP 484 - Consejos de tipo :

Excepciones

No se propone ninguna sintaxis para listar excepciones explícitamente planteadas. Actualmente, el único caso de uso conocido para esta característica es el de documentación, en cuyo caso, la recomendación es colocar esta información en una cadena de documentos.