sqladmin 0.21.0__tar.gz → 0.23.0__tar.gz

{sqladmin-0.21.0 → sqladmin-0.23.0}/PKG-INFO

@@ -1,34 +1,35 @@
 Metadata-Version: 2.4
 Name: sqladmin
-Version: 0.21.0
+Version: 0.23.0
 Summary: SQLAlchemy admin for FastAPI and Starlette
-Project-URL: Documentation, https://aminalaee.github.io/sqladmin/
-Project-URL: Issues, https://github.com/aminalaee/sqladmin/issues
-Project-URL: Source, https://github.com/aminalaee/sqladmin
+Keywords: sqlalchemy,fastapi,starlette,admin
+Author: Amin Alaee
 Author-email: Amin Alaee <me@aminalaee.dev>
 License-Expression: BSD-3-Clause
-License-File: LICENSE.md
-Keywords: admin,fastapi,sqlalchemy,starlette
 Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
 Classifier: Topic :: Internet :: WWW/HTTP
-Requires-Python: >=3.8
+Classifier: Operating System :: OS Independent
+Requires-Dist: starlette
+Requires-Dist: wtforms>=3.1,<3.2
 Requires-Dist: jinja2
 Requires-Dist: python-multipart
-Requires-Dist: sqlalchemy>=1.4
-Requires-Dist: starlette
-Requires-Dist: wtforms<3.2,>=3.1
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: itsdangerous ; extra == 'full'
+Requires-Python: >=3.9
+Project-URL: Documentation, https://aminalaee.github.io/sqladmin/
+Project-URL: Issues, https://github.com/aminalaee/sqladmin/issues
+Project-URL: Source, https://github.com/aminalaee/sqladmin
 Provides-Extra: full
-Requires-Dist: itsdangerous; extra == 'full'
 Description-Content-Type: text/markdown
 
 <p align="center">

sqladmin-0.23.0/pyproject.toml

@@ -0,0 +1,113 @@
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "sqladmin"
+module-root = ""
+
+[project]
+name = "sqladmin"
+version = "0.23.0"
+description = 'SQLAlchemy admin for FastAPI and Starlette'
+readme = "README.md"
+requires-python = ">=3.9"
+license = "BSD-3-Clause"
+keywords = ["sqlalchemy", "fastapi", "starlette", "admin"]
+authors = [{ name = "Amin Alaee", email = "me@aminalaee.dev" }]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Environment :: Web Environment",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: BSD License",
+  "Topic :: Internet :: WWW/HTTP",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  "starlette",
+  "wtforms >=3.1, <3.2",
+  "jinja2",
+  "python-multipart",
+  "sqlalchemy >= 2.0",
+]
+
+
+[project.optional-dependencies]
+full = ["itsdangerous"]
+
+[project.urls]
+Documentation = "https://aminalaee.github.io/sqladmin/"
+Issues = "https://github.com/aminalaee/sqladmin/issues"
+Source = "https://github.com/aminalaee/sqladmin"
+
+
+[dependency-groups]
+dev = [
+  "aiosqlite",
+  "arrow",
+  "asyncpg",
+  "babel",
+  "build",
+  "colour",
+  "coverage",
+  "email-validator",
+  "fastapi-storages",
+  "greenlet",
+  "httpx",
+  "itsdangerous",
+  "phonenumbers",
+  "pillow",
+  "psycopg2-binary",
+  "psycopg[binary]",
+  "pytest",
+  "python-dateutil",
+  "sqlalchemy_utils",
+  "sqlmodel",
+  "bandit",
+]
+
+lint = ["mypy==1.18.1", "ruff==0.14.10", "types-wtforms>=3.2.1.20250809"]
+
+docs = [
+  "mkdocs-material==9.6.14",
+  "mkdocs==1.6.1",
+  "mkdocstrings[python]==0.26.1",
+]
+
+[tool.mypy]
+disallow_untyped_defs = true
+ignore_missing_imports = true
+show_error_codes = true
+check_untyped_defs = true
+strict_optional = true
+no_implicit_optional = true
+disable_error_code = ["var-annotated"]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+ignore_errors = true
+
+[tool.ruff]
+lint.select = ["E", "F", "I"]
+
+[tool.coverage.run]
+source_pkgs = ["sqladmin", "tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "pragma: nocover",
+  "except NotImplementedError",
+  "raise NotImplementedError",
+  "if TYPE_CHECKING:",
+]
+fail_under = 95
+show_missing = true
+skip_covered = true

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/__init__.py

@@ -1,8 +1,6 @@
 from sqladmin.application import Admin, action, expose
 from sqladmin.models import BaseView, ModelView
 
-__version__ = "0.21.0"
-
 __all__ = [
     "Admin",
     "expose",

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/_menu.py

@@ -93,6 +93,6 @@ class Menu:
         # Only works for one-level menu
         for root in self.items:
             if root.name == item.name:
-                root.children.append(*item.children)
+                root.children.extend(item.children)
                 return
         self.items.append(item)

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/_queries.py

@@ -40,11 +40,13 @@ class Query:
         conditions = []
         for value in values:
             conditions.append(
-                and_(
-                    pk == value
-                    for pk, value in zip(
-                        target_pks,
-                        object_identifier_values(value, target),
+                and_(  # type: ignore[type-var]
+                    *(
+                        pk == value
+                        for pk, value in zip(
+                            target_pks,
+                            object_identifier_values(value, target),
+                        )
                     )
                 )
             )
@@ -65,10 +67,10 @@ class Query:
         # ``relation.local_remote_pairs`` is ordered by the foreign keys
         # but the values are ordered by the primary keys. This dict
         # ensures we write the correct value to the fk fields
-        pk_value = {pk: value for pk, value in zip(pks, values)}
+        pk_value = dict(zip(pks, values))
 
-        for fk, pk in relation.local_remote_pairs:
-            setattr(obj, fk.name, pk_value[pk])
+        for fk, pk in relation.local_remote_pairs or []:
+            setattr(obj, fk.name, pk_value[pk])  # type: ignore[index]
 
         return obj
 
@@ -217,18 +219,24 @@ class Query:
 
     async def delete(self, obj: Any, request: Request) -> None:
         if self.model_view.is_async:
-            await self._delete_async(obj, request)
+            coro = self._delete_async(obj, request)
         else:
-            await anyio.to_thread.run_sync(self._delete_sync, obj, request)
+            coro = anyio.to_thread.run_sync(self._delete_sync, obj, request)
+
+        return await coro
 
     async def insert(self, data: dict, request: Request) -> Any:
         if self.model_view.is_async:
-            return await self._insert_async(data, request)
+            coro = self._insert_async(data, request)
         else:
-            return await anyio.to_thread.run_sync(self._insert_sync, data, request)
+            coro = anyio.to_thread.run_sync(self._insert_sync, data, request)
+
+        return await coro
 
     async def update(self, pk: Any, data: dict, request: Request) -> Any:
         if self.model_view.is_async:
-            return await self._update_async(pk, data, request)
+            coro = self._update_async(pk, data, request)
         else:
-            return await anyio.to_thread.run_sync(self._update_sync, pk, data, request)
+            coro = anyio.to_thread.run_sync(self._update_sync, pk, data, request)
+
+        return await coro

sqladmin-0.23.0/sqladmin/_types.py

@@ -0,0 +1,55 @@
+from typing import (
+    Any,
+    Callable,
+    List,
+    Protocol,
+    Tuple,
+    Union,
+    runtime_checkable,
+)
+
+from sqlalchemy.engine import Engine
+from sqlalchemy.ext.asyncio import AsyncEngine
+from sqlalchemy.orm import ColumnProperty, InstrumentedAttribute, RelationshipProperty
+from sqlalchemy.sql.expression import Select
+from starlette.requests import Request
+
+MODEL_PROPERTY = Union[ColumnProperty, RelationshipProperty]
+ENGINE_TYPE = Union[Engine, AsyncEngine]
+MODEL_ATTR = Union[str, InstrumentedAttribute]
+
+
+@runtime_checkable
+class SimpleColumnFilter(Protocol):
+    """Protocol for filters with simple value-based filtering"""
+
+    title: str
+    parameter_name: str
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]: ...  # pragma: no cover
+
+    async def get_filtered_query(
+        self, query: Select, value: Any, model: Any
+    ) -> Select: ...  # pragma: no cover
+
+
+@runtime_checkable
+class OperationColumnFilter(Protocol):
+    """Protocol for filters with operation-based filtering"""
+
+    title: str
+    parameter_name: str
+    has_operator: bool
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]: ...  # pragma: no cover
+
+    async def get_filtered_query(
+        self, query: Select, operation: str, value: Any, model: Any
+    ) -> Select: ...  # pragma: no cover
+
+
+ColumnFilter = Union[SimpleColumnFilter, OperationColumnFilter]

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/_validators.py

@@ -11,8 +11,10 @@ class CurrencyValidator:
 
         try:
             Currency(field.data)
-        except (TypeError, ValueError):
-            raise ValidationError("Not a valid ISO currency code (e.g. USD, EUR, CNY).")
+        except (TypeError, ValueError) as exc:
+            raise ValidationError(
+                "Not a valid ISO currency code (e.g. USD, EUR, CNY)."
+            ) from exc
 
 
 class PhoneNumberValidator:
@@ -23,8 +25,8 @@ class PhoneNumberValidator:
 
         try:
             PhoneNumber(field.data)
-        except PhoneNumberParseException:
-            raise ValidationError("Not a valid phone number.")
+        except PhoneNumberParseException as exc:
+            raise ValidationError("Not a valid phone number.") from exc
 
 
 class ColorValidator:
@@ -35,8 +37,10 @@ class ColorValidator:
 
         try:
             Color(field.data)
-        except ValueError:
-            raise ValidationError('Not a valid color (e.g. "red", "#f00", "#ff0000").')
+        except ValueError as exc:
+            raise ValidationError(
+                'Not a valid color (e.g. "red", "#f00", "#ff0000").'
+            ) from exc
 
 
 class TimezoneValidator:
@@ -48,5 +52,7 @@ class TimezoneValidator:
     def __call__(self, form: Form, field: Field) -> None:
         try:
             self.coerce_function(str(field.data))
-        except Exception:
-            raise ValidationError("Not a valid timezone (e.g. 'Asia/Singapore').")
+        except Exception as exc:
+            raise ValidationError(
+                "Not a valid timezone (e.g. 'Asia/Singapore')."
+            ) from exc

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/ajax.py

@@ -93,8 +93,8 @@ def create_ajax_loader(
 
     try:
         attr = mapper.relationships[name]
-    except KeyError:
-        raise ValueError(f"{model_admin.model}.{name} is not a relation.")
+    except KeyError as exc:
+        raise ValueError(f"{model_admin.model}.{name} is not a relation.") from exc
 
     remote_model = attr.mapper.class_
     return QueryAjaxModelLoader(name, remote_model, model_admin, **options)

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/application.py

@@ -42,7 +42,7 @@ from sqladmin.models import BaseView, ModelView
 from sqladmin.templating import Jinja2Templates
 
 if TYPE_CHECKING:
-    from sqlalchemy.ext.asyncio import async_sessionmaker
+    from sqlalchemy.ext.asyncio import async_sessionmaker  # type: ignore[attr-defined]
 
 __all__ = [
     "Admin",
@@ -83,10 +83,13 @@ class BaseAdmin:
 
         if session_maker:
             self.session_maker = session_maker
-        elif isinstance(engine, Engine):
+        elif isinstance(self.engine, Engine):
             self.session_maker = sessionmaker(bind=self.engine, class_=Session)
         else:
-            self.session_maker = sessionmaker(bind=self.engine, class_=AsyncSession)
+            self.session_maker = sessionmaker(
+                bind=self.engine,  # type: ignore[arg-type]
+                class_=AsyncSession,
+            )
 
         self.session_maker.configure(autoflush=False, autocommit=False)
         self.is_async = is_async_session_maker(self.session_maker)
@@ -113,7 +116,7 @@ class BaseAdmin:
         templates.env.globals["min"] = min
         templates.env.globals["zip"] = zip
         templates.env.globals["admin"] = self
-        templates.env.globals["is_list"] = lambda x: isinstance(x, list)
+        templates.env.globals["is_list"] = lambda x: isinstance(x, (list, set))
         templates.env.globals["get_object_identifier"] = get_object_identifier
 
         return templates
@@ -181,14 +184,14 @@ class BaseAdmin:
                     func, "_label"
                 )
             if getattr(func, "_add_in_detail"):
-                view_instance._custom_actions_in_detail[
-                    getattr(func, "_slug")
-                ] = getattr(func, "_label")
+                view_instance._custom_actions_in_detail[getattr(func, "_slug")] = (
+                    getattr(func, "_label")
+                )
 
             if getattr(func, "_confirmation_message"):
-                view_instance._custom_actions_confirmation[
-                    getattr(func, "_slug")
-                ] = getattr(func, "_confirmation_message")
+                view_instance._custom_actions_confirmation[getattr(func, "_slug")] = (
+                    getattr(func, "_confirmation_message")
+                )
 
     def _handle_expose_decorated_func(
         self,
@@ -345,7 +348,7 @@ class Admin(BaseAdminView):
         ```
     """
 
-    def __init__(
+    def __init__(  # type: ignore[no-any-unimported]
         self,
         app: Starlette,
         engine: ENGINE_TYPE | None = None,
@@ -373,7 +376,7 @@ class Admin(BaseAdminView):
         super().__init__(
             app=app,
             engine=engine,
-            session_maker=session_maker,
+            session_maker=session_maker,  # type: ignore[arg-type]
             base_url=base_url,
             title=title,
             logo_url=logo_url,
@@ -388,7 +391,9 @@ class Admin(BaseAdminView):
         async def http_exception(
             request: Request, exc: Exception
         ) -> Response | Awaitable[Response]:
-            assert isinstance(exc, HTTPException)
+            if not isinstance(exc, HTTPException):
+                raise TypeError("Expected HTTPException, got %s" % type(exc))
+
             context = {
                 "status_code": exc.status_code,
                 "message": exc.detail,
@@ -630,7 +635,11 @@ class Admin(BaseAdminView):
         return await model_view.export_data(rows, export_type=export_type)
 
     async def login(self, request: Request) -> Response:
-        assert self.authentication_backend is not None
+        if self.authentication_backend is None:
+            raise HTTPException(
+                status_code=503,
+                detail="Authentication backend not configured.",
+            )
 
         context = {}
         if request.method == "GET":
@@ -646,7 +655,11 @@ class Admin(BaseAdminView):
         return RedirectResponse(request.url_for("admin:index"), status_code=302)
 
     async def logout(self, request: Request) -> Response:
-        assert self.authentication_backend is not None
+        if self.authentication_backend is None:
+            raise HTTPException(
+                status_code=503,
+                detail="Authentication backend not configured.",
+            )
 
         response = await self.authentication_backend.logout(request)
 
@@ -669,8 +682,8 @@ class Admin(BaseAdminView):
 
         try:
             loader: QueryAjaxModelLoader = model_view._form_ajax_refs[name]
-        except KeyError:
-            raise HTTPException(status_code=400)
+        except KeyError as exc:
+            raise HTTPException(status_code=400) from exc
 
         data = [loader.format(m) for m in await loader.get_list(term)]
         return JSONResponse({"results": data})
@@ -688,10 +701,12 @@ class Admin(BaseAdminView):
 
         if form.get("save") == "Save":
             return request.url_for("admin:list", identity=identity)
-        elif form.get("save") == "Save and continue editing" or (
+
+        if form.get("save") == "Save and continue editing" or (
             form.get("save") == "Save as new" and model_view.save_as_continue
         ):
             return request.url_for("admin:edit", identity=identity, pk=identifier)
+
         return request.url_for("admin:create", identity=identity)
 
     async def _handle_form_data(self, request: Request, obj: Any = None) -> FormData:
@@ -743,7 +758,7 @@ class Admin(BaseAdminView):
 def expose(
     path: str,
     *,
-    methods: list[str] = ["GET"],
+    methods: list[str] | None = None,
     identity: str | None = None,
     include_in_schema: bool = True,
 ) -> Callable[..., Any]:
@@ -753,7 +768,7 @@ def expose(
     def wrap(func):
         func._exposed = True
         func._path = path
-        func._methods = methods
+        func._methods = methods or ["GET"]
         func._identity = identity or func.__name__
         func._include_in_schema = include_in_schema
         return login_required(func)

{sqladmin-0.21.0 → sqladmin-0.23.0}/sqladmin/fields.py

@@ -1,7 +1,10 @@
+# mypy: disable-error-code="override"
+
 from __future__ import annotations
 
 import json
 import operator
+from enum import Enum
 from typing import Any, Callable, Generator
 
 from wtforms import Form, ValidationError, fields, widgets
@@ -29,7 +32,7 @@ class DateField(fields.DateField):
     Add custom DatePickerWidget for data-format and data-date-format fields
     """
 
-    widget = sqladmin_widgets.DatePickerWidget()
+    widget = sqladmin_widgets.DatePickerWidget()  # type: ignore[assignment]
 
 
 class DateTimeField(fields.DateTimeField):
@@ -37,7 +40,7 @@ class DateTimeField(fields.DateTimeField):
     Allows modifying the datetime format of a DateTimeField using form_args.
     """
 
-    widget = sqladmin_widgets.DateTimePickerWidget()
+    widget = sqladmin_widgets.DateTimePickerWidget()  # type: ignore[assignment]
 
 
 class IntervalField(fields.StringField):
@@ -53,7 +56,7 @@ class IntervalField(fields.StringField):
         if not interval:
             raise ValueError("Invalide timedelta format.")
 
-        self.data = interval
+        self.data = interval  # type: ignore[assignment]
 
 
 class SelectField(fields.SelectField):
@@ -80,13 +83,15 @@ class SelectField(fields.SelectField):
         for choice in choices:
             if isinstance(choice, tuple):
                 yield (choice[0], choice[1], self.coerce(choice[0]) == self.data, {})
-            else:
+            elif isinstance(choice, Enum):
                 yield (
                     choice.value,
                     choice.name,
                     self.coerce(choice.value) == self.data,
                     {},
                 )
+            else:
+                yield (str(choice), str(choice), self.coerce(choice) == self.data, {})
 
     def process_formdata(self, valuelist: list[str]) -> None:
         if valuelist:
@@ -95,8 +100,10 @@ class SelectField(fields.SelectField):
             else:
                 try:
                     self.data = self.coerce(valuelist[0])
-                except ValueError:
-                    raise ValueError(self.gettext("Invalid Choice: could not coerce"))
+                except ValueError as exc:
+                    raise ValueError(
+                        self.gettext("Invalid Choice: could not coerce")
+                    ) from exc
 
     def pre_validate(self, form: Form) -> None:
         if self.allow_blank and self.data is None:
@@ -109,10 +116,11 @@ class JSONField(fields.TextAreaField):
     def _value(self) -> str:
         if self.raw_data:
             return self.raw_data[0]
-        elif self.data:
+
+        if self.data:
             return str(json.dumps(self.data, ensure_ascii=False))
-        else:
-            return "{}"
+
+        return "{}"
 
     def process_formdata(self, valuelist: list[str]) -> None:
         if valuelist:
@@ -125,8 +133,8 @@ class JSONField(fields.TextAreaField):
 
             try:
                 self.data = json.loads(valuelist[0])
-            except ValueError:
-                raise ValueError(self.gettext("Invalid JSON"))
+            except ValueError as exc:
+                raise ValueError(self.gettext("Invalid JSON")) from exc
 
 
 class QuerySelectField(fields.SelectFieldBase):
@@ -168,7 +176,7 @@ class QuerySelectField(fields.SelectFieldBase):
         return self._data
 
     @data.setter
-    def data(self, data: tuple) -> None:
+    def data(self, data: tuple | None) -> None:
         self._data = data
         self._formdata = None
 
@@ -251,7 +259,8 @@ class QuerySelectMultipleField(QuerySelectField):
             for pk, _ in self._select_data:
                 if not formdata:
                     break
-                elif pk in formdata:
+
+                if pk in formdata:
                     formdata.remove(pk)
                     data.append(pk)
             if formdata:
@@ -260,7 +269,7 @@ class QuerySelectMultipleField(QuerySelectField):
         return self._data
 
     @data.setter
-    def data(self, data: tuple) -> None:
+    def data(self, data: tuple | None) -> None:
         self._data = data
         self._formdata = None
 
@@ -280,7 +289,8 @@ class QuerySelectMultipleField(QuerySelectField):
     def pre_validate(self, form: Form) -> None:
         if self._invalid_formdata:
             raise ValidationError(self.gettext("Not a valid choice"))
-        elif self.data:
+
+        if self.data:
             pk_list = [x[0] for x in self._select_data]
             for v in self.data:
                 if v not in pk_list:  # pragma: no cover
@@ -330,7 +340,7 @@ class AjaxSelectField(fields.SelectFieldBase):
 
 
 class AjaxSelectMultipleField(fields.SelectFieldBase):
-    widget = sqladmin_widgets.AjaxSelect2Widget(multiple=True)
+    widget = sqladmin_widgets.AjaxSelect2Widget(multiple=True)  # type: ignore[assignment]
     separator = ","
 
     def __init__(
@@ -371,10 +381,9 @@ class AjaxSelectMultipleField(fields.SelectFieldBase):
 
 
 class Select2TagsField(fields.SelectField):
-    widget = sqladmin_widgets.Select2TagsWidget()
+    widget = sqladmin_widgets.Select2TagsWidget()  # type: ignore[assignment]
 
-    def pre_validate(self, form: Form) -> None:
-        ...
+    def pre_validate(self, form: Form) -> None: ...
 
     def process_formdata(self, valuelist: list) -> None:
         self.data = valuelist
@@ -388,4 +397,4 @@ class FileField(fields.FileField):
     File field which is clearable.
     """
 
-    widget = sqladmin_widgets.FileInputWidget()
+    widget = sqladmin_widgets.FileInputWidget()  # type: ignore[assignment]