Merge pull request #4 from PJECZ:guivaloz/errors-list

Cambia errors a list de str
PJECZ · Jan 23, 2024 · 6f83d86 · 6f83d86
2 parents 3688010 + b405fbc
commit 6f83d86
Show file tree

Hide file tree

Showing 15 changed files with 41 additions and 69 deletions.
diff --git a/.vscode/fastapi-paths.code-snippets b/.vscode/fastapi-paths.code-snippets
@@ -34,7 +34,7 @@
       "\ttry:",
       "\t\tresultados = get_${2:plural}(database)",
       "\texcept MyAnyError as error:",
-      "\t\treturn CustomPage(success=False, errors=str(error))",
+      "\t\treturn CustomPage(success=False, errors=[str(error)])",
       "\treturn paginate(resultados)",
       "",
       "",
@@ -50,7 +50,7 @@
       "\ttry:",
       "\t\t${3:singular} = get_${3:singular}_with_clave(database, ${8:singular_clave})",
       "\texcept MyAnyError as error:",
-      "\t\treturn One${4:EsquemaOut}(success=False, errors=str(error))",
+      "\t\treturn One${4:EsquemaOut}(success=False, errors=[str(error)])",
       "\treturn One${4:EsquemaOut}.model_validate(${3:singular})",
       ""
     ],
@@ -91,7 +91,7 @@
       "\ttry:",
       "\t\tresultados = get_${2:plural}(database)",
       "\texcept MyAnyError as error:",
-      "\t\treturn CustomPage(success=False, errors=str(error))",
+      "\t\treturn CustomPage(success=False, errors=[str(error)])",
       "\treturn paginate(resultados)",
       "",
       "",
@@ -107,7 +107,7 @@
       "\ttry:",
       "\t\t${3:singular} = get_${3:singular}(database, ${3:singular}_id)",
       "\texcept MyAnyError as error:",
-      "\t\treturn One${4:EsquemaOut}(success=False, errors=str(error))",
+      "\t\treturn One${4:EsquemaOut}(success=False, errors=[str(error)])",
       "\treturn One${4:EsquemaOut}.model_validate(${3:singular})",
       ""
     ],
@@ -129,7 +129,7 @@
       "\ttry:",
       "\t\t${3:singular} = create_${3:singular}(database, ${7:Modelo}(**${3:singular}_in.dict()))",
       "\texcept MyAnyError as error:",
-      "\t\treturn ${2:OneEsquemaOut}(success=False, errors=str(error))",
+      "\t\treturn ${2:OneEsquemaOut}(success=False, errors=[str(error)])",
       "\trespuesta = ${2:OneEsquemaOut}.model_validate(${3:singular})",
       "\trespuesta.message = \"${8:descripcion} creada correctamente\"",
       "\treturn respuesta"
@@ -153,7 +153,7 @@
       "\ttry:",
       "\t\t${4:singular} = update_${4:singular}(database, ${2:singular}_id, ${9:Modelo}(**${5:singular}_in.dict()))",
       "\texcept MyAnyError as error:",
-      "\t\treturn ${3:OneEsquemaOut}(success=False, errors=str(error))",
+      "\t\treturn ${3:OneEsquemaOut}(success=False, errors=[str(error)])",
       "\trespuesta = ${3:OneEsquemaOut}.model_validate(${4:singular})",
       "\trespuesta.message = \"${10:descripcion} modificada correctamente\"",
       "\treturn respuesta"
@@ -176,7 +176,7 @@
       "\ttry:",
       "\t\t${4:singular} = delete_${4:singular}(database, ${2:singular}_id)",
       "\texcept MyAnyError as error:",
-      "\t\treturn ${3:OneEsquemaOut}(success=False, errors=str(error))",
+      "\t\treturn ${3:OneEsquemaOut}(success=False, errors=[str(error)])",
       "\trespuesta = ${3:OneEsquemaOut}.model_validate(${4:singular})",
       "\trespuesta.message = \"${7:descripcion} borrada correctamente\"",
       "\treturn respuesta"

diff --git a/README.md b/README.md
@@ -16,17 +16,14 @@ La respuesta que entrega un _paginado_ de items tiene el total, el limit y el of
 {
     "success": true,
     "message": "Success",
-    "errors": "Success",
-    "total": 2812,
+    "errors": [],
     "data": [
         {
             "id": 123,
             ...
         },
         ...
     ],
-    "limit": 100,
-    "offset": 0
 }
 ```
 
@@ -36,7 +33,7 @@ En cambio, la respuesta que entrega un registro es:
 {
     "success": true,
     "message": "Success",
-    "errors": "Success",
+    "errors": [],
     "id": 123,
     ...
 }
@@ -49,7 +46,8 @@ Cuando NO se encuentra un registro el **status code** es **200** pero el **succe
 ```json
 {
   "success": false,
-  "message": "No existe el registro"
+  "message": "",
+  "errors": ["No existe el registro"]
 }
 ```
 

diff --git a/carina/v4/autoridades/paths.py b/carina/v4/autoridades/paths.py
@@ -37,7 +37,7 @@ async def paginado_autoridades(
             es_extinto=es_extinto,
         )
     except MyAnyError as error:
-        return CustomList(success=False, errors=str(error))
+        return CustomList(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -53,5 +53,5 @@ async def detalle_autoridad(
     try:
         autoridad = get_autoridad_with_clave(database, autoridad_clave)
     except MyAnyError as error:
-        return OneAutoridadOut(success=False, errors=str(error))
+        return OneAutoridadOut(success=False, errors=[str(error)])
     return OneAutoridadOut.model_validate(autoridad)
diff --git a/carina/v4/bitacoras/paths.py b/carina/v4/bitacoras/paths.py
@@ -39,7 +39,7 @@ async def paginado_bitacoras(
             usuario_email=usuario_email,
         )
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -55,5 +55,5 @@ async def detalle_bitacora(
     try:
         bitacora = get_bitacora(database, bitacora_id)
     except MyAnyError as error:
-        return OneBitacoraOut(success=False, errors=str(error))
+        return OneBitacoraOut(success=False, errors=[str(error)])
     return OneBitacoraOut.model_validate(bitacora)
diff --git a/carina/v4/distritos/paths.py b/carina/v4/distritos/paths.py
@@ -35,7 +35,7 @@ async def paginado_distritos(
             es_jurisdiccional=es_jurisdiccional,
         )
     except MyAnyError as error:
-        return CustomList(success=False, errors=str(error))
+        return CustomList(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -51,5 +51,5 @@ async def detalle_distrito(
     try:
         distrito = get_distrito_with_clave(database, distrito_clave)
     except MyAnyError as error:
-        return OneDistritoOut(success=False, errors=str(error))
+        return OneDistritoOut(success=False, errors=[str(error)])
     return OneDistritoOut.model_validate(distrito)
diff --git a/carina/v4/entradas_salidas/paths.py b/carina/v4/entradas_salidas/paths.py
@@ -35,7 +35,7 @@ async def paginado_entradas_salidas(
             usuario_email=usuario_email,
         )
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -51,5 +51,5 @@ async def detalle_entrada_salida(
     try:
         entrada_salida = get_entrada_salida(database, entrada_salida_id)
     except MyAnyError as error:
-        return OneEntradaSalidaOut(success=False, errors=str(error))
+        return OneEntradaSalidaOut(success=False, errors=[str(error)])
     return OneEntradaSalidaOut.model_validate(entrada_salida)
diff --git a/carina/v4/materias/paths.py b/carina/v4/materias/paths.py
@@ -29,7 +29,7 @@ async def paginado_materias(
     try:
         resultados = get_materias(database)
     except MyAnyError as error:
-        return CustomList(success=False, errors=str(error))
+        return CustomList(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -45,5 +45,5 @@ async def detalle_materia(
     try:
         materia = get_materia_with_clave(database, materia_clave)
     except MyAnyError as error:
-        return OneMateriaOut(success=False, errors=str(error))
+        return OneMateriaOut(success=False, errors=[str(error)])
     return OneMateriaOut.model_validate(materia)
diff --git a/carina/v4/modulos/paths.py b/carina/v4/modulos/paths.py
@@ -29,7 +29,7 @@ async def paginado_modulos(
     try:
         resultados = get_modulos(database)
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -45,5 +45,5 @@ async def detalle_modulo(
     try:
         modulo = get_modulo(database, modulo_id)
     except MyAnyError as error:
-        return OneModuloOut(success=False, errors=str(error))
+        return OneModuloOut(success=False, errors=[str(error)])
     return OneModuloOut.model_validate(modulo)
diff --git a/carina/v4/permisos/paths.py b/carina/v4/permisos/paths.py
@@ -39,7 +39,7 @@ async def paginado_permisos(
             rol_nombre=rol_nombre,
         )
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -55,5 +55,5 @@ async def detalle_permiso(
     try:
         permiso = get_permiso(database, permiso_id)
     except MyAnyError as error:
-        return OnePermisoOut(success=False, errors=str(error))
+        return OnePermisoOut(success=False, errors=[str(error)])
     return OnePermisoOut.model_validate(permiso)
diff --git a/carina/v4/roles/paths.py b/carina/v4/roles/paths.py
@@ -29,7 +29,7 @@ async def paginado_roles(
     try:
         resultados = get_roles(database)
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -45,5 +45,5 @@ async def detalle_rol(
     try:
         rol = get_rol(database, rol_id)
     except MyAnyError as error:
-        return OneRolOut(success=False, errors=str(error))
+        return OneRolOut(success=False, errors=[str(error)])
     return OneRolOut.model_validate(rol)
diff --git a/carina/v4/tareas/paths.py b/carina/v4/tareas/paths.py
@@ -35,7 +35,7 @@ async def paginado_tareas(
             usuario_email=usuario_email,
         )
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -51,5 +51,5 @@ async def detalle_tarea(
     try:
         tarea = get_tarea(database, tarea_id)
     except MyAnyError as error:
-        return OneTareaOut(success=False, errors=str(error))
+        return OneTareaOut(success=False, errors=[str(error)])
     return OneTareaOut.model_validate(tarea)
diff --git a/carina/v4/usuarios/paths.py b/carina/v4/usuarios/paths.py
@@ -43,7 +43,7 @@ async def paginado_usuarios(
             nombres=nombres,
         )
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -59,5 +59,5 @@ async def detalle_usuario(
     try:
         usuario = get_usuario_with_email(database, usuario_email)
     except MyAnyError as error:
-        return OneUsuarioOut(success=False, errors=str(error))
+        return OneUsuarioOut(success=False, errors=[str(error)])
     return OneUsuarioOut.model_validate(usuario)
diff --git a/carina/v4/usuarios_roles/paths.py b/carina/v4/usuarios_roles/paths.py
@@ -39,7 +39,7 @@ async def paginado_usuarios_roles(
             usuario_email=usuario_email,
         )
     except MyAnyError as error:
-        return CustomPage(success=False, errors=str(error))
+        return CustomPage(success=False, errors=[str(error)])
     return paginate(resultados)
 
 
@@ -55,5 +55,5 @@ async def detalle_usuario_rol(
     try:
         usuario_rol = get_usuario_rol(database, usuario_rol_id)
     except MyAnyError as error:
-        return OneUsuarioRolOut(success=False, errors=str(error))
+        return OneUsuarioRolOut(success=False, errors=[str(error)])
     return OneUsuarioRolOut.model_validate(usuario_rol)
diff --git a/lib/fastapi_pagination_custom_list.py b/lib/fastapi_pagination_custom_list.py
@@ -8,14 +8,10 @@
     {
       "success": true,
       "message": "Success",
-      "errors": "",
-      "total": 116135,
+      "errors": [],
       "data": [
         { ... },
       ],
-      "page": 1,
-      "size": 20,
-      "pages": 18
     }
 
 Usage:
@@ -41,11 +37,10 @@ async def list_examples(
         try:
             query = get_examples(database=database)
         except MyAnyError as error:
-            return CustomList(success=False, errors=str(error))
+            return CustomList(success=False, errors=[str(error)])
         return paginate(query)
 
 """
-from math import ceil
 from typing import Any, Generic, Optional, Sequence, TypeVar
 
 from fastapi import Query
@@ -75,14 +70,9 @@ class CustomList(AbstractPage[T], Generic[T]):
 
     success: bool
     message: str
-    errors: str
+    errors: list[str] = []
     data: Sequence[T] = []
 
-    # total: Optional[GreaterEqualZero] = None
-    # page: Optional[GreaterEqualOne] = None
-    # size: Optional[GreaterEqualOne] = None
-    # pages: Optional[GreaterEqualZero] = None
-
     __params_type__ = CustomListParams
 
     @classmethod
@@ -105,26 +95,10 @@ def create(
                 message="No se encontraron registros",
             )
 
-        # size = params.size if params.size is not None else total
-        # page = params.page if params.page is not None else 1
-        # pages = ceil(total / size) if total is not None else None
-
         return cls(
             success=True,
             message="Success",
-            errors="",
+            errors=[],
             data=items,
             **kwargs,
         )
-
-        # return cls(
-        #     success=True,
-        #     message="Success",
-        #     errors="",
-        #     data=items,
-        #     total=total,
-        #     page=page,
-        #     size=size,
-        #     pages=pages,
-        #     **kwargs,
-        # )
diff --git a/lib/fastapi_pagination_custom_page.py b/lib/fastapi_pagination_custom_page.py
@@ -8,7 +8,7 @@
     {
       "success": true,
       "message": "Success",
-      "errors": "",
+      "errors": [],
       "total": 116135,
       "data": [
         { ... },
@@ -40,7 +40,7 @@ async def list_examples(
         try:
             query = get_examples(database=database)
         except MyAnyError as error:
-            return CustomList(success=False, errors=str(error))
+            return CustomList(success=False, errors=[str(error)])
         return paginate(query)
 
 """
@@ -73,7 +73,7 @@ class CustomPage(AbstractPage[T], Generic[T], ABC):
 
     success: bool
     message: str
-    errors: str
+    errors: list[str] = []
     data: Sequence[T] = []
 
     total: Optional[GreaterEqualZero] = None
@@ -104,7 +104,7 @@ def create(
         return cls(
             success=True,
             message="Success",
-            errors="",
+            errors=[],
             data=items,
             total=total,
             limit=raw_params.limit,