sqladmin 0.18.0__tar.gz → 0.20.0__tar.gz

{sqladmin-0.18.0 → sqladmin-0.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sqladmin
-Version: 0.18.0
+Version: 0.20.0
 Summary: SQLAlchemy admin for FastAPI and Starlette
 Project-URL: Documentation, https://aminalaee.dev/sqladmin
 Project-URL: Issues, https://github.com/aminalaee/sqladmin/issues

{sqladmin-0.18.0 → sqladmin-0.20.0}/pyproject.toml

@@ -95,7 +95,7 @@ dependencies = [
 dependencies = [
   "mkdocs-material==9.1.3",
   "mkdocs==1.4.2",
-  "mkdocstrings[python]==0.20.0",
+  "mkdocstrings[python]==0.25.0",
 ]
 
 [tool.hatch.envs.test.scripts]

{sqladmin-0.18.0 → sqladmin-0.20.0}/sqladmin/__init__.py

@@ -1,7 +1,7 @@
 from sqladmin.application import Admin, action, expose
 from sqladmin.models import BaseView, ModelView
 
-__version__ = "0.18.0"
+__version__ = "0.20.0"
 
 __all__ = [
     "Admin",

{sqladmin-0.18.0 → sqladmin-0.20.0}/sqladmin/ajax.py

@@ -26,6 +26,7 @@ class QueryAjaxModelLoader:
         self.model_admin = model_admin
         self.fields = options.get("fields", {})
         self.order_by = options.get("order_by")
+        self.limit = options.get("limit", DEFAULT_PAGE_SIZE)
 
         pks = get_primary_keys(self.model)
         self.pk = pks[0] if len(pks) == 1 else None
@@ -60,7 +61,7 @@ class QueryAjaxModelLoader:
 
         return {"id": str(get_object_identifier(model)), "text": str(model)}
 
-    async def get_list(self, term: str, limit: int = DEFAULT_PAGE_SIZE) -> list[Any]:
+    async def get_list(self, term: str) -> list[Any]:
         stmt = select(self.model)
 
         # no type casting to string if a ColumnAssociationProxyInstance is given
@@ -71,9 +72,13 @@ class QueryAjaxModelLoader:
         stmt = stmt.filter(or_(*filters))
 
         if self.order_by:
-            stmt = stmt.order_by(self.order_by)
+            if isinstance(self.order_by, list):
+                for o in self.order_by:
+                    stmt = stmt.order_by(o)
+            else:
+                stmt = stmt.order_by(self.order_by)
 
-        stmt = stmt.limit(limit)
+        stmt = stmt.limit(self.limit)
         result = await self.model_admin._run_query(stmt)
         return result
 

{sqladmin-0.18.0 → sqladmin-0.20.0}/sqladmin/application.py

@@ -68,6 +68,7 @@ class BaseAdmin:
         base_url: str = "/admin",
         title: str = "Admin",
         logo_url: str | None = None,
+        favicon_url: str | None = None,
         templates_dir: str = "templates",
         middlewares: Sequence[Middleware] | None = None,
         authentication_backend: AuthenticationBackend | None = None,
@@ -78,6 +79,7 @@ class BaseAdmin:
         self.templates_dir = templates_dir
         self.title = title
         self.logo_url = logo_url
+        self.favicon_url = favicon_url
 
         if session_maker:
             self.session_maker = session_maker
@@ -340,6 +342,7 @@ class Admin(BaseAdminView):
         base_url: str = "/admin",
         title: str = "Admin",
         logo_url: str | None = None,
+        favicon_url: str | None = None,
         middlewares: Sequence[Middleware] | None = None,
         debug: bool = False,
         templates_dir: str = "templates",
@@ -353,6 +356,7 @@ class Admin(BaseAdminView):
             base_url: Base URL for Admin interface.
             title: Admin title.
             logo_url: URL of logo to be displayed instead of title.
+            favicon_url: URL of favicon to be displayed.
         """
 
         super().__init__(
@@ -362,6 +366,7 @@ class Admin(BaseAdminView):
             base_url=base_url,
             title=title,
             logo_url=logo_url,
+            favicon_url=favicon_url,
             templates_dir=templates_dir,
             middlewares=middlewares,
             authentication_backend=authentication_backend,
@@ -437,12 +442,13 @@ class Admin(BaseAdminView):
         pagination = await model_view.list(request)
         pagination.add_pagination_urls(request.url)
 
-        if (
-            pagination.page * pagination.page_size
-            > pagination.count + pagination.page_size
-        ):
-            raise HTTPException(
-                status_code=400, detail="Invalid page or pageSize parameter"
+        request_page = model_view.validate_page_number(
+            request.query_params.get("page"), 1
+        )
+
+        if request_page > pagination.page:
+            return RedirectResponse(
+                request.url.include_query_params(page=pagination.page), status_code=302
             )
 
         context = {"model_view": model_view, "pagination": pagination}
@@ -505,8 +511,7 @@ class Admin(BaseAdminView):
         identity = request.path_params["identity"]
         model_view = self._find_model_view(identity)
 
-        Form = await model_view.scaffold_form()
-        model_view._validate_form_class(model_view._form_create_rules, Form)
+        Form = await model_view.scaffold_form(model_view._form_create_rules)
         form_data = await self._handle_form_data(request)
         form = Form(form_data)
 
@@ -556,8 +561,7 @@ class Admin(BaseAdminView):
         if not model:
             raise HTTPException(status_code=404)
 
-        Form = await model_view.scaffold_form()
-        model_view._validate_form_class(model_view._form_edit_rules, Form)
+        Form = await model_view.scaffold_form(model_view._form_edit_rules)
         context = {
             "obj": model,
             "model_view": model_view,

{sqladmin-0.18.0 → sqladmin-0.20.0}/sqladmin/forms.py

@@ -18,7 +18,12 @@ from typing import (
 import anyio
 from sqlalchemy import Boolean, select
 from sqlalchemy import inspect as sqlalchemy_inspect
-from sqlalchemy.orm import ColumnProperty, RelationshipProperty, sessionmaker
+from sqlalchemy.orm import (
+    ColumnProperty,
+    RelationshipProperty,
+    sessionmaker,
+)
+from sqlalchemy.sql.elements import Label
 from sqlalchemy.sql.schema import Column
 from wtforms import (
     BooleanField,
@@ -612,9 +617,12 @@ async def get_model_form(
     attributes = []
     names = only or mapper.attrs.keys()
     for name in names:
-        if exclude and name in exclude:
+        attr = mapper.attrs[name]
+        if (exclude and name in exclude) or (
+            isinstance(attr, ColumnProperty) and isinstance(attr.expression, Label)
+        ):
             continue
-        attributes.append((name, mapper.attrs[name]))
+        attributes.append((name, attr))
 
     field_dict = {}
     for name, attr in attributes:

{sqladmin-0.18.0 → sqladmin-0.20.0}/sqladmin/models.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 import time
 import warnings
 from enum import Enum
@@ -176,7 +177,7 @@ class BaseView(BaseModelView):
 
     icon: ClassVar[str] = ""
     """Display icon for ModelAdmin in the sidebar.
-    Currently only supports FontAwesome icons.
+    Currently only supports FontAwesome and Tabler icons.
     """
 
     category: ClassVar[str] = ""
@@ -454,7 +455,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         ```
     """
 
-    export_types: ClassVar[List[str]] = ["csv"]
+    export_types: ClassVar[List[str]] = ["csv", "json"]
     """A list of available export filetypes.
     Currently only `csv` is supported.
     """
@@ -1015,10 +1016,11 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         By default do nothing.
         """
 
-    async def scaffold_form(self) -> Type[Form]:
+    async def scaffold_form(self, rules: List[str] | None = None) -> Type[Form]:
         if self.form is not None:
             return self.form
-        return await get_model_form(
+
+        form = await get_model_form(
             model=self.model,
             session_maker=self.session_maker,
             only=self._form_prop_names,
@@ -1032,6 +1034,11 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
             form_converter=self.form_converter,
         )
 
+        if rules:
+            self._validate_form_class(rules, form)
+
+        return form
+
     def search_placeholder(self) -> str:
         """Return search placeholder text.
 
@@ -1152,7 +1159,9 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
     ) -> StreamingResponse:
         if export_type == "csv":
             return await self._export_csv(data)
-        raise NotImplementedError("Only export_type='csv' is implemented.")
+        elif export_type == "json":
+            return await self._export_json(data)
+        raise NotImplementedError("Only export_type='csv' or 'json' is implemented.")
 
     async def _export_csv(
         self,
@@ -1179,6 +1188,30 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
             headers={"Content-Disposition": f"attachment;filename={filename}"},
         )
 
+    async def _export_json(
+        self,
+        data: List[Any],
+    ) -> StreamingResponse:
+        async def generate() -> AsyncGenerator[str, None]:
+            yield "["
+            separator = "," if len(data) > 1 else ""
+
+            for row in data:
+                row_dict = {
+                    name: await self.get_prop_value(row, name)
+                    for name in self._export_prop_names
+                }
+                yield json.dumps(row_dict) + separator
+
+            yield "]"
+
+        filename = secure_filename(self.get_export_name(export_type="json"))
+        return StreamingResponse(
+            content=generate(),
+            media_type="application/json",
+            headers={"Content-Disposition": f"attachment;filename={filename}"},
+        )
+
     def _refresh_form_rules_cache(self) -> None:
         if self.form_rules:
             self._form_create_rules = self.form_rules

{sqladmin-0.18.0 → sqladmin-0.20.0}/sqladmin/pagination.py

@@ -46,6 +46,15 @@ class Pagination:
 
         raise RuntimeError("Next page not found.")
 
+    def __post_init__(self) -> None:
+        # Clamp page
+        self.page = min(self.page, max(1, self.count // self.page_size + 1))
+
+    def resize(self, page_size: int) -> Pagination:
+        self.page = (self.page - 1) * self.page_size // page_size + 1
+        self.page_size = page_size
+        return self
+
     def add_pagination_urls(self, base_url: URL) -> None:
         # Previous pages
         for p in range(self.page - min(self.max_page_controls, 3), self.page):