brilliance-admin 0.44.6__tar.gz → 0.44.8__tar.gz

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brilliance-admin
-Version: 0.44.6
+Version: 0.44.8
 Summary: Simple and lightweight data managment framework powered by FastAPI and Vue3 Vuetify all-in-one. Some call it heavenly in its brilliance.
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -40,7 +40,7 @@ Dynamic: license-file
 [![PyPI](https://img.shields.io/pypi/v/brilliance-admin)](https://pypi.org/project/brilliance-admin/)
 [![CI](https://github.com/brilliance-admin/backend-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/brilliance-admin/backend-python/actions)
 
-Simple and lightweight data managment framework powered by `FastAPI` and `Vue3` `Vuetify` all-in-one. \
+Simple and lightweight data management framework powered by `FastAPI` and `Vue3` `Vuetify` all-in-one. \
 Integrated with `SQLAlchemy`. Inspaired by Django Admin and DRF.\
 _Some call it heavenly in its brilliance._
 
@@ -60,6 +60,13 @@ This endpoint can be added to any ASGI compatable backend. For existing project
 - API to fetch the UI JSON schema
 - API methods for that UI to work with (to read and modify data)
 
+<details open>
+<summary><h2>Screenshots</h2></summary>
+<div align="center"><img src="https://github.com/brilliance-admin/.github/blob/main/screenshots/login.png?raw=true"/></div>
+<div align="center"><img src="https://github.com/brilliance-admin/.github/blob/main/screenshots/table.png?raw=true"/></div>
+<div align="center"><img src="https://github.com/brilliance-admin/.github/blob/main/screenshots/charts.png?raw=true"/></div>
+</details>
+
 ## Key ideas
 
 - **API Oriented** <br>

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/README.md

@@ -6,7 +6,7 @@
 [![PyPI](https://img.shields.io/pypi/v/brilliance-admin)](https://pypi.org/project/brilliance-admin/)
 [![CI](https://github.com/brilliance-admin/backend-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/brilliance-admin/backend-python/actions)
 
-Simple and lightweight data managment framework powered by `FastAPI` and `Vue3` `Vuetify` all-in-one. \
+Simple and lightweight data management framework powered by `FastAPI` and `Vue3` `Vuetify` all-in-one. \
 Integrated with `SQLAlchemy`. Inspaired by Django Admin and DRF.\
 _Some call it heavenly in its brilliance._
 
@@ -26,6 +26,13 @@ This endpoint can be added to any ASGI compatable backend. For existing project
 - API to fetch the UI JSON schema
 - API methods for that UI to work with (to read and modify data)
 
+<details open>
+<summary><h2>Screenshots</h2></summary>
+<div align="center"><img src="https://github.com/brilliance-admin/.github/blob/main/screenshots/login.png?raw=true"/></div>
+<div align="center"><img src="https://github.com/brilliance-admin/.github/blob/main/screenshots/table.png?raw=true"/></div>
+<div align="center"><img src="https://github.com/brilliance-admin/.github/blob/main/screenshots/charts.png?raw=true"/></div>
+</details>
+
 ## Key ideas
 
 - **API Oriented** <br>

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/api/views/autocomplete.py

@@ -23,7 +23,7 @@ async def autocomplete(request: Request, group: str, category: str, data: Autoco
     context = {'language_context': language_context}
 
     try:
-        result: AutocompleteResult = await schema_category.autocomplete(data, user, language_context)
+        result: AutocompleteResult = await schema_category.autocomplete(data, user, language_context, schema)
     except AdminAPIException as e:
         return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
     except Exception as e:

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/api/views/table.py

@@ -30,7 +30,7 @@ async def table_list(request: Request, group: str, category: str, list_data: Lis
     context = {'language_context': language_context}
 
     try:
-        result: TableListResult = await schema_category.get_list(list_data, user, language_context)
+        result: TableListResult = await schema_category.get_list(list_data, user, language_context, schema)
     except AdminAPIException as e:
         return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
 
@@ -54,7 +54,7 @@ async def table_retrieve(request: Request, group: str, category: str, pk: Any) -
     context = {'language_context': language_context}
 
     try:
-        result: RetrieveResult = await schema_category.retrieve(pk, user, language_context)
+        result: RetrieveResult = await schema_category.retrieve(pk, user, language_context, schema)
     except AdminAPIException as e:
         return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
 
@@ -77,7 +77,7 @@ async def table_create(request: Request, group: str, category: str) -> CreateRes
     context = {'language_context': language_context}
 
     try:
-        result: CreateResult = await schema_category.create(await request.json(), user, language_context)
+        result: CreateResult = await schema_category.create(await request.json(), user, language_context, schema)
     except AdminAPIException as e:
         return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
 
@@ -100,7 +100,7 @@ async def table_update(request: Request, group: str, category: str, pk: Any) ->
     context = {'language_context': language_context}
 
     try:
-        result: UpdateResult = await schema_category.update(pk, await request.json(), user, language_context)
+        result: UpdateResult = await schema_category.update(pk, await request.json(), user, language_context, schema)
     except AdminAPIException as e:
         return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
 
@@ -129,7 +129,7 @@ async def table_action(
     try:
         # pylint: disable=protected-access
         result: ActionResult = await schema_category._perform_action(
-            request, action, action_data, language_context, user,
+            request, action, action_data, language_context, user, schema,
         )
     except AdminAPIException as e:
         return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/integrations/sqlalchemy/autocomplete.py

@@ -1,11 +1,16 @@
 from brilliance_admin.auth import UserABC
+from brilliance_admin.schema.admin_schema import AdminSchema
 from brilliance_admin.schema.table.table_models import AutocompleteData, AutocompleteResult
 from brilliance_admin.translations import LanguageContext
 
 
 class SQLAlchemyAdminAutocompleteMixin:
     async def autocomplete(
-            self, data: AutocompleteData, user: UserABC, language_context: LanguageContext,
+            self,
+            data: AutocompleteData,
+            user: UserABC,
+            language_context: LanguageContext,
+            admin_schema: AdminSchema,
     ) -> AutocompleteResult:
         form_schema = None
 

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/integrations/sqlalchemy/table/create.py

@@ -1,6 +1,7 @@
 from brilliance_admin import schema
 from brilliance_admin.auth import UserABC
 from brilliance_admin.exceptions import AdminAPIException, APIError
+from brilliance_admin.schema.admin_schema import AdminSchema
 from brilliance_admin.translations import LanguageContext
 from brilliance_admin.translations import TranslateText as _
 from brilliance_admin.utils import get_logger
@@ -16,6 +17,7 @@ class SQLAlchemyAdminCreate:
             data: dict,
             user: UserABC,
             language_context: LanguageContext,
+            admin_schema: AdminSchema,
     ) -> schema.CreateResult:
         if not self.has_create:
             raise AdminAPIException(APIError(message=_('errors.method_not_allowed')), status_code=500)

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/integrations/sqlalchemy/table/delete.py

@@ -12,7 +12,7 @@ class SQLAlchemyDeleteAction:
         base_color='red-lighten-2',
         variant='outlined',
     )
-    async def delete(self, action_data: ActionData):
+    async def delete(self, *args, action_data: ActionData, **kwargs):
         if not self.has_delete:
             raise AdminAPIException(APIError(message=_('errors.method_not_allowed')), status_code=500)
         return ActionResult(message=ActionMessage(_('deleted_successfully')))

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/integrations/sqlalchemy/table/list.py

@@ -1,6 +1,7 @@
 from brilliance_admin import auth, schema
 from brilliance_admin.exceptions import AdminAPIException, APIError, FieldError
 from brilliance_admin.integrations.sqlalchemy.fields_schema import SQLAlchemyFieldsSchema
+from brilliance_admin.schema.admin_schema import AdminSchema
 from brilliance_admin.translations import LanguageContext
 from brilliance_admin.translations import TranslateText as _
 from brilliance_admin.utils import get_logger
@@ -88,6 +89,7 @@ class SQLAlchemyAdminListMixin:
         list_data: schema.ListData,
         user: auth.UserABC,
         language_context: LanguageContext,
+        admin_schema: AdminSchema,
     ) -> schema.TableListResult:
         # pylint: disable=import-outside-toplevel
         from sqlalchemy import exc, func, select
@@ -120,7 +122,10 @@ class SQLAlchemyAdminListMixin:
                     'list_data': list_data,
                 }
             )
-            raise AdminAPIException(APIError(message=_('errors.filters_exception'), code='filters_exception'), status_code=500) from e
+            msg = _('errors.filters_exception') % {
+                'error': str(e) if admin_schema.debug else type(e).__name__,
+            }
+            raise AdminAPIException(APIError(message=msg, code='filters_exception'), status_code=500) from e
 
         try:
             async with self.db_async_session() as session:
@@ -163,7 +168,9 @@ class SQLAlchemyAdminListMixin:
                     'list_data': list_data,
                 }
             )
-            msg = _('errors.db_error_list') % {'error_type': type(e).__name__}
+            msg = _('errors.db_error_list') % {
+                'error_type': str(e) if admin_schema.debug else type(e).__name__,
+            }
             raise AdminAPIException(
                 APIError(message=msg, code='db_error_list'), status_code=500,
             ) from e
@@ -182,15 +189,20 @@ class SQLAlchemyAdminListMixin:
                 'SQLAlchemy %s list %s serialize field error: %s',
                 type(self).__name__, self.model.__name__, e,
             )
-            msg = _('serialize_error.field_error') % {'error': e.message, 'field_slug': e.field_slug}
-            raise AdminAPIException(APIError(message=msg, code='filters_exception'), status_code=500) from e
+            msg = _('serialize_error.field_error') % {
+                'error': e.message,
+                'field_slug': e.field_slug,
+            }
+            raise AdminAPIException(APIError(message=msg, code='field_error'), status_code=500) from e
 
         except Exception as e:
             logger.exception(
                 'SQLAlchemy %s list %s serialize error: %s',
                 type(self).__name__, self.model.__name__, e,
             )
-            msg = _('serialize_error.unexpected_error') % {'error': str(e)}
-            raise AdminAPIException(APIError(message=msg, code='filters_exception'), status_code=500) from e
+            msg = _('serialize_error.unexpected_error') % {
+                'error': str(e) if admin_schema.debug else type(e).__name__,
+            }
+            raise AdminAPIException(APIError(message=msg, code='unexpected_error'), status_code=500) from e
 
         return schema.TableListResult(data=data, total_count=int(total_count or 0))

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/integrations/sqlalchemy/table/retrieve.py

@@ -3,6 +3,7 @@ from typing import Any
 from brilliance_admin import auth, schema
 from brilliance_admin.exceptions import AdminAPIException, APIError, FieldError
 from brilliance_admin.integrations.sqlalchemy.fields_schema import SQLAlchemyFieldsSchema
+from brilliance_admin.schema.admin_schema import AdminSchema
 from brilliance_admin.translations import LanguageContext
 from brilliance_admin.translations import TranslateText as _
 from brilliance_admin.utils import get_logger
@@ -20,8 +21,9 @@ class SQLAlchemyAdminRetrieveMixin:
             pk: Any,
             user: auth.UserABC,
             language_context: LanguageContext,
+            admin_schema: AdminSchema,
     ) -> schema.RetrieveResult:
-        if not self.has_delete:
+        if not self.has_retrieve:
             raise AdminAPIException(APIError(message=_('errors.method_not_allowed')), status_code=500)
 
         # pylint: disable=import-outside-toplevel
@@ -42,7 +44,9 @@ class SQLAlchemyAdminRetrieveMixin:
                 'SQLAlchemy %s retrieve %s #%s db error: %s',
                 type(self).__name__, self.model.__name__, pk, e,
             )
-            msg = _('errors.db_error_retrieve') % {'error_type': type(e).__name__}
+            msg = _('errors.db_error_retrieve') % {
+                'error_type': str(e) if admin_schema.debug else type(e).__name__,
+            }
             raise AdminAPIException(
                 APIError(message=msg, code='db_error_retrieve'), status_code=500,
             ) from e
@@ -64,16 +68,21 @@ class SQLAlchemyAdminRetrieveMixin:
                 'SQLAlchemy %s retrieve %s #%s serialize field error: %s',
                 type(self).__name__, self.model.__name__, pk, e,
             )
-            msg = _('serialize_error.field_error') % {'error': e.message, 'field_slug': e.field_slug}
-            raise AdminAPIException(APIError(message=msg, code='filters_exception'), status_code=500) from e
+            msg = _('serialize_error.field_error') % {
+                'error': e.message,
+                'field_slug': e.field_slug,
+            }
+            raise AdminAPIException(APIError(message=msg, code='field_error'), status_code=500) from e
 
         except Exception as e:
             logger.exception(
                 'SQLAlchemy %s list %s #%s serialize error: %s',
                 type(self).__name__, self.model.__name__, pk, e,
             )
-            msg = _('serialize_error.unexpected_error') % {'error': str(e)}
-            raise AdminAPIException(APIError(message=msg, code='filters_exception'), status_code=500) from e
+            msg = _('serialize_error.unexpected_error') % {
+                'error': str(e) if admin_schema.debug else type(e).__name__,
+            }
+            raise AdminAPIException(APIError(message=msg, code='unexpected_error'), status_code=500) from e
 
         logger.debug(
             '%s model %s #%s retrieved by %s',

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/integrations/sqlalchemy/table/update.py

@@ -2,6 +2,7 @@ from typing import Any
 
 from brilliance_admin import auth, schema
 from brilliance_admin.exceptions import AdminAPIException, APIError
+from brilliance_admin.schema.admin_schema import AdminSchema
 from brilliance_admin.translations import LanguageContext
 from brilliance_admin.translations import TranslateText as _
 from brilliance_admin.utils import get_logger
@@ -19,6 +20,7 @@ class SQLAlchemyAdminUpdate:
             data: dict,
             user: auth.UserABC,
             language_context: LanguageContext,
+            admin_schema: AdminSchema,
     ) -> schema.UpdateResult:
         if not self.has_update:
             raise AdminAPIException(APIError(message=_('errors.method_not_allowed')), status_code=500)
@@ -83,7 +85,9 @@ class SQLAlchemyAdminUpdate:
                 type(self).__name__, self.table_schema.model.__name__, pk, e,
                 extra={'data': data}
             )
-            msg = _('errors.db_error_update') % {'error_type': type(e).__name__}
+            msg = _('errors.db_error_update') % {
+                'error_type': str(e) if admin_schema.debug else type(e).__name__,
+            }
             raise AdminAPIException(
                 APIError(message=msg, code='db_error_update'), status_code=500,
             ) from e

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/locales/en.yml

@@ -12,7 +12,7 @@ errors:
   db_error_list: 'Failed to retrieve table data from the database: %(error_type)s'
 
   connection_refused_error: 'Database connection error: %(error)s'
-  filters_exception: 'An unknown technical error occurred while filtering data.'
+  filters_exception: 'An unknown technical error occurred while filtering data: %(error_type)s'
   method_not_allowed: 'Error, method not allowed. This action is not permitted.'
   filter_error: 'An error occurred during filtering: {error}'
   bad_type_error: 'Invalid data type: %(type)s but %(expected)s expected'

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/locales/ru.yml

@@ -12,7 +12,7 @@ errors:
   db_error_list: 'Ошибка получения данных таблицы из базы данных: %(error_type)s'
 
   connection_refused_error: 'Ошибка подключения к базе данных: %(error)s'
-  filters_exception: 'Произошла неизвестная техническая ошибка при фильтрации данных.'
+  filters_exception: 'Произошла неизвестная техническая ошибка при фильтрации данных: %(error_type)s'
   method_not_allowed: 'Ошибка, данный метод недоступен.'
   filter_error: 'Проишла ошибка при фильтрации: %(error)s'
   bad_type_error: 'Некорректный тип данных: %(type)s; ожидается %(expected)s'

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/schema/admin_schema.py

@@ -68,6 +68,8 @@ class AdminSchema:
 
     language_manager: LanguageManager | None = None
 
+    debug: bool = False
+
     def __post_init__(self):
         for category in self.categories:
             if not issubclass(category.__class__, BaseCategory):
@@ -122,8 +124,6 @@ class AdminSchema:
             languages=languages,
         )
 
-    # pylint: disable=too-many-arguments
-    # pylint: disable=too-many-positional-arguments
     def generate_app(
             self,
             debug=False,
@@ -133,6 +133,8 @@ class AdminSchema:
             include_docs=False,
             include_redoc=False,
     ) -> FastAPI:
+        self.debug = debug
+
         # pylint: disable=unused-variable
         language_context = self.get_language_context(language_slug=None)
 

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/schema/table/category_table.py

@@ -8,8 +8,8 @@ from pydantic import Field
 
 from brilliance_admin.auth import UserABC
 from brilliance_admin.exceptions import AdminAPIException, APIError
-from brilliance_admin.schema.category import BaseCategory
-from brilliance_admin.schema.category import TableInfoSchemaData
+from brilliance_admin.schema.admin_schema import AdminSchema
+from brilliance_admin.schema.category import BaseCategory, TableInfoSchemaData
 from brilliance_admin.schema.table.admin_action import ActionData, ActionResult
 from brilliance_admin.schema.table.fields_schema import FieldsSchema
 from brilliance_admin.schema.table.table_models import AutocompleteData, AutocompleteResult, ListData, TableListResult
@@ -130,6 +130,7 @@ class CategoryTable(BaseCategory):
             action_data: ActionData,
             language_context: LanguageContext,
             user: UserABC,
+            admin_schema: AdminSchema,
     ) -> ActionResult:
         action_fn = self._get_action_fn(action)
         if action_fn is None:
@@ -156,7 +157,7 @@ class CategoryTable(BaseCategory):
 
         return result
 
-    async def autocomplete(self, data: AutocompleteData, user: UserABC) -> AutocompleteResult:
+    async def autocomplete(self, data: AutocompleteData, user: UserABC, schema: AdminSchema) -> AutocompleteResult:
         """
         Retrieves list of found options to select.
         """
@@ -164,14 +165,16 @@ class CategoryTable(BaseCategory):
 
     # pylint: disable=too-many-arguments
     @abc.abstractmethod
-    async def get_list(self, list_data: ListData, user: UserABC, language_context: LanguageContext) -> TableListResult:
+    async def get_list(
+            self, list_data: ListData, user: UserABC, language_context: LanguageContext, admin_schema: AdminSchema
+    ) -> TableListResult:
         raise NotImplementedError()
 
-#     async def retrieve(self, pk: Any, user: UserABC) -> RetrieveResult:
+#     async def retrieve(self, pk: Any, user: UserABC, language_context: LanguageContext, admin_schema: AdminSchema) -> RetrieveResult:
 #        raise NotImplementedError()
 
-#    async def create(self, data: dict, user: UserABC) -> CreateResult:
+#    async def create(self, data: dict, user: UserABC, language_context: LanguageContext, admin_schema: AdminSchema) -> CreateResult:
 #        raise NotImplementedError()
 
-#    async def update(self, pk: Any, data: dict, user: UserABC) -> UpdateResult:
+#    async def update(self, pk: Any, data: dict, user: UserABC, language_context: LanguageContext, admin_schema: AdminSchema) -> UpdateResult:
 #        raise NotImplementedError()

{brilliance_admin-0.44.6 → brilliance_admin-0.44.8}/brilliance_admin/schema/table/fields/base.py

@@ -127,6 +127,18 @@ class BooleanField(TableField):
     _type = 'boolean'
 
 
+def _parse_iso(value: str) -> datetime.datetime:
+    if value.endswith('Z'):
+        value = value.replace('Z', '+00:00')
+
+    dt = datetime.datetime.fromisoformat(value)
+
+    if dt.tzinfo is None:
+        dt = dt.replace(tzinfo=datetime.timezone.utc)
+
+    return dt
+
+
 @dataclass
 class DateTimeField(TableField):
     _type = 'datetime'
@@ -155,16 +167,17 @@ class DateTimeField(TableField):
             raise FieldError(_('errors.bad_type_error') % {'type': type(value), 'expected': 'datetime'})
 
         if isinstance(value, str):
-            return datetime.datetime.strptime(value, self.format)
+            return _parse_iso(value)
 
         if isinstance(value, dict):
             if not value.get('from') or not value.get('to'):
-                msg = f'{type(self).__name__} value must be dict with from,to values: {value}'
-                raise FieldError(msg)
+                raise FieldError(
+                    f'{type(self).__name__} value must be dict with from,to values: {value}'
+                )
 
             return {
-                'from': datetime.datetime.strptime(value.get('from'), self.format),
-                'to': datetime.datetime.strptime(value.get('to'), self.format),
+                'from': _parse_iso(value['from']),
+                'to': _parse_iso(value['to']),
             }
 
         raise FieldError(_('errors.bad_type_error') % {'type': type(value), 'expected': 'datetime'})
@@ -291,3 +304,29 @@ class ChoiceField(TableField):
             'value': value,
             'title': choice.get('title') or value if choice else value.capitalize(),
         }
+
+    async def deserialize(self, value, action: DeserializeAction, extra: dict, *args, **kwargs) -> Any:
+        value = await super().deserialize(value, action, extra, *args, **kwargs)
+
+        if value is None:
+            return
+
+        if isinstance(value, dict):
+            if 'value' not in value:
+                raise FieldError(
+                    f'{type(self).__name__} dict value must contain "value": {value}'
+                )
+            value = value['value']
+
+        if not isinstance(value, str):
+            raise FieldError(
+                f'{type(self).__name__} value must be str, got {type(value)}'
+            )
+
+        choice = self.find_choice(value)
+        if not choice:
+            raise FieldError(
+                f'Invalid choice value "{value}", allowed: {[c["value"] for c in self.choices or []]}'
+            )
+
+        return value