default_exception

`app.common.exceptions.default_exception`

Clases para el manejo de excepciones.

Para más información, te recomendamos leer la documentación del Proyecto.

`DefaultException`

Bases: Exception

Esta clase implementa métodos para el manejo de de errores personalizados, con objetos, diccionarios y otros tipos de datos cuando ocurren excepciones.

Examples:

try:
    raise DefaultException("JSONSchema validator error", 7042)

    # ó de la forma
    raise DefaultException("JSONSchema validator error", 7042, {"hello": "error"})
except DefaultException as e:
    logger.exception(e)

    # ejemplo 1
    logger.warning(e.default_msg())

    # ejemplo 2
    logger.warning(e.as_json())

    # ejemplo 3
    logger.warning(e.trace())

`init(description, error_code, extra_data=None)`

Constructor de la clase DefaultException

Parameters:

Name	Type	Description	Default
`description`	`str`	una descripción del error	required
`error_code`	`int`	un código de error personalizado	required
`extra_data`	`Any`	un objeto con información adicional sobre el error, por defecto `None`	`None`

`default_msg()`

Este método devuelve un string con el código de error y la descripción.

Returns:

Name	Type	Description
`str`	`str`	un string con el código de error y la descripción

Examples:

1	`e.default_msg()`

`as_json()`

Este método intenta convertir el tipo de error entrante en un diccionario.

Returns:

Type	Description
`dict[str, Any] \| str`	un diccionario con la información del error
`dict[str, Any] \| str`	un string con la descripción (`self.description`)

Examples:

1	`e.as_json()`

`trace()`

Este método implementa un traceback sencillo para la instancia de clase.

Sí desea una traza de error más completa, utilice loguru en su lugar.

Returns:

Type	Description
`str`	un string con la descripción del error (el `traceback`)

Examples:

1	`e.trace()`

`DefaultTraceback`

Bases: Exception

Esta clase implementa un traceback sencillo para seguimiento de errores.

Notes

No es necesario utilizar esta clase con print ó loguru, sí desea una traza de error más completa, utilice DefaultException ó logger.exception() en su lugar.

Examples:

try:
    1 / 0
except Exception as e:
    DefaultTraceback(e)

default_exception

app.common.exceptions.default_exception