sqladmin 0.17.0__tar.gz → 0.19.0__tar.gz

{sqladmin-0.17.0 → sqladmin-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sqladmin
-Version: 0.17.0
+Version: 0.19.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.17.0 → sqladmin-0.19.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.17.0 → sqladmin-0.19.0}/sqladmin/__init__.py

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

{sqladmin-0.17.0 → sqladmin-0.19.0}/sqladmin/_menu.py

@@ -1,4 +1,6 @@
-from typing import TYPE_CHECKING, List, Optional, Union
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from starlette.datastructures import URL
 from starlette.requests import Request
@@ -8,11 +10,11 @@ if TYPE_CHECKING:
 
 
 class ItemMenu:
-    def __init__(self, name: str, icon: Optional[str] = None) -> None:
+    def __init__(self, name: str, icon: str | None = None) -> None:
         self.name = name
         self.icon = icon
-        self.parent: Optional["ItemMenu"] = None
-        self.children: List["ItemMenu"] = []
+        self.parent: "ItemMenu" | None = None
+        self.children: list["ItemMenu"] = []
 
     def add_child(self, item: "ItemMenu") -> None:
         item.parent = self
@@ -27,7 +29,7 @@ class ItemMenu:
     def is_active(self, request: Request) -> bool:
         return False
 
-    def url(self, request: Request) -> Union[str, URL]:
+    def url(self, request: Request) -> str | URL:
         return "#"
 
     @property
@@ -53,9 +55,9 @@ class CategoryMenu(ItemMenu):
 class ViewMenu(ItemMenu):
     def __init__(
         self,
-        view: Union["BaseView", "ModelView"],
+        view: "BaseView" | "ModelView",
         name: str,
-        icon: Optional[str] = None,
+        icon: str | None = None,
     ) -> None:
         super().__init__(name=name, icon=icon)
         self.view = view
@@ -69,7 +71,7 @@ class ViewMenu(ItemMenu):
     def is_active(self, request: Request) -> bool:
         return self.view.identity == request.path_params.get("identity")
 
-    def url(self, request: Request) -> Union[str, URL]:
+    def url(self, request: Request) -> str | URL:
         if self.view.is_model:
             return request.url_for("admin:list", identity=self.view.identity)
         return request.url_for(f"admin:{self.view.identity}")
@@ -85,7 +87,7 @@ class ViewMenu(ItemMenu):
 
 class Menu:
     def __init__(self) -> None:
-        self.items: List[ItemMenu] = []
+        self.items: list[ItemMenu] = []
 
     def add(self, item: ItemMenu) -> None:
         # Only works for one-level menu

{sqladmin-0.17.0 → sqladmin-0.19.0}/sqladmin/_queries.py

@@ -1,4 +1,6 @@
-from typing import TYPE_CHECKING, Any, Dict, List
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
 
 import anyio
 from sqlalchemy import select
@@ -24,7 +26,7 @@ class Query:
     def __init__(self, model_view: "ModelView") -> None:
         self.model_view = model_view
 
-    def _get_to_many_stmt(self, relation: MODEL_PROPERTY, values: List[Any]) -> Select:
+    def _get_to_many_stmt(self, relation: MODEL_PROPERTY, values: list[Any]) -> Select:
         target = relation.mapper.class_
 
         target_pks = get_primary_keys(target)
@@ -131,7 +133,7 @@ class Query:
                 setattr(obj, key, value)
         return obj
 
-    def _update_sync(self, pk: Any, data: Dict[str, Any], request: Request) -> Any:
+    def _update_sync(self, pk: Any, data: dict[str, Any], request: Request) -> Any:
         stmt = self.model_view._stmt_by_identifier(pk)
 
         with self.model_view.session_maker(expire_on_commit=False) as session:
@@ -147,7 +149,7 @@ class Query:
             return obj
 
     async def _update_async(
-        self, pk: Any, data: Dict[str, Any], request: Request
+        self, pk: Any, data: dict[str, Any], request: Request
     ) -> Any:
         stmt = self.model_view._stmt_by_identifier(pk)
 
@@ -187,7 +189,7 @@ class Query:
             await session.commit()
             await self.model_view.after_model_delete(obj, request)
 
-    def _insert_sync(self, data: Dict[str, Any], request: Request) -> Any:
+    def _insert_sync(self, data: dict[str, Any], request: Request) -> Any:
         obj = self.model_view.model()
 
         with self.model_view.session_maker(expire_on_commit=False) as session:
@@ -202,7 +204,7 @@ class Query:
             )
             return obj
 
-    async def _insert_async(self, data: Dict[str, Any], request: Request) -> Any:
+    async def _insert_async(self, data: dict[str, Any], request: Request) -> Any:
         obj = self.model_view.model()
 
         async with self.model_view.session_maker(expire_on_commit=False) as session:

{sqladmin-0.17.0 → sqladmin-0.19.0}/sqladmin/ajax.py

@@ -1,4 +1,6 @@
-from typing import TYPE_CHECKING, Any, Dict, List
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
 
 from sqlalchemy import String, cast, inspect, or_, select
 
@@ -24,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
@@ -52,13 +55,13 @@ class QueryAjaxModelLoader:
 
         return remote_fields
 
-    def format(self, model: type) -> Dict[str, Any]:
+    def format(self, model: type) -> dict[str, Any]:
         if not model:
             return {}
 
         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
@@ -69,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.17.0 → sqladmin-0.19.0}/sqladmin/application.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import inspect
 import io
 import logging
@@ -7,12 +9,7 @@ from typing import (
     Any,
     Awaitable,
     Callable,
-    List,
-    Optional,
     Sequence,
-    Tuple,
-    Type,
-    Union,
     cast,
     no_type_check,
 )
@@ -66,14 +63,15 @@ class BaseAdmin:
     def __init__(
         self,
         app: Starlette,
-        engine: Optional[ENGINE_TYPE] = None,
-        session_maker: Optional[sessionmaker] = None,
+        engine: ENGINE_TYPE | None = None,
+        session_maker: sessionmaker | None = None,
         base_url: str = "/admin",
         title: str = "Admin",
-        logo_url: Optional[str] = None,
+        logo_url: str | None = None,
+        favicon_url: str | None = None,
         templates_dir: str = "templates",
-        middlewares: Optional[Sequence[Middleware]] = None,
-        authentication_backend: Optional[AuthenticationBackend] = None,
+        middlewares: Sequence[Middleware] | None = None,
+        authentication_backend: AuthenticationBackend | None = None,
     ) -> None:
         self.app = app
         self.engine = engine
@@ -81,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
@@ -100,7 +99,7 @@ class BaseAdmin:
 
         self.admin = Starlette(middleware=middlewares)
         self.templates = self.init_templating_engine()
-        self._views: List[Union[BaseView, ModelView]] = []
+        self._views: list[BaseView | ModelView] = []
         self._menu = Menu()
 
     def init_templating_engine(self) -> Jinja2Templates:
@@ -120,7 +119,7 @@ class BaseAdmin:
         return templates
 
     @property
-    def views(self) -> List[Union[BaseView, ModelView]]:
+    def views(self) -> list[BaseView | ModelView]:
         """Get list of ModelView and BaseView instances lazily.
 
         Returns:
@@ -136,7 +135,7 @@ class BaseAdmin:
 
         raise HTTPException(status_code=404)
 
-    def add_view(self, view: Union[Type[ModelView], Type[BaseView]]) -> None:
+    def add_view(self, view: type[ModelView] | type[BaseView]) -> None:
         """Add ModelView or BaseView classes to Admin.
         This is a shortcut that will handle both `add_model_view` and `add_base_view`.
         """
@@ -149,10 +148,10 @@ class BaseAdmin:
 
     def _find_decorated_funcs(
         self,
-        view: Type[Union[BaseView, ModelView]],
-        view_instance: Union[BaseView, ModelView],
+        view: type[BaseView | ModelView],
+        view_instance: BaseView | ModelView,
         handle_fn: Callable[
-            [MethodType, Type[Union[BaseView, ModelView]], Union[BaseView, ModelView]],
+            [MethodType, type[BaseView | ModelView], BaseView | ModelView],
             None,
         ],
     ) -> None:
@@ -164,8 +163,8 @@ class BaseAdmin:
     def _handle_action_decorated_func(
         self,
         func: MethodType,
-        view: Type[Union[BaseView, ModelView]],
-        view_instance: Union[BaseView, ModelView],
+        view: type[BaseView | ModelView],
+        view_instance: BaseView | ModelView,
     ) -> None:
         if hasattr(func, "_action"):
             view_instance = cast(ModelView, view_instance)
@@ -194,8 +193,8 @@ class BaseAdmin:
     def _handle_expose_decorated_func(
         self,
         func: MethodType,
-        view: Type[Union[BaseView, ModelView]],
-        view_instance: Union[BaseView, ModelView],
+        view: type[BaseView | ModelView],
+        view_instance: BaseView | ModelView,
     ) -> None:
         if hasattr(func, "_exposed"):
             self.admin.add_route(
@@ -208,7 +207,7 @@ class BaseAdmin:
 
             view.identity = getattr(func, "_identity")
 
-    def add_model_view(self, view: Type[ModelView]) -> None:
+    def add_model_view(self, view: type[ModelView]) -> None:
         """Add ModelView to the Admin.
 
         ???+ usage
@@ -237,7 +236,7 @@ class BaseAdmin:
         self._views.append(view_instance)
         self._build_menu(view_instance)
 
-    def add_base_view(self, view: Type[BaseView]) -> None:
+    def add_base_view(self, view: type[BaseView]) -> None:
         """Add BaseView to the Admin.
 
         ???+ usage
@@ -265,7 +264,7 @@ class BaseAdmin:
         self._views.append(view_instance)
         self._build_menu(view_instance)
 
-    def _build_menu(self, view: Union[ModelView, BaseView]) -> None:
+    def _build_menu(self, view: ModelView | BaseView) -> None:
         if view.category:
             menu = CategoryMenu(name=view.category)
             menu.add_child(ViewMenu(view=view, name=view.name, icon=view.icon))
@@ -338,15 +337,16 @@ class Admin(BaseAdminView):
     def __init__(
         self,
         app: Starlette,
-        engine: Optional[ENGINE_TYPE] = None,
-        session_maker: Optional[Union[sessionmaker, "async_sessionmaker"]] = None,
+        engine: ENGINE_TYPE | None = None,
+        session_maker: sessionmaker | "async_sessionmaker" | None = None,
         base_url: str = "/admin",
         title: str = "Admin",
-        logo_url: Optional[str] = None,
-        middlewares: Optional[Sequence[Middleware]] = None,
+        logo_url: str | None = None,
+        favicon_url: str | None = None,
+        middlewares: Sequence[Middleware] | None = None,
         debug: bool = False,
         templates_dir: str = "templates",
-        authentication_backend: Optional[AuthenticationBackend] = None,
+        authentication_backend: AuthenticationBackend | None = None,
     ) -> None:
         """
         Args:
@@ -356,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__(
@@ -365,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,
@@ -374,7 +376,7 @@ class Admin(BaseAdminView):
 
         async def http_exception(
             request: Request, exc: Exception
-        ) -> Union[Response, Awaitable[Response]]:
+        ) -> Response | Awaitable[Response]:
             assert isinstance(exc, HTTPException)
             context = {
                 "status_code": exc.status_code,
@@ -509,6 +511,7 @@ class Admin(BaseAdminView):
         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_data = await self._handle_form_data(request)
         form = Form(form_data)
 
@@ -559,6 +562,7 @@ class Admin(BaseAdminView):
             raise HTTPException(status_code=404)
 
         Form = await model_view.scaffold_form()
+        model_view._validate_form_class(model_view._form_edit_rules, Form)
         context = {
             "obj": model,
             "model_view": model_view,
@@ -660,7 +664,7 @@ class Admin(BaseAdminView):
 
     def get_save_redirect_url(
         self, request: Request, form: FormData, model_view: ModelView, obj: Any
-    ) -> Union[str, URL]:
+    ) -> str | URL:
         """
         Get the redirect URL after a save action
         which is triggered from create/edit page.
@@ -685,7 +689,7 @@ class Admin(BaseAdminView):
         """
 
         form = await request.form()
-        form_data: List[Tuple[str, Union[str, UploadFile]]] = []
+        form_data: list[tuple[str, str | UploadFile]] = []
         for key, value in form.multi_items():
             if not isinstance(value, UploadFile):
                 form_data.append((key, value))
@@ -726,8 +730,8 @@ class Admin(BaseAdminView):
 def expose(
     path: str,
     *,
-    methods: List[str] = ["GET"],
-    identity: Optional[str] = None,
+    methods: list[str] = ["GET"],
+    identity: str | None = None,
     include_in_schema: bool = True,
 ) -> Callable[..., Any]:
     """Expose View with information."""
@@ -746,8 +750,8 @@ def expose(
 
 def action(
     name: str,
-    label: Optional[str] = None,
-    confirmation_message: Optional[str] = None,
+    label: str | None = None,
+    confirmation_message: str | None = None,
     *,
     include_in_schema: bool = True,
     add_in_detail: bool = True,

{sqladmin-0.17.0 → sqladmin-0.19.0}/sqladmin/authentication.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import functools
 import inspect
-from typing import Any, Callable, Union
+from typing import Any, Callable
 
 from starlette.middleware import Middleware
 from starlette.requests import Request
@@ -33,7 +35,7 @@ class AuthenticationBackend:
         """
         raise NotImplementedError()
 
-    async def authenticate(self, request: Request) -> Union[Response, bool]:
+    async def authenticate(self, request: Request) -> Response | bool:
         """Implement authenticate logic here.
         This method will be called for each incoming request
         to validate the authentication.

{sqladmin-0.17.0 → sqladmin-0.19.0}/sqladmin/fields.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import json
 import operator
-from typing import Any, Callable, Dict, Generator, List, Optional, Set, Tuple, Union
+from typing import Any, Callable, Generator
 
 from wtforms import Form, ValidationError, fields, widgets
 
@@ -43,7 +45,7 @@ class IntervalField(fields.StringField):
     A text field which stores a `datetime.timedelta` object.
     """
 
-    def process_formdata(self, valuelist: List[str]) -> None:
+    def process_formdata(self, valuelist: list[str]) -> None:
         if not valuelist:
             return
 
@@ -57,19 +59,19 @@ class IntervalField(fields.StringField):
 class SelectField(fields.SelectField):
     def __init__(
         self,
-        label: Optional[str] = None,
-        validators: Optional[list] = None,
+        label: str | None = None,
+        validators: list | None = None,
         coerce: type = str,
-        choices: Optional[Union[list, Callable]] = None,
+        choices: list | Callable | None = None,
         allow_blank: bool = False,
-        blank_text: Optional[str] = None,
+        blank_text: str | None = None,
         **kwargs: Any,
     ) -> None:
         super().__init__(label, validators, coerce, choices, **kwargs)
         self.allow_blank = allow_blank
         self.blank_text = blank_text or " "
 
-    def iter_choices(self) -> Generator[Tuple[str, str, bool, Dict], None, None]:
+    def iter_choices(self) -> Generator[tuple[str, str, bool, dict], None, None]:
         choices = self.choices or []
 
         if self.allow_blank:
@@ -86,7 +88,7 @@ class SelectField(fields.SelectField):
                     {},
                 )
 
-    def process_formdata(self, valuelist: List[str]) -> None:
+    def process_formdata(self, valuelist: list[str]) -> None:
         if valuelist:
             if valuelist[0] == "__None":
                 self.data = None
@@ -112,7 +114,7 @@ class JSONField(fields.TextAreaField):
         else:
             return "{}"
 
-    def process_formdata(self, valuelist: List[str]) -> None:
+    def process_formdata(self, valuelist: list[str]) -> None:
         if valuelist:
             value = valuelist[0]
 
@@ -132,10 +134,10 @@ class QuerySelectField(fields.SelectFieldBase):
 
     def __init__(
         self,
-        data: Optional[list] = None,
-        label: Optional[str] = None,
-        validators: Optional[list] = None,
-        get_label: Optional[Union[Callable, str]] = None,
+        data: list | None = None,
+        label: str | None = None,
+        validators: list | None = None,
+        get_label: Callable | str | None = None,
         allow_blank: bool = False,
         blank_text: str = "",
         **kwargs: Any,
@@ -153,11 +155,11 @@ class QuerySelectField(fields.SelectFieldBase):
 
         self.allow_blank = allow_blank
         self.blank_text = blank_text
-        self._data: Optional[tuple]
-        self._formdata: Optional[Union[str, List[str]]]
+        self._data: tuple | None
+        self._formdata: str | list[str] | None
 
     @property
-    def data(self) -> Optional[tuple]:
+    def data(self) -> tuple | None:
         if self._formdata is not None:
             for pk, _ in self._select_data:
                 if pk == self._formdata:
@@ -170,7 +172,7 @@ class QuerySelectField(fields.SelectFieldBase):
         self._data = data
         self._formdata = None
 
-    def iter_choices(self) -> Generator[Tuple[str, str, bool, Dict], None, None]:
+    def iter_choices(self) -> Generator[tuple[str, str, bool, dict], None, None]:
         if self.allow_blank:
             yield ("__None", self.blank_text, self.data is None, {})
 
@@ -186,7 +188,7 @@ class QuerySelectField(fields.SelectFieldBase):
         for pk, label in self._select_data:
             yield (pk, self.get_label(label), str(pk) == primary_key, {})
 
-    def process_formdata(self, valuelist: List[str]) -> None:
+    def process_formdata(self, valuelist: list[str]) -> None:
         if valuelist:
             if self.allow_blank and valuelist[0] == "__None":
                 self.data = None
@@ -220,9 +222,9 @@ class QuerySelectMultipleField(QuerySelectField):
 
     def __init__(
         self,
-        data: Optional[list] = None,
-        label: Optional[str] = None,
-        validators: Optional[list] = None,
+        data: list | None = None,
+        label: str | None = None,
+        validators: list | None = None,
         default: Any = None,
         **kwargs: Any,
     ) -> None:
@@ -238,11 +240,11 @@ class QuerySelectMultipleField(QuerySelectField):
                 "allow_blank=True does not do anything for QuerySelectMultipleField."
             )
         self._invalid_formdata = False
-        self._formdata: Optional[List[str]] = None
-        self._data: Optional[tuple] = None
+        self._formdata: list[str] | None = None
+        self._data: tuple | None = None
 
     @property
-    def data(self) -> Optional[tuple]:
+    def data(self) -> tuple | None:
         formdata = self._formdata
         if formdata is not None:
             data = []
@@ -262,7 +264,7 @@ class QuerySelectMultipleField(QuerySelectField):
         self._data = data
         self._formdata = None
 
-    def iter_choices(self) -> Generator[Tuple[str, Any, bool, Dict], None, None]:
+    def iter_choices(self) -> Generator[tuple[str, Any, bool, dict], None, None]:
         if self.data is not None:
             primary_keys = (
                 self.data
@@ -272,7 +274,7 @@ class QuerySelectMultipleField(QuerySelectField):
             for pk, label in self._select_data:
                 yield (pk, self.get_label(label), pk in primary_keys, {})
 
-    def process_formdata(self, valuelist: List[str]) -> None:
+    def process_formdata(self, valuelist: list[str]) -> None:
         self._formdata = list(set(valuelist))
 
     def pre_validate(self, form: Form) -> None:
@@ -292,8 +294,8 @@ class AjaxSelectField(fields.SelectFieldBase):
     def __init__(
         self,
         loader: QueryAjaxModelLoader,
-        label: Optional[str] = None,
-        validators: Optional[list] = None,
+        label: str | None = None,
+        validators: list | None = None,
         allow_blank: bool = False,
         **kwargs: Any,
     ) -> None:
@@ -334,9 +336,9 @@ class AjaxSelectMultipleField(fields.SelectFieldBase):
     def __init__(
         self,
         loader: QueryAjaxModelLoader,
-        label: Optional[str] = None,
-        validators: Optional[list] = None,
-        default: Optional[list] = None,
+        label: str | None = None,
+        validators: list | None = None,
+        default: list | None = None,
         allow_blank: bool = False,
         **kwargs: Any,
     ) -> None:
@@ -344,7 +346,7 @@ class AjaxSelectMultipleField(fields.SelectFieldBase):
         self.loader = loader
         self.allow_blank = allow_blank
         default = default or []
-        self._formdata: Set[Any] = set()
+        self._formdata: set[Any] = set()
 
         super().__init__(label, validators, default=default, **kwargs)
 
@@ -377,7 +379,7 @@ class Select2TagsField(fields.SelectField):
     def process_formdata(self, valuelist: list) -> None:
         self.data = valuelist
 
-    def process_data(self, value: Optional[list]) -> None:
+    def process_data(self, value: list | None) -> None:
         self.data = value or []