sqladmin 0.16.0__tar.gz → 0.17.0__tar.gz

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: sqladmin
-Version: 0.16.0
+Version: 0.17.0
 Summary: SQLAlchemy admin for FastAPI and Starlette
 Project-URL: Documentation, https://aminalaee.dev/sqladmin
 Project-URL: Issues, https://github.com/aminalaee/sqladmin/issues
@@ -82,9 +82,16 @@ Main features include:
 
 ## Installation
 
+Install using `pip`:
+
 ```shell
 $ pip install sqladmin
-$ pip install sqladmin[full]
+```
+
+This will install the full version of sqladmin with optional dependencies:
+
+```shell
+$ pip install "sqladmin[full]"
 ```
 
 ---

{sqladmin-0.16.0 → sqladmin-0.17.0}/README.md

@@ -49,9 +49,16 @@ Main features include:
 
 ## Installation
 
+Install using `pip`:
+
 ```shell
 $ pip install sqladmin
-$ pip install sqladmin[full]
+```
+
+This will install the full version of sqladmin with optional dependencies:
+
+```shell
+$ pip install "sqladmin[full]"
 ```
 
 ---

{sqladmin-0.16.0 → sqladmin-0.17.0}/pyproject.toml

@@ -86,7 +86,7 @@ python = ["38", "39", "310", "311", "3.12"]
 
 [tool.hatch.envs.lint]
 dependencies = [
-  "mypy==1.6.1",
+  "mypy==1.8.0",
   "ruff==0.1.5",
   "sqlalchemy~=1.4", # MyPy issues with SQLAlchemy V2
 ]

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/__init__.py

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

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

@@ -42,7 +42,7 @@ class ItemMenu:
 class CategoryMenu(ItemMenu):
     def is_active(self, request: Request) -> bool:
         return any(
-            c.is_active(request) and c.is_accessible(request) for c in self.children
+            c.is_visible(request) and c.is_accessible(request) for c in self.children
         )
 
     @property

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

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING, Any, Dict, List
 import anyio
 from sqlalchemy import select
 from sqlalchemy.ext.asyncio import AsyncSession
-from sqlalchemy.orm import Session, joinedload
+from sqlalchemy.orm import Session, selectinload
 from sqlalchemy.sql.expression import Select, and_, or_
 from starlette.requests import Request
 
@@ -152,7 +152,7 @@ class Query:
         stmt = self.model_view._stmt_by_identifier(pk)
 
         for relation in self.model_view._form_relations:
-            stmt = stmt.options(joinedload(relation))
+            stmt = stmt.options(selectinload(relation))
 
         async with self.model_view.session_maker(expire_on_commit=False) as session:
             result = await session.execute(stmt)

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/application.py

@@ -5,6 +5,7 @@ from types import MethodType
 from typing import (
     TYPE_CHECKING,
     Any,
+    Awaitable,
     Callable,
     List,
     Optional,
@@ -15,14 +16,14 @@ from typing import (
     cast,
     no_type_check,
 )
-from urllib.parse import urljoin
+from urllib.parse import parse_qsl, urljoin
 
 from jinja2 import ChoiceLoader, FileSystemLoader, PackageLoader
 from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import Session, sessionmaker
 from starlette.applications import Starlette
-from starlette.datastructures import URL, FormData, UploadFile
+from starlette.datastructures import URL, FormData, MultiDict, UploadFile
 from starlette.exceptions import HTTPException
 from starlette.middleware import Middleware
 from starlette.requests import Request
@@ -371,15 +372,17 @@ class Admin(BaseAdminView):
 
         statics = StaticFiles(packages=["sqladmin"])
 
-        # def http_exception(request: Request, exc: Exception) -> Response:
-        #     assert isinstance(exc, HTTPException)
-        #     context = {
-        #         "status_code": exc.status_code,
-        #         "message": exc.detail,
-        #     }
-        #     return self.templates.TemplateResponse(
-        #         request, "error.html", context, status_code=exc.status_code
-        #     )
+        async def http_exception(
+            request: Request, exc: Exception
+        ) -> Union[Response, Awaitable[Response]]:
+            assert isinstance(exc, HTTPException)
+            context = {
+                "status_code": exc.status_code,
+                "message": exc.detail,
+            }
+            return await self.templates.TemplateResponse(
+                request, "sqladmin/error.html", context, status_code=exc.status_code
+            )
 
         routes = [
             Mount("/statics", app=statics, name="statics"),
@@ -417,7 +420,7 @@ class Admin(BaseAdminView):
         ]
 
         self.admin.router.routes = routes
-        # self.admin.exception_handlers = {HTTPException: http_exception}
+        self.admin.exception_handlers = {HTTPException: http_exception}
         self.admin.debug = debug
         self.app.mount(base_url, app=self.admin, name="admin")
 
@@ -425,7 +428,7 @@ class Admin(BaseAdminView):
     async def index(self, request: Request) -> Response:
         """Index route which can be overridden to create dashboards."""
 
-        return await self.templates.TemplateResponse(request, "index.html")
+        return await self.templates.TemplateResponse(request, "sqladmin/index.html")
 
     @login_required
     async def list(self, request: Request) -> Response:
@@ -437,6 +440,14 @@ 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"
+            )
+
         context = {"model_view": model_view, "pagination": pagination}
         return await self.templates.TemplateResponse(
             request, model_view.list_template, context
@@ -482,7 +493,11 @@ class Admin(BaseAdminView):
 
             await model_view.delete_model(request, pk)
 
-        return Response(content=str(request.url_for("admin:list", identity=identity)))
+        referer_url = URL(request.headers.get("referer", ""))
+        referer_params = MultiDict(parse_qsl(referer_url.query))
+        url = URL(str(request.url_for("admin:list", identity=identity)))
+        url = url.include_query_params(**referer_params)
+        return Response(content=str(url))
 
     @login_required
     async def create(self, request: Request) -> Response:
@@ -539,7 +554,7 @@ class Admin(BaseAdminView):
         identity = request.path_params["identity"]
         model_view = self._find_model_view(identity)
 
-        model = await model_view.get_object_for_edit(request.path_params["pk"])
+        model = await model_view.get_object_for_edit(request)
         if not model:
             raise HTTPException(status_code=404)
 
@@ -606,13 +621,13 @@ class Admin(BaseAdminView):
 
         context = {}
         if request.method == "GET":
-            return await self.templates.TemplateResponse(request, "login.html")
+            return await self.templates.TemplateResponse(request, "sqladmin/login.html")
 
         ok = await self.authentication_backend.login(request)
         if not ok:
             context["error"] = "Invalid credentials."
             return await self.templates.TemplateResponse(
-                request, "login.html", context, status_code=400
+                request, "sqladmin/login.html", context, status_code=400
             )
 
         return RedirectResponse(request.url_for("admin:index"), status_code=302)

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/forms.py

@@ -169,7 +169,7 @@ class ModelConverterBase:
         if (column.primary_key or column.foreign_keys) and not form_include_pk:
             return None
 
-        default = getattr(column, "default", None)
+        default = getattr(column, "default", None) or kwargs.get("default")
 
         if default is not None:
             # Only actually change default if it has an attribute named

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/helpers.py

@@ -159,7 +159,7 @@ class _PseudoBuffer:
 
 
 def stream_to_csv(
-    callback: Callable[[Writer], AsyncGenerator[T, None]]
+    callback: Callable[[Writer], AsyncGenerator[T, None]],
 ) -> Generator[T, None, None]:
     """Function that takes a callable (that yields from a CSV Writer), and
     provides it a writer that streams the output directly instead of
@@ -241,10 +241,13 @@ def get_direction(prop: MODEL_PROPERTY) -> str:
 
 def get_column_python_type(column: Column) -> type:
     try:
-        if hasattr(column.type, "impl"):
-            return column.type.impl.python_type
         return column.type.python_type
     except NotImplementedError:
+        if hasattr(column.type, "impl"):
+            try:
+                return column.type.impl.python_type
+            except NotImplementedError:
+                ...
         return str
 
 

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/models.py

@@ -20,11 +20,12 @@ from urllib.parse import urlencode
 import anyio
 from sqlalchemy import Column, String, asc, cast, desc, func, inspect, or_
 from sqlalchemy.exc import NoInspectionAvailable
-from sqlalchemy.orm import joinedload, sessionmaker
+from sqlalchemy.orm import selectinload, sessionmaker
 from sqlalchemy.orm.exc import DetachedInstanceError
 from sqlalchemy.sql.elements import ClauseElement
 from sqlalchemy.sql.expression import Select, select
 from starlette.datastructures import URL
+from starlette.exceptions import HTTPException
 from starlette.requests import Request
 from starlette.responses import StreamingResponse
 from wtforms import Field, Form
@@ -316,7 +317,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         ```
     """
 
-    column_default_sort: ClassVar[Union[str, Tuple[str, bool], list]] = []
+    column_default_sort: ClassVar[Union[MODEL_ATTR, Tuple[MODEL_ATTR, bool], list]] = []
     """Default sort column if no sorting is applied.
 
     ???+ example
@@ -414,17 +415,17 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
     """
 
     # Templates
-    list_template: ClassVar[str] = "list.html"
-    """List view template. Default is `list.html`."""
+    list_template: ClassVar[str] = "sqladmin/list.html"
+    """List view template. Default is `sqladmin/list.html`."""
 
-    create_template: ClassVar[str] = "create.html"
-    """Create view template. Default is `create.html`."""
+    create_template: ClassVar[str] = "sqladmin/create.html"
+    """Create view template. Default is `sqladmin/create.html`."""
 
-    details_template: ClassVar[str] = "details.html"
-    """Details view template. Default is `details.html`."""
+    details_template: ClassVar[str] = "sqladmin/details.html"
+    """Details view template. Default is `sqladmin/details.html`."""
 
-    edit_template: ClassVar[str] = "edit.html"
-    """Edit view template. Default is `edit.html`."""
+    edit_template: ClassVar[str] = "sqladmin/edit.html"
+    """Edit view template. Default is `sqladmin/edit.html`."""
 
     # Export
     column_export_list: ClassVar[List[MODEL_ATTR]] = []
@@ -672,12 +673,10 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         self._export_prop_names = self.get_export_columns()
 
         self._search_fields = [
-            attr if isinstance(attr, str) else attr.key
-            for attr in self.column_searchable_list
+            self._get_prop_name(attr) for attr in self.column_searchable_list
         ]
         self._sort_fields = [
-            attr if isinstance(attr, str) else attr.key
-            for attr in self.column_sortable_list
+            self._get_prop_name(attr) for attr in self.column_sortable_list
         ]
 
         self._form_ajax_refs = {}
@@ -727,6 +726,9 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
             pk=get_object_identifier(obj),
         )
 
+    def _get_prop_name(self, prop: MODEL_ATTR) -> str:
+        return prop if isinstance(prop, str) else prop.key
+
     def _get_default_sort(self) -> List[Tuple[str, bool]]:
         if self.column_default_sort:
             if isinstance(self.column_default_sort, list):
@@ -745,6 +747,17 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
 
         return value
 
+    def validate_page_number(self, number: Union[str, None], default: int) -> int:
+        if not number:
+            return default
+
+        try:
+            return int(number)
+        except ValueError:
+            raise HTTPException(
+                status_code=400, detail="Invalid page or pageSize parameter"
+            )
+
     async def count(self, request: Request, stmt: Optional[Select] = None) -> int:
         if stmt is None:
             stmt = self.count_query(request)
@@ -752,14 +765,14 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         return rows[0]
 
     async def list(self, request: Request) -> Pagination:
-        page = int(request.query_params.get("page", 1))
-        page_size = int(request.query_params.get("pageSize", 0))
+        page = self.validate_page_number(request.query_params.get("page"), 1)
+        page_size = self.validate_page_number(request.query_params.get("pageSize"), 0)
         page_size = min(page_size or self.page_size, max(self.page_size_options))
         search = request.query_params.get("search", None)
 
         stmt = self.list_query(request)
         for relation in self._list_relations:
-            stmt = stmt.options(joinedload(relation))
+            stmt = stmt.options(selectinload(relation))
 
         stmt = self.sort_query(stmt, request)
 
@@ -789,7 +802,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         stmt = self.list_query(request).limit(limit)
 
         for relation in self._list_relations:
-            stmt = stmt.options(joinedload(relation))
+            stmt = stmt.options(selectinload(relation))
 
         rows = await self._run_query(stmt)
         return rows
@@ -802,16 +815,12 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         stmt = self._stmt_by_identifier(value)
 
         for relation in self._details_relations:
-            stmt = stmt.options(joinedload(relation))
+            stmt = stmt.options(selectinload(relation))
 
         return await self._get_object_by_pk(stmt)
 
-    async def get_object_for_edit(self, value: Any) -> Any:
-        stmt = self._stmt_by_identifier(value)
-
-        for relation in self._form_relations:
-            stmt = stmt.options(joinedload(relation))
-
+    async def get_object_for_edit(self, request: Request) -> Any:
+        stmt = self.edit_form_query(request)
         return await self._get_object_by_pk(stmt)
 
     async def get_object_for_delete(self, value: Any) -> Any:
@@ -881,9 +890,9 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         if include == "__all__":
             return self._prop_names
         elif include:
-            return [item if isinstance(item, str) else item.key for item in include]
+            return [self._get_prop_name(item) for item in include]
         elif exclude:
-            exclude = [item if isinstance(item, str) else item.key for item in exclude]
+            exclude = [self._get_prop_name(item) for item in exclude]
             return [prop for prop in self._prop_names if prop not in exclude]
         return defaults
 
@@ -956,10 +965,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
     ) -> Dict[str, Any]:
         pairs = {}
         for label, value in pair.items():
-            if isinstance(label, str):
-                pairs[label] = value
-            else:
-                pairs[label.key] = value
+            pairs[self._get_prop_name(label)] = value
         return pairs
 
     async def delete_model(self, request: Request, pk: Any) -> None:
@@ -1047,6 +1053,18 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
 
         return select(self.model)
 
+    def edit_form_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
+        additional filters.
+        """
+
+        stmt = self._stmt_by_identifier(request.path_params["pk"])
+        for relation in self._form_relations:
+            stmt = stmt.options(selectinload(relation))
+        return stmt
+
     def count_query(self, request: Request) -> Select:
         """
         The SQLAlchemy select expression used for the count query
@@ -1075,7 +1093,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         for sort_field, is_desc in sort_fields:
             model = self.model
 
-            parts = sort_field.split(".")
+            parts = self._get_prop_name(sort_field).split(".")
             for part in parts[:-1]:
                 model = getattr(model, part).mapper.class_
                 stmt = stmt.join(model)

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/statics/css/main.css

@@ -1,3 +1,3 @@
 .table thead th {
     text-transform: none;
-}
+}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/_macros.html

@@ -1,7 +1,8 @@
 {% macro menu_category(menu, request) %}
-{% if menu.is_visible(request) and menu.is_accessible(request) %}
+{% if menu.is_active(request) %}
 <li class="nav-item dropdown">
-  <a class="nav-link dropdown-toggle {% if menu.is_active(request) %}active{% endif %}" data-bs-toggle="dropdown" href="#">
+  <a class="nav-link dropdown-toggle {% if menu.is_active(request) %}active{% endif %}" data-bs-toggle="dropdown"
+    href="#">
     <span class="nav-link-icon d-md-none d-lg-inline-block">
       {% if menu.icon %}<i class="{{ menu.icon }}"></i>{% endif %}
     </span>
@@ -11,12 +12,15 @@
     <div class="dropdown-menu-columns">
       <div class="dropdown-menu-column">
         {% for sub_menu in menu.children %}
-        <a class="nav-link ps-lg-3 {% if sub_menu.is_active(request) %}active{% endif %}" href="{{ sub_menu.url(request) }}">
+        {% if sub_menu.is_visible(request) and sub_menu.is_accessible(request) %}
+        <a class="nav-link ps-lg-3 {% if sub_menu.is_active(request) %}active{% endif %}"
+          href="{{ sub_menu.url(request) }}">
           <span class="nav-link-icon d-md-none d-lg-inline-block">
             {% if sub_menu.icon %}<i class="{{ sub_menu.icon }}"></i>{% endif %}
           </span>
           <span class="nav-link-title">{{ sub_menu.display_name }}</span>
         </a>
+        {% endif %}
         {% endfor %}
       </div>
     </div>
@@ -40,12 +44,12 @@
 
 {% macro display_menu(menu, request) %}
 <div class="navbar-nav">
-{% for item in menu.items %}
-{% if item.type_ == "View" %}
-{{ menu_item(item, request) }}
-{% elif item.type_ == "Category" %}
-{{ menu_category(item, request) }}
-{% endif %}
-{% endfor %}
+  {% for item in menu.items %}
+  {% if item.type_ == "View" %}
+  {{ menu_item(item, request) }}
+  {% elif item.type_ == "Category" %}
+  {{ menu_category(item, request) }}
+  {% endif %}
+  {% endfor %}
 </div>
 {% endmacro %}

sqladmin-0.17.0/sqladmin/templates/sqladmin/base.html

@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
+  <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/tabler.min.css') }}">
+  <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/fontawesome.min.css') }}">
+  <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/select2.min.css') }}">
+  <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/flatpickr.min.css') }}">
+  <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/main.css') }}">
+  {% block head %}
+  {% endblock %}
+  <title>{{ admin.title }}</title>
+</head>
+
+<body>
+  {% block body %}
+  <main>
+    {% block main %}
+    {% endblock %}
+  </main>
+  {% endblock %}
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/jquery.min.js') }}"></script>
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/tabler.min.js') }}"></script>
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/popper.min.js') }}"></script>
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/bootstrap.min.js') }}"></script>
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/select2.full.min.js') }}"></script>
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/flatpickr.min.js') }}"></script>
+  <script type="text/javascript" src="{{ url_for('admin:statics', path='js/main.js') }}"></script>
+  {% block tail %}
+  {% endblock %}
+</body>
+
+</html>

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/create.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "sqladmin/layout.html" %}
 {% block content %}
 <div class="col-12">
   <div class="card">
@@ -8,6 +8,11 @@
     <div class="card-body border-bottom py-3">
       <form action="{{ url_for('admin:create', identity=model_view.identity) }}" method="POST"
         enctype="multipart/form-data">
+        <div class="row">
+          {% if error %}
+          <div class="alert alert-danger" role="alert">{{ error }}</div>
+          {% endif %}
+        </div>
         <fieldset class="form-fieldset">
           {% for field in form %}
           <div class="mb-3 form-group row">
@@ -21,14 +26,14 @@
               {% for error in field.errors %}
               <div class="invalid-feedback">{{ error }}</div>
               {% endfor %}
+              {% if field.description %}
+              <small class="text-muted">{{ field.description }}</small>
+              {% endif %}
             </div>
           </div>
           {% endfor %}
         </fieldset>
         <div class="row">
-          {% if error %}
-          <div class="alert alert-danger" role="alert">{{ error }}</div>
-          {% endif %}
           <div class="col-md-2">
             <a href="{{ url_for('admin:list', identity=model_view.identity) }}" class="btn">
               Cancel
@@ -46,4 +51,4 @@
     </div>
   </div>
 </div>
-{% endblock %}
+{% endblock %}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/details.html

@@ -1,12 +1,12 @@
-{% extends "layout.html" %}
+{% extends "sqladmin/layout.html" %}
 {% block content %}
 <div class="col-12">
   <div class="card">
     <div class="card-header">
       <h3 class="card-title">
         {% for pk in model_view.pk_columns -%}
-          {{ pk.name }}
-          {%- if not loop.last %};{% endif -%}
+        {{ pk.name }}
+        {%- if not loop.last %};{% endif -%}
         {% endfor %}: {{ get_object_identifier(model) }}</h3>
     </div>
     <div class="card-body border-bottom py-3">
@@ -27,12 +27,13 @@
               {% if name in model_view._relation_names %}
               {% if is_list( value ) %}
               <td>
-              {% for elem, formatted_elem in zip(value, formatted_value) %}
-              <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">({{ formatted_elem }})</a>
-              {% endfor %}
+                {% for elem, formatted_elem in zip(value, formatted_value) %}
+                <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">({{ formatted_elem }})</a>
+                {% endfor %}
               </td>
               {% else %}
-              <td><a href="{{ model_view._url_for_details_with_prop(request, model, name) }}">{{ formatted_value }}</a></td>
+              <td><a href="{{ model_view._url_for_details_with_prop(request, model, name) }}">{{ formatted_value }}</a>
+              </td>
               {% endif %}
               {% else %}
               <td>{{ formatted_value }}</td>
@@ -51,7 +52,9 @@
           </div>
           {% if model_view.can_delete %}
           <div class="col-md-1">
-            <a href="#" data-name="{{ model_view.name }}" data-pk="{{ get_object_identifier(model) }}" data-url="{{ model_view._url_for_delete(request, model) }}" data-bs-toggle="modal" data-bs-target="#modal-delete" class="btn btn-danger">
+            <a href="#" data-name="{{ model_view.name }}" data-pk="{{ get_object_identifier(model) }}"
+              data-url="{{ model_view._url_for_delete(request, model) }}" data-bs-toggle="modal"
+              data-bs-target="#modal-delete" class="btn btn-danger">
               Delete
             </a>
           </div>
@@ -66,11 +69,13 @@
           {% for custom_action,label in model_view._custom_actions_in_detail.items() %}
           <div class="col-md-1">
             {% if custom_action in model_view._custom_actions_confirmation %}
-            <a href="#" class="btn btn-secondary" data-bs-toggle="modal" data-bs-target="#modal-confirmation-{{ custom_action }}">
+            <a href="#" class="btn btn-secondary" data-bs-toggle="modal"
+              data-bs-target="#modal-confirmation-{{ custom_action }}">
               {{ label }}
             </a>
             {% else %}
-            <a href="{{ model_view._url_for_action(request, custom_action) }}?pks={{ get_object_identifier(model) }}" class="btn btn-secondary">
+            <a href="{{ model_view._url_for_action(request, custom_action) }}?pks={{ get_object_identifier(model) }}"
+              class="btn btn-secondary">
               {{ label }}
             </a>
             {% endif %}
@@ -82,15 +87,16 @@
   </div>
 </div>
 {% if model_view.can_delete %}
-{% include 'modals/delete.html' %}
+{% include 'sqladmin/modals/delete.html' %}
 {% endif %}
 
 {% for custom_action in model_view._custom_actions_in_detail %}
 {% if custom_action in model_view._custom_actions_confirmation %}
-{% with confirmation_message = model_view._custom_actions_confirmation[custom_action], custom_action=custom_action, url=model_view._url_for_action(request, custom_action) + '?pks=' + (get_object_identifier(model) | string) %}
-{% include 'modals/details_action_confirmation.html' %}
+{% with confirmation_message = model_view._custom_actions_confirmation[custom_action], custom_action=custom_action,
+url=model_view._url_for_action(request, custom_action) + '?pks=' + (get_object_identifier(model) | string) %}
+{% include 'sqladmin/modals/details_action_confirmation.html' %}
 {% endwith %}
 {% endif %}
 {% endfor %}
 
-{% endblock %}
+{% endblock %}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/edit.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "sqladmin/layout.html" %}
 {% block content %}
 <div class="col-12">
   <div class="card">
@@ -6,7 +6,13 @@
       <h3 class="card-title">Edit {{ model_view.name }}</h3>
     </div>
     <div class="card-body border-bottom py-3">
-      <form action="{{ model_view._build_url_for('admin:edit', request, obj) }}" method="POST" enctype="multipart/form-data">
+      <form action="{{ model_view._build_url_for('admin:edit', request, obj) }}" method="POST"
+        enctype="multipart/form-data">
+        <div class="row">
+          {% if error %}
+          <div class="alert alert-danger" role="alert">{{ error }}</div>
+          {% endif %}
+        </div>
         <fieldset class="form-fieldset">
           {% for field in form %}
           <div class="mb-3 form-group row">
@@ -20,14 +26,14 @@
               {% for error in field.errors %}
               <div class="invalid-feedback">{{ error }}</div>
               {% endfor %}
+              {% if field.description %}
+              <small class="text-muted">{{ field.description }}</small>
+              {% endif %}
             </div>
           </div>
           {% endfor %}
         </fieldset>
         <div class="row">
-          {% if error %}
-          <div class="alert alert-danger" role="alert">{{ error }}</div>
-          {% endif %}
           <div class="col-md-2">
             <a href="{{ url_for('admin:list', identity=model_view.identity) }}" class="btn">
               Cancel
@@ -37,10 +43,12 @@
             <div class="btn-group flex-wrap" data-toggle="buttons">
               <input type="submit" name="save" value="Save" class="btn">
               <input type="submit" name="save" value="Save and continue editing" class="btn">
-              {% if model_view.save_as %}
-              <input type="submit" name="save" value="Save as new" class="btn">
-              {% else %}
-              <input type="submit" name="save" value="Save and add another" class="btn">
+              {% if model_view.can_create %}
+                {% if model_view.save_as %}
+                <input type="submit" name="save" value="Save as new" class="btn">
+                {% else %}
+                <input type="submit" name="save" value="Save and add another" class="btn">
+                {% endif %}
               {% endif %}
             </div>
           </div>

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/error.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "sqladmin/layout.html" %}
 {% block body %}
 <div class="page page-center">
   <div class="container-tight py-4">
@@ -8,4 +8,4 @@
     </div>
   </div>
 </div>
-{% endblock %}
+{% endblock %}

sqladmin-0.17.0/sqladmin/templates/sqladmin/index.html

@@ -0,0 +1,3 @@
+{% extends "sqladmin/layout.html" %}
+{% block content %}
+{% endblock %}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/layout.html

@@ -1,5 +1,5 @@
-{% extends "base.html" %}
-{% from '_macros.html' import display_menu %}
+{% extends "sqladmin/base.html" %}
+{% from 'sqladmin/_macros.html' import display_menu %}
 {% block body %}
 <div class="wrapper">
   <aside class="navbar navbar-expand-lg navbar-vertical navbar-expand-md navbar-dark">
@@ -19,7 +19,7 @@
           <span class="navbar-toggler-icon"></span>
         </button>
         <div class="collapse navbar-collapse" id="navbarSupportedContent">
-        {{ display_menu(admin._menu, request) }}
+          {{ display_menu(admin._menu, request) }}
         </div>
       </nav>
       {% if admin.authentication_backend %}
@@ -52,4 +52,4 @@
     </div>
   </div>
 </div>
-{% endblock %}
+{% endblock %}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/list.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "sqladmin/layout.html" %}
 {% block content %}
 <div class="col-12">
   <div class="card">
@@ -8,18 +8,22 @@
         {% if model_view.can_export %}
         {% if model_view.export_types | length > 1 %}
         <div class="ms-3 d-inline-block dropdown">
-          <a href="#" class="btn btn-secondary dropdown-toggle" id="dropdownMenuButton1" data-bs-toggle="dropdown" aria-expanded="false">
+          <a href="#" class="btn btn-secondary dropdown-toggle" id="dropdownMenuButton1" data-bs-toggle="dropdown"
+            aria-expanded="false">
             Export
           </a>
           <ul class="dropdown-menu" aria-labelledby="dropdownMenuButton1">
             {% for export_type in model_view.export_types %}
-            <li><a class="dropdown-item" href="{{ url_for('admin:export', identity=model_view.identity, export_type=export_type) }}">{{ export_type | upper }}</a></li>
+            <li><a class="dropdown-item"
+                href="{{ url_for('admin:export', identity=model_view.identity, export_type=export_type) }}">{{
+                export_type | upper }}</a></li>
             {% endfor %}
           </ul>
         </div>
         {% elif model_view.export_types | length == 1 %}
         <div class="ms-3 d-inline-block">
-          <a href="{{ url_for('admin:export', identity=model_view.identity, export_type=model_view.export_types[0]) }}" class="btn btn-secondary">
+          <a href="{{ url_for('admin:export', identity=model_view.identity, export_type=model_view.export_types[0]) }}"
+            class="btn btn-secondary">
             Export
           </a>
         </div>
@@ -37,23 +41,27 @@
     <div class="card-body border-bottom py-3">
       <div class="d-flex justify-content-between">
         <div class="dropdown col-4">
-          <button {% if not model_view.can_delete and not model_view._custom_actions_in_list %} disabled {% endif %} class="btn btn-light dropdown-toggle" type="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+          <button {% if not model_view.can_delete and not model_view._custom_actions_in_list %} disabled {% endif %}
+            class="btn btn-light dropdown-toggle" type="button" id="dropdownMenuButton" data-toggle="dropdown"
+            aria-haspopup="true" aria-expanded="false">
             Actions
           </button>
           {% if model_view.can_delete or model_view._custom_actions_in_list %}
           <div class="dropdown-menu" aria-labelledby="dropdownMenuButton">
             {% if model_view.can_delete %}
-            <a class="dropdown-item" id="action-delete" href="#" data-name="{{ model_view.name }}" data-url="{{ url_for('admin:delete', identity=model_view.identity) }}" data-bs-toggle="modal" data-bs-target="#modal-delete">Delete selected items</a>
+            <a class="dropdown-item" id="action-delete" href="#" data-name="{{ model_view.name }}"
+              data-url="{{ url_for('admin:delete', identity=model_view.identity) }}" data-bs-toggle="modal"
+              data-bs-target="#modal-delete">Delete selected items</a>
             {% endif %}
             {% for custom_action, label in model_view._custom_actions_in_list.items() %}
             {% if custom_action in model_view._custom_actions_confirmation %}
-            <a class="dropdown-item" id="action-customconfirm-{{ custom_action }}" href="#"
-            data-bs-toggle="modal" data-bs-target="#modal-confirmation-{{ custom_action }}">
+            <a class="dropdown-item" id="action-customconfirm-{{ custom_action }}" href="#" data-bs-toggle="modal"
+              data-bs-target="#modal-confirmation-{{ custom_action }}">
               {{ label }}
             </a>
             {% else %}
             <a class="dropdown-item" id="action-custom-{{ custom_action }}" href="#"
-            data-url="{{ model_view._url_for_action(request, custom_action) }}">
+              data-url="{{ model_view._url_for_action(request, custom_action) }}">
               {{ label }}
             </a>
             {% endif %}
@@ -64,9 +72,12 @@
         {% if model_view.column_searchable_list %}
         <div class="col-md-4 text-muted">
           <div class="input-group">
-            <input id="search-input" type="text" class="form-control" placeholder="Search: {{ model_view.search_placeholder() }}" value="{{ request.query_params.get('search', '') }}">
+            <input id="search-input" type="text" class="form-control"
+              placeholder="Search: {{ model_view.search_placeholder() }}"
+              value="{{ request.query_params.get('search', '') }}">
             <button id="search-button" class="btn" type="button">Search</button>
-            <button id="search-reset" class="btn" type="button" {% if not request.query_params.get('search') %}disabled{% endif %}><i class="fa-solid fa-times"></i></button>
+            <button id="search-reset" class="btn" type="button" {% if not request.query_params.get('search')
+              %}disabled{% endif %}><i class="fa-solid fa-times"></i></button>
           </div>
         </div>
         {% endif %}
@@ -76,16 +87,19 @@
       <table class="table card-table table-vcenter text-nowrap">
         <thead>
           <tr>
-            <th class="w-1"><input class="form-check-input m-0 align-middle" type="checkbox" aria-label="Select all" id="select-all"></th>
+            <th class="w-1"><input class="form-check-input m-0 align-middle" type="checkbox" aria-label="Select all"
+                id="select-all"></th>
             <th class="w-1"></th>
             {% for name in model_view._list_prop_names %}
             {% set label = model_view._column_labels.get(name, name) %}
             <th>
               {% if name in model_view._sort_fields %}
               {% if request.query_params.get("sortBy") == name and request.query_params.get("sort") == "asc" %}
-              <a href="{{ request.url.include_query_params(sort='desc') }}"><i class="fa-solid fa-arrow-down"></i> {{ label }}</a>
+              <a href="{{ request.url.include_query_params(sort='desc') }}"><i class="fa-solid fa-arrow-up"></i> {{
+                label }}</a>
               {% elif request.query_params.get("sortBy") == name and request.query_params.get("sort") == "desc" %}
-              <a href="{{ request.url.include_query_params(sort='asc') }}"><i class="fa-solid fa-arrow-up"></i> {{ label }}</a>
+              <a href="{{ request.url.include_query_params(sort='asc') }}"><i class="fa-solid fa-arrow-down"></i> {{ label
+                }}</a>
               {% else %}
               <a href="{{ request.url.include_query_params(sortBy=name, sort='asc') }}">{{ label }}</a>
               {% endif %}
@@ -105,17 +119,21 @@
             </td>
             <td class="text-end">
               {% if model_view.can_view_details %}
-              <a href="{{ model_view._build_url_for('admin:details', request, row) }}" data-bs-toggle="tooltip" data-bs-placement="top" title="View">
+              <a href="{{ model_view._build_url_for('admin:details', request, row) }}" data-bs-toggle="tooltip"
+                data-bs-placement="top" title="View">
                 <span class="me-1"><i class="fa-solid fa-eye"></i></span>
               </a>
               {% endif %}
               {% if model_view.can_edit %}
-              <a href="{{ model_view._build_url_for('admin:edit', request, row) }}" data-bs-toggle="tooltip" data-bs-placement="top" title="Edit">
+              <a href="{{ model_view._build_url_for('admin:edit', request, row) }}" data-bs-toggle="tooltip"
+                data-bs-placement="top" title="Edit">
                 <span class="me-1"><i class="fa-solid fa-pen-to-square"></i></span>
               </a>
               {% endif %}
               {% if model_view.can_delete %}
-              <a href="#" data-name="{{ model_view.name }}" data-pk="{{ get_object_identifier(row) }}" data-url="{{ model_view._url_for_delete(request, row) }}" data-bs-toggle="modal" data-bs-target="#modal-delete" title="Delete">
+              <a href="#" data-name="{{ model_view.name }}" data-pk="{{ get_object_identifier(row) }}"
+                data-url="{{ model_view._url_for_delete(request, row) }}" data-bs-toggle="modal"
+                data-bs-target="#modal-delete" title="Delete">
                 <span class="me-1"><i class="fa-solid fa-trash"></i></span>
               </a>
               {% endif %}
@@ -125,9 +143,9 @@
             {% if name in model_view._relation_names %}
             {% if is_list( value ) %}
             <td>
-            {% for elem, formatted_elem in zip(value, formatted_value) %}
-            <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">({{ formatted_elem }})</a>
-            {% endfor %}
+              {% for elem, formatted_elem in zip(value, formatted_value) %}
+              <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">({{ formatted_elem }})</a>
+              {% endfor %}
             </td>
             {% else %}
             <td><a href="{{ model_view._url_for_details_with_prop(request, row, name) }}">{{ formatted_value }}</a></td>
@@ -142,35 +160,40 @@
       </table>
     </div>
     <div class="card-footer d-flex justify-content-between align-items-center gap-2">
-      <p class="m-0 text-muted">Showing <span>{{ ((pagination.page - 1) * pagination.page_size) + 1 }}</span> to <span>{{ min(pagination.page * pagination.page_size, pagination.count) }}</span> of <span>{{ pagination.count }}</span> items</p>
+      <p class="m-0 text-muted">Showing <span>{{ ((pagination.page - 1) * pagination.page_size) + 1 }}</span> to
+        <span>{{ min(pagination.page * pagination.page_size, pagination.count) }}</span> of <span>{{ pagination.count
+          }}</span> items
+      </p>
       <ul class="pagination m-0 ms-auto">
         <li class="page-item {% if not pagination.has_previous %}disabled{% endif %}">
           {% if pagination.has_previous %}
           <a class="page-link" href="{{ pagination.previous_page.url }}">
-          {% else %}
-          <a class="page-link" href="#">
-          {% endif %}
-          <i class="fa-solid fa-chevron-left"></i>
-          prev
-          </a>
+            {% else %}
+            <a class="page-link" href="#">
+              {% endif %}
+              <i class="fa-solid fa-chevron-left"></i>
+              prev
+            </a>
         </li>
         {% for page_control in pagination.page_controls %}
-        <li class="page-item {% if page_control.number == pagination.page %}active{% endif %}"><a class="page-link" href="{{ page_control.url }}">{{ page_control.number }}</a></li>
+        <li class="page-item {% if page_control.number == pagination.page %}active{% endif %}"><a class="page-link"
+            href="{{ page_control.url }}">{{ page_control.number }}</a></li>
         {% endfor %}
         <li class="page-item {% if not pagination.has_next %}disabled{% endif %}">
           {% if pagination.has_next %}
           <a class="page-link" href="{{ pagination.next_page.url }}">
-          {% else %}
-          <a class="page-link" href="#">
-          {% endif %}
-          next
-          <i class="fa-solid fa-chevron-right"></i>
-          </a>
+            {% else %}
+            <a class="page-link" href="#">
+              {% endif %}
+              next
+              <i class="fa-solid fa-chevron-right"></i>
+            </a>
         </li>
       </ul>
       <div class="dropdown text-muted">
         Show
-        <a href="#" class="btn btn-sm btn-light dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+        <a href="#" class="btn btn-sm btn-light dropdown-toggle" data-toggle="dropdown" aria-haspopup="true"
+          aria-expanded="false">
           {{ request.query_params.get("pageSize") or model_view.page_size }} / Page
         </a>
         <div class="dropdown-menu">
@@ -184,13 +207,14 @@
     </div>
   </div>
   {% if model_view.can_delete %}
-  {% include 'modals/delete.html' %}
+  {% include 'sqladmin/modals/delete.html' %}
   {% endif %}
 
   {% for custom_action in model_view._custom_actions_in_list %}
   {% if custom_action in model_view._custom_actions_confirmation %}
-  {% with confirmation_message = model_view._custom_actions_confirmation[custom_action], custom_action=custom_action, url=model_view._url_for_action(request, custom_action) %}
-  {% include 'modals/list_action_confirmation.html' %}
+  {% with confirmation_message = model_view._custom_actions_confirmation[custom_action], custom_action=custom_action,
+  url=model_view._url_for_action(request, custom_action) %}
+  {% include 'sqladmin/modals/list_action_confirmation.html' %}
   {% endwith %}
   {% endif %}
   {% endfor %}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/login.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "sqladmin/base.html" %}
 {% block body %}
 <div class="d-flex align-items-center justify-content-center vh-100">
   <form class="Fcol-lg-6 col-md-6 card card-md" action="{{ url_for('admin:login') }}" method="POST" autocomplete="off">
@@ -34,4 +34,4 @@
     </div>
   </form>
 </div>
-{% endblock %}
+{% endblock %}

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/modals/delete.html

@@ -26,4 +26,4 @@
       </div>
     </div>
   </div>
-</div>
+</div>

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/modals/details_action_confirmation.html

@@ -1,4 +1,5 @@
-<div class="modal modal-blur fade" id="modal-confirmation-{{ custom_action }}" tabindex="-1" role="dialog" aria-hidden="true">
+<div class="modal modal-blur fade" id="modal-confirmation-{{ custom_action }}" tabindex="-1" role="dialog"
+  aria-hidden="true">
   <div class="modal-dialog modal-sm modal-dialog-centered" role="document">
     <div class="modal-content">
       <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
@@ -25,4 +26,4 @@
       </div>
     </div>
   </div>
-</div>
+</div>

{sqladmin-0.16.0/sqladmin/templates → sqladmin-0.17.0/sqladmin/templates/sqladmin}/modals/list_action_confirmation.html

@@ -1,4 +1,5 @@
-<div class="modal modal-blur fade" id="modal-confirmation-{{ custom_action }}" tabindex="-1" role="dialog" aria-hidden="true">
+<div class="modal modal-blur fade" id="modal-confirmation-{{ custom_action }}" tabindex="-1" role="dialog"
+  aria-hidden="true">
   <div class="modal-dialog modal-sm modal-dialog-centered" role="document">
     <div class="modal-content">
       <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
@@ -25,4 +26,4 @@
       </div>
     </div>
   </div>
-</div>
+</div>

{sqladmin-0.16.0 → sqladmin-0.17.0}/sqladmin/widgets.py

@@ -75,15 +75,23 @@ class FileInputWidget(widgets.FileInput):
     """
 
     def __call__(self, field: Field, **kwargs: Any) -> str:
-        file_input = super().__call__(field, **kwargs)
-        checkbox_id = f"{field.id}_checkbox"
-        checkbox_label = Markup(
-            f'<label class="form-check-label" for="{checkbox_id}">Clear</label>'
-        )
-        checkbox_input = Markup(
-            f'<input class="form-check-input" type="checkbox" id="{checkbox_id}" name="{checkbox_id}">'  # noqa: E501
-        )
-        checkbox = Markup(
-            f'<div class="form-check">{checkbox_input}{checkbox_label}</div>'
-        )
-        return file_input + checkbox
+        if not field.flags.required:
+            checkbox_id = f"{field.id}_checkbox"
+            checkbox_label = Markup(
+                f'<label class="form-check-label" for="{checkbox_id}">Clear</label>'
+            )
+            checkbox_input = Markup(
+                f'<input class="form-check-input" type="checkbox" id="{checkbox_id}" name="{checkbox_id}">'  # noqa: E501
+            )
+            checkbox = Markup(
+                f'<div class="form-check">{checkbox_input}{checkbox_label}</div>'
+            )
+        else:
+            checkbox = Markup()
+
+        if field.data:
+            current_value = Markup(f"<p>Currently: {field.data}</p>")
+            field.flags.required = False
+            return current_value + checkbox + super().__call__(field, **kwargs)
+        else:
+            return super().__call__(field, **kwargs)

sqladmin-0.16.0/sqladmin/templates/base.html

@@ -1,32 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover"/>
-    <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/tabler.min.css') }}">
-    <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/fontawesome.min.css') }}">
-    <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/select2.min.css') }}">
-    <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/flatpickr.min.css') }}">
-    <link rel="stylesheet" href="{{ url_for('admin:statics', path='css/main.css') }}">
-    {% block head %}
-    {% endblock %}
-    <title>{{ admin.title }}</title>
-  </head>
-  <body>
-    {% block body %}
-    <main>
-      {% block main %}
-      {% endblock %}
-    </main>
-    {% endblock %}
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/jquery.min.js') }}"></script>
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/tabler.min.js') }}"></script>
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/popper.min.js') }}"></script>
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/bootstrap.min.js') }}"></script>
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/select2.full.min.js') }}"></script>
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/flatpickr.min.js') }}"></script>
-    <script type="text/javascript" src="{{ url_for('admin:statics', path='js/main.js') }}"></script>
-    {% block tail %}
-    {% endblock %}
-  </body>
-</html>

sqladmin-0.16.0/sqladmin/templates/index.html

@@ -1,3 +0,0 @@
-{% extends "layout.html" %}
-{% block content %}
-{% endblock %}