sqladmin 0.17.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

sqladmin/forms.py

@@ -1,18 +1,15 @@
 """
 The converters are from Flask-Admin project.
 """
+from __future__ import annotations
+
 import enum
 import inspect
 import sys
 from typing import (
     Any,
     Callable,
-    Dict,
-    List,
-    Optional,
     Sequence,
-    Tuple,
-    Type,
     TypeVar,
     Union,
     no_type_check,
@@ -21,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,
@@ -85,7 +87,7 @@ class ConverterCallable(Protocol):
         self,
         model: type,
         prop: MODEL_PROPERTY,
-        kwargs: Dict[str, Any],
+        kwargs: dict[str, Any],
     ) -> UnboundField:
         ...  # pragma: no cover
 
@@ -107,7 +109,7 @@ def converts(*args: str) -> Callable[[T_CC], T_CC]:
 
 
 class ModelConverterBase:
-    _converters: Dict[str, ConverterCallable] = {}
+    _converters: dict[str, ConverterCallable] = {}
 
     def __init__(self) -> None:
         super().__init__()
@@ -128,12 +130,12 @@ class ModelConverterBase:
         self,
         prop: MODEL_PROPERTY,
         session_maker: sessionmaker,
-        field_args: Dict[str, Any],
-        field_widget_args: Dict[str, Any],
+        field_args: dict[str, Any],
+        field_widget_args: dict[str, Any],
         form_include_pk: bool,
-        label: Optional[str] = None,
-        loader: Optional[QueryAjaxModelLoader] = None,
-    ) -> Optional[Dict[str, Any]]:
+        label: str | None = None,
+        loader: QueryAjaxModelLoader | None = None,
+    ) -> dict[str, Any] | None:
         if not isinstance(prop, (RelationshipProperty, ColumnProperty)):
             return None
 
@@ -205,7 +207,7 @@ class ModelConverterBase:
         prop: RelationshipProperty,
         kwargs: dict,
         session_maker: sessionmaker,
-        loader: Optional[QueryAjaxModelLoader] = None,
+        loader: QueryAjaxModelLoader | None = None,
     ) -> dict:
         nullable = True
         for pair in prop.local_remote_pairs:
@@ -225,7 +227,7 @@ class ModelConverterBase:
         self,
         prop: RelationshipProperty,
         session_maker: sessionmaker,
-    ) -> List[Tuple[str, Any]]:
+    ) -> list[tuple[str, Any]]:
         target_model = prop.mapper.class_
         stmt = select(target_model)
 
@@ -283,13 +285,13 @@ class ModelConverterBase:
         model: type,
         prop: MODEL_PROPERTY,
         session_maker: sessionmaker,
-        field_args: Dict[str, Any],
-        field_widget_args: Dict[str, Any],
+        field_args: dict[str, Any],
+        field_widget_args: dict[str, Any],
         form_include_pk: bool,
-        label: Optional[str] = None,
-        override: Optional[Type[Field]] = None,
-        form_ajax_refs: Dict[str, QueryAjaxModelLoader] = {},
-    ) -> Optional[UnboundField]:
+        label: str | None = None,
+        override: type[Field] | None = None,
+        form_ajax_refs: dict[str, QueryAjaxModelLoader] = {},
+    ) -> UnboundField:
         loader = form_ajax_refs.get(prop.key)
         kwargs = await self._prepare_kwargs(
             prop=prop,
@@ -329,7 +331,7 @@ class ModelConverterBase:
 
 class ModelConverter(ModelConverterBase):
     @staticmethod
-    def _string_common(prop: ColumnProperty) -> List[Validator]:
+    def _string_common(prop: ColumnProperty) -> list[Validator]:
         li = []
         column: Column = prop.columns[0]
         if isinstance(column.type.length, int) and column.type.length:
@@ -338,7 +340,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("String", "CHAR")  # includes Unicode
     def conv_string(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         extra_validators = self._string_common(prop)
         kwargs.setdefault("validators", [])
@@ -347,7 +349,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("Text", "LargeBinary", "Binary")  # includes UnicodeText
     def conv_text(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         extra_validators = self._string_common(prop)
@@ -356,7 +358,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("Boolean", "dialects.mssql.base.BIT")
     def conv_boolean(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         if not prop.columns[0].nullable:
             kwargs.setdefault("render_kw", {})
@@ -370,25 +372,25 @@ class ModelConverter(ModelConverterBase):
 
     @converts("Date")
     def conv_date(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return DateField(**kwargs)
 
     @converts("Time")
     def conv_time(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return TimeField(**kwargs)
 
     @converts("DateTime")
     def conv_datetime(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return DateTimeField(**kwargs)
 
     @converts("Enum")
     def conv_enum(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         available_choices = [(e, e) for e in prop.columns[0].type.enums]
         accepted_values = [choice[0] for choice in available_choices]
@@ -408,13 +410,13 @@ class ModelConverter(ModelConverterBase):
 
     @converts("Integer")  # includes BigInteger and SmallInteger
     def conv_integer(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return IntegerField(**kwargs)
 
     @converts("Numeric")  # includes DECIMAL, Float/FLOAT, REAL, and DOUBLE
     def conv_decimal(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         # override default decimal places limit, use database defaults instead
         kwargs.setdefault("places", None)
@@ -422,13 +424,13 @@ class ModelConverter(ModelConverterBase):
 
     @converts("JSON", "JSONB")
     def conv_json(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return JSONField(**kwargs)
 
     @converts("Interval")
     def conv_interval(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs["render_kw"]["placeholder"] = "Like: 1 day 1:25:33.652"
         return IntervalField(**kwargs)
@@ -439,7 +441,7 @@ class ModelConverter(ModelConverterBase):
         "sqlalchemy_utils.types.ip_address.IPAddressType",
     )
     def conv_ip_address(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(validators.IPAddress(ipv4=True, ipv6=True))
@@ -450,7 +452,7 @@ class ModelConverter(ModelConverterBase):
         "sqlalchemy.dialects.postgresql.types.MACADDR",
     )
     def conv_mac_address(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(validators.MacAddress())
@@ -463,7 +465,7 @@ class ModelConverter(ModelConverterBase):
         "sqlalchemy_utils.types.uuid.UUIDType",
     )
     def conv_uuid(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(validators.UUID())
@@ -473,13 +475,13 @@ class ModelConverter(ModelConverterBase):
         "sqlalchemy.dialects.postgresql.base.ARRAY", "sqlalchemy.sql.sqltypes.ARRAY"
     )
     def conv_ARRAY(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return Select2TagsField(**kwargs)
 
     @converts("sqlalchemy_utils.types.email.EmailType")
     def conv_email(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(validators.Email())
@@ -487,7 +489,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("sqlalchemy_utils.types.url.URLType")
     def conv_url(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(validators.URL())
@@ -495,7 +497,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("sqlalchemy_utils.types.currency.CurrencyType")
     def conv_currency(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(CurrencyValidator())
@@ -503,7 +505,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("sqlalchemy_utils.types.timezone.TimezoneType")
     def conv_timezone(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(
@@ -513,7 +515,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("sqlalchemy_utils.types.phone_number.PhoneNumberType")
     def conv_phone_number(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(PhoneNumberValidator())
@@ -521,7 +523,7 @@ class ModelConverter(ModelConverterBase):
 
     @converts("sqlalchemy_utils.types.color.ColorType")
     def conv_color(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs.setdefault("validators", [])
         kwargs["validators"].append(ColorValidator())
@@ -530,7 +532,7 @@ class ModelConverter(ModelConverterBase):
     @converts("sqlalchemy_utils.types.choice.ChoiceType")
     @no_type_check
     def convert_choice_type(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         available_choices = []
         column = prop.columns[0]
@@ -559,32 +561,32 @@ class ModelConverter(ModelConverterBase):
 
     @converts("fastapi_storages.integrations.sqlalchemy.FileType")
     def conv_file(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return FileField(**kwargs)
 
     @converts("fastapi_storages.integrations.sqlalchemy.ImageType")
     def conv_image(
-        self, model: type, prop: ColumnProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: ColumnProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return FileField(**kwargs)
 
     @converts("ONETOONE")
     def conv_one_to_one(
-        self, model: type, prop: RelationshipProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: RelationshipProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         kwargs["allow_blank"] = True
         return QuerySelectField(**kwargs)
 
     @converts("MANYTOONE")
     def conv_many_to_one(
-        self, model: type, prop: RelationshipProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: RelationshipProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return QuerySelectField(**kwargs)
 
     @converts("MANYTOMANY", "ONETOMANY")
     def conv_many_to_many(
-        self, model: type, prop: RelationshipProperty, kwargs: Dict[str, Any]
+        self, model: type, prop: RelationshipProperty, kwargs: dict[str, Any]
     ) -> UnboundField:
         return QuerySelectMultipleField(**kwargs)
 
@@ -592,17 +594,17 @@ class ModelConverter(ModelConverterBase):
 async def get_model_form(
     model: type,
     session_maker: sessionmaker,
-    only: Optional[Sequence[str]] = None,
-    exclude: Optional[Sequence[str]] = None,
-    column_labels: Optional[Dict[str, str]] = None,
-    form_args: Optional[Dict[str, Dict[str, Any]]] = None,
-    form_widget_args: Optional[Dict[str, Dict[str, Any]]] = None,
-    form_class: Type[Form] = Form,
-    form_overrides: Optional[Dict[str, Type[Field]]] = None,
-    form_ajax_refs: Optional[Dict[str, QueryAjaxModelLoader]] = None,
+    only: Sequence[str] | None = None,
+    exclude: Sequence[str] | None = None,
+    column_labels: dict[str, str] | None = None,
+    form_args: dict[str, dict[str, Any]] | None = None,
+    form_widget_args: dict[str, dict[str, Any]] | None = None,
+    form_class: type[Form] = Form,
+    form_overrides: dict[str, type[Field]] | None = None,
+    form_ajax_refs: dict[str, QueryAjaxModelLoader] | None = None,
     form_include_pk: bool = False,
-    form_converter: Type[ModelConverterBase] = ModelConverter,
-) -> Type[Form]:
+    form_converter: type[ModelConverterBase] = ModelConverter,
+) -> type[Form]:
     type_name = model.__name__ + "Form"
     converter = form_converter()
     mapper = sqlalchemy_inspect(model)
@@ -615,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/helpers.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import csv
 import enum
 import os
@@ -9,11 +11,7 @@ from typing import (
     Any,
     AsyncGenerator,
     Callable,
-    Dict,
     Generator,
-    List,
-    Optional,
-    Tuple,
     TypeVar,
 )
 
@@ -136,11 +134,11 @@ class Writer(ABC):
     """https://docs.python.org/3/library/csv.html#writer-objects"""
 
     @abstractmethod
-    def writerow(self, row: List[str]) -> None:
+    def writerow(self, row: list[str]) -> None:
         pass  # pragma: no cover
 
     @abstractmethod
-    def writerows(self, rows: List[List[str]]) -> None:
+    def writerows(self, rows: list[list[str]]) -> None:
         pass  # pragma: no cover
 
     @property
@@ -174,7 +172,7 @@ def stream_to_csv(
     return callback(writer)  # type: ignore
 
 
-def get_primary_keys(model: Any) -> Tuple[Column, ...]:
+def get_primary_keys(model: Any) -> tuple[Column, ...]:
     return tuple(inspect(model).mapper.primary_key)
 
 
@@ -191,7 +189,7 @@ def get_object_identifier(obj: Any) -> Any:
     return ";".join(str(v).replace("\\", "\\\\").replace(";", r"\;") for v in values)
 
 
-def _object_identifier_parts(id_string: str, model: type) -> Tuple[str, ...]:
+def _object_identifier_parts(id_string: str, model: type) -> tuple[str, ...]:
     pks = get_primary_keys(model)
     if len(pks) == 1:
         # Only one primary key so no special processing
@@ -255,7 +253,7 @@ def is_relationship(prop: MODEL_PROPERTY) -> bool:
     return isinstance(prop, RelationshipProperty)
 
 
-def parse_interval(value: str) -> Optional[timedelta]:
+def parse_interval(value: str) -> timedelta | None:
     match = (
         standard_duration_re.match(value)
         or iso8601_duration_re.match(value)
@@ -265,7 +263,7 @@ def parse_interval(value: str) -> Optional[timedelta]:
     if not match:
         return None
 
-    kw: Dict[str, Any] = match.groupdict()
+    kw: dict[str, Any] = match.groupdict()
     sign = -1 if kw.pop("sign", "+") == "-" else 1
     if kw.get("microseconds"):
         kw["microseconds"] = kw["microseconds"].ljust(6, "0")

sqladmin/models.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import time
+import warnings
 from enum import Enum
 from typing import (
     TYPE_CHECKING,
@@ -29,6 +32,7 @@ from starlette.exceptions import HTTPException
 from starlette.requests import Request
 from starlette.responses import StreamingResponse
 from wtforms import Field, Form
+from wtforms.fields.core import UnboundField
 
 from sqladmin._queries import Query
 from sqladmin._types import MODEL_ATTR
@@ -172,7 +176,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] = ""
@@ -598,6 +602,28 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         ```
     """
 
+    form_rules: ClassVar[list[str]] = []
+    """List of rendering rules for model creation and edit form.
+    This property changes default form rendering behavior and to rearrange
+    order of rendered fields, add some text between fields, group them, etc.
+    If not set, will use default Flask-Admin form rendering logic.
+
+    ???+ example
+        ```python
+        class UserAdmin(ModelAdmin, model=User):
+            form_rules = [
+                "first_name",
+                "last_name",
+            ]
+        ```
+    """
+
+    form_create_rules: ClassVar[list[str]] = []
+    """Customized rules for the create form. Cannot be specified with `form_rules`."""
+
+    form_edit_rules: ClassVar[list[str]] = []
+    """Customized rules for the edit form. Cannot be specified with `form_rules`."""
+
     # General options
     column_labels: ClassVar[Dict[MODEL_ATTR, str]] = {}
     """A mapping of column labels, used to map column names to new names.
@@ -685,6 +711,8 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
                 model_admin=self, name=name, options=options
             )
 
+        self._refresh_form_rules_cache()
+
         self._custom_actions_in_list: Dict[str, str] = {}
         self._custom_actions_in_detail: Dict[str, str] = {}
         self._custom_actions_confirmation: Dict[str, str] = {}
@@ -820,7 +848,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         return await self._get_object_by_pk(stmt)
 
     async def get_object_for_edit(self, request: Request) -> Any:
-        stmt = self.edit_form_query(request)
+        stmt = self.form_edit_query(request)
         return await self._get_object_by_pk(stmt)
 
     async def get_object_for_delete(self, value: Any) -> Any:
@@ -1054,6 +1082,13 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         return select(self.model)
 
     def edit_form_query(self, request: Request) -> Select:
+        msg = (
+            "Overriding 'edit_form_query' is deprecated. Use 'form_edit_query' instead."
+        )
+        warnings.warn(msg, DeprecationWarning, stacklevel=2)
+        return self.form_edit_query(request)
+
+    def form_edit_query(self, request: Request) -> Select:
         """
         The SQLAlchemy select expression used for the edit form page which can be
         customized. By default it will select the object by primary key(s) without any
@@ -1143,3 +1178,26 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
             media_type="text/csv",
             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
+            self._form_edit_rules = self.form_rules
+        else:
+            self._form_create_rules = self.form_create_rules
+            self._form_edit_rules = self.form_edit_rules
+
+    def _validate_form_class(self, ruleset: List[Any], form_class: Type[Form]) -> None:
+        form_fields = []
+        for name, obj in form_class.__dict__.items():
+            if isinstance(obj, UnboundField):
+                form_fields.append(name)
+
+        missing_fields = []
+        if ruleset:
+            for field_name in form_fields:
+                if field_name not in ruleset:
+                    missing_fields.append(field_name)
+
+        for field_name in missing_fields:
+            delattr(form_class, field_name)

sqladmin/pagination.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 from dataclasses import dataclass, field
-from typing import Any, List
+from typing import Any
 
 from starlette.datastructures import URL
 
@@ -12,11 +14,11 @@ class PageControl:
 
 @dataclass
 class Pagination:
-    rows: List[Any]
+    rows: list[Any]
     page: int
     page_size: int
     count: int
-    page_controls: List[PageControl] = field(default_factory=list)
+    page_controls: list[PageControl] = field(default_factory=list)
     max_page_controls: int = 7
 
     @property
@@ -44,6 +46,11 @@ class Pagination:
 
         raise RuntimeError("Next page not found.")
 
+    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):