sqladmin 0.20.1__tar.gz → 0.21.0__tar.gz

{sqladmin-0.20.1 → sqladmin-0.21.0}/.gitignore

@@ -13,4 +13,5 @@ examples/
 .vscode/
 .uploads
 test.db
-coverage.xml
+coverage.xml
+dist/

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

@@ -1,8 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: sqladmin
-Version: 0.20.1
+Version: 0.21.0
 Summary: SQLAlchemy admin for FastAPI and Starlette
-Project-URL: Documentation, https://aminalaee.dev/sqladmin
+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
 Author-email: Amin Alaee <me@aminalaee.dev>
@@ -72,7 +72,7 @@ Main features include:
 
 ---
 
-**Documentation**: [https://aminalaee.dev/sqladmin](https://aminalaee.dev/sqladmin)
+**Documentation**: [https://aminalaee.github.io/sqladmin](https://aminalaee.github.io/sqladmin)
 
 **Source Code**: [https://github.com/aminalaee/sqladmin](https://github.com/aminalaee/sqladmin)
 

{sqladmin-0.20.1 → sqladmin-0.21.0}/README.md

@@ -39,7 +39,7 @@ Main features include:
 
 ---
 
-**Documentation**: [https://aminalaee.dev/sqladmin](https://aminalaee.dev/sqladmin)
+**Documentation**: [https://aminalaee.github.io/sqladmin](https://aminalaee.github.io/sqladmin)
 
 **Source Code**: [https://github.com/aminalaee/sqladmin](https://github.com/aminalaee/sqladmin)
 

{sqladmin-0.20.1 → sqladmin-0.21.0}/pyproject.toml

@@ -41,7 +41,7 @@ full = [
 ]
 
 [project.urls]
-Documentation = "https://aminalaee.dev/sqladmin"
+Documentation = "https://aminalaee.github.io/sqladmin/"
 Issues = "https://github.com/aminalaee/sqladmin/issues"
 Source = "https://github.com/aminalaee/sqladmin"
 
@@ -93,9 +93,9 @@ dependencies = [
 
 [tool.hatch.envs.docs]
 dependencies = [
-  "mkdocs-material==9.1.3",
-  "mkdocs==1.4.2",
-  "mkdocstrings[python]==0.25.0",
+  "mkdocs-material==9.6.14",
+  "mkdocs==1.6.1",
+  "mkdocstrings[python]==0.26.1",
 ]
 
 [tool.hatch.envs.test.scripts]

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

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

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

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

sqladmin-0.21.0/sqladmin/_types.py

@@ -0,0 +1,25 @@
+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 ColumnFilter(Protocol):
+    title: str
+    parameter_name: str
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]:
+        ...
+
+    async def get_filtered_query(self, query: Select, value: Any, model: Any) -> Select:
+        ...

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

@@ -197,16 +197,22 @@ class BaseAdmin:
         view_instance: BaseView | ModelView,
     ) -> None:
         if hasattr(func, "_exposed"):
+            if view.is_model:
+                path = f"/{view_instance.identity}" + getattr(func, "_path")
+                name = f"view-{view_instance.identity}-{func.__name__}"
+            else:
+                view.identity = getattr(func, "_identity")
+                path = getattr(func, "_path")
+                name = getattr(func, "_identity")
+
             self.admin.add_route(
                 route=func,
-                path=getattr(func, "_path"),
+                path=path,
                 methods=getattr(func, "_methods"),
-                name=getattr(func, "_identity"),
+                name=name,
                 include_in_schema=getattr(func, "_include_in_schema"),
             )
 
-            view.identity = getattr(func, "_identity")
-
     def add_model_view(self, view: type[ModelView]) -> None:
         """Add ModelView to the Admin.
 
@@ -233,6 +239,11 @@ class BaseAdmin:
         self._find_decorated_funcs(
             view, view_instance, self._handle_action_decorated_func
         )
+
+        self._find_decorated_funcs(
+            view, view_instance, self._handle_expose_decorated_func
+        )
+
         self._views.append(view_instance)
         self._build_menu(view_instance)
 
@@ -266,7 +277,7 @@ class BaseAdmin:
 
     def _build_menu(self, view: ModelView | BaseView) -> None:
         if view.category:
-            menu = CategoryMenu(name=view.category)
+            menu = CategoryMenu(name=view.category, icon=view.category_icon)
             menu.add_child(ViewMenu(view=view, name=view.name, icon=view.icon))
             self._menu.add(menu)
         else:
@@ -461,10 +472,9 @@ class Admin(BaseAdminView):
         """Details route."""
 
         await self._details(request)
-
         model_view = self._find_model_view(request.path_params["identity"])
+        model = await model_view.get_object_for_details(request)
 
-        model = await model_view.get_object_for_details(request.path_params["pk"])
         if not model:
             raise HTTPException(status_code=404)
 
@@ -638,7 +648,11 @@ class Admin(BaseAdminView):
     async def logout(self, request: Request) -> Response:
         assert self.authentication_backend is not None
 
-        await self.authentication_backend.logout(request)
+        response = await self.authentication_backend.logout(request)
+
+        if isinstance(response, Response):
+            return response
+
         return RedirectResponse(request.url_for("admin:index"), status_code=302)
 
     async def ajax_lookup(self, request: Request) -> Response:

{sqladmin-0.20.1 → sqladmin-0.21.0}/sqladmin/authentication.py

@@ -29,9 +29,13 @@ class AuthenticationBackend:
         """
         raise NotImplementedError()
 
-    async def logout(self, request: Request) -> bool:
+    async def logout(self, request: Request) -> Response | bool:
         """Implement logout logic here.
         This will usually clear the session with `request.session.clear()`.
+
+        If a `Response` or `RedirectResponse` is returned,
+        that response is returned to the user,
+        otherwise the user will be redirected to the index page.
         """
         raise NotImplementedError()
 
@@ -40,7 +44,7 @@ class AuthenticationBackend:
         This method will be called for each incoming request
         to validate the authentication.
 
-        If a 'Response' or `RedirectResponse` is returned,
+        If a `Response` or `RedirectResponse` is returned,
         that response is returned to the user,
         otherwise a True/False is expected.
         """

sqladmin-0.21.0/sqladmin/filters.py

@@ -0,0 +1,174 @@
+import re
+from typing import Any, Callable, List, Optional, Tuple
+
+from sqlalchemy import Integer
+from sqlalchemy.sql.expression import Select, select
+from starlette.requests import Request
+
+from sqladmin._types import MODEL_ATTR
+
+
+def get_parameter_name(column: MODEL_ATTR) -> str:
+    if isinstance(column, str):
+        return column
+    else:
+        return column.key
+
+
+def prettify_attribute_name(name: str) -> str:
+    return re.sub(r"_([A-Za-z])", r" \1", name).title()
+
+
+def get_title(column: MODEL_ATTR) -> str:
+    name = get_parameter_name(column)
+    return prettify_attribute_name(name)
+
+
+def get_column_obj(column: MODEL_ATTR, model: Any = None) -> Any:
+    if isinstance(column, str):
+        if model is None:
+            raise ValueError("model is required for string column filters")
+        return getattr(model, column)
+    return column
+
+
+def get_foreign_column_name(column_obj: Any) -> str:
+    fk = next(iter(column_obj.foreign_keys))
+    return fk.column.name
+
+
+def get_model_from_column(column: Any) -> Any:
+    return column.parent.class_
+
+
+class BooleanFilter:
+    def __init__(
+        self,
+        column: MODEL_ATTR,
+        title: Optional[str] = None,
+        parameter_name: Optional[str] = None,
+    ):
+        self.column = column
+        self.title = title or get_title(column)
+        self.parameter_name = parameter_name or get_parameter_name(column)
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]:
+        return [
+            ("all", "All"),
+            ("true", "Yes"),
+            ("false", "No"),
+        ]
+
+    async def get_filtered_query(self, query: Select, value: Any, model: Any) -> Select:
+        column_obj = get_column_obj(self.column, model)
+        if value == "true":
+            return query.filter(column_obj.is_(True))
+        elif value == "false":
+            return query.filter(column_obj.is_(False))
+        else:
+            return query
+
+
+class AllUniqueStringValuesFilter:
+    def __init__(
+        self,
+        column: MODEL_ATTR,
+        title: Optional[str] = None,
+        parameter_name: Optional[str] = None,
+    ):
+        self.column = column
+        self.title = title or get_title(column)
+        self.parameter_name = parameter_name or get_parameter_name(column)
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]:
+        column_obj = get_column_obj(self.column, model)
+
+        return [("", "All")] + [
+            (value[0], value[0])
+            for value in await run_query(select(column_obj).distinct())
+        ]
+
+    async def get_filtered_query(self, query: Select, value: Any, model: Any) -> Select:
+        if value == "":
+            return query
+
+        column_obj = get_column_obj(self.column, model)
+        return query.filter(column_obj == value)
+
+
+class StaticValuesFilter:
+    def __init__(
+        self,
+        column: MODEL_ATTR,
+        values: List[Tuple[str, str]],
+        title: Optional[str] = None,
+        parameter_name: Optional[str] = None,
+    ):
+        self.column = column
+        self.title = title or get_title(column)
+        self.parameter_name = parameter_name or get_parameter_name(column)
+        self.values = values
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]:
+        return [("", "All")] + self.values
+
+    async def get_filtered_query(self, query: Select, value: Any, model: Any) -> Select:
+        column_obj = get_column_obj(self.column, model)
+        if value == "":
+            return query
+        return query.filter(column_obj == value)
+
+
+class ForeignKeyFilter:
+    def __init__(
+        self,
+        foreign_key: MODEL_ATTR,
+        foreign_display_field: MODEL_ATTR,
+        foreign_model: Any = None,
+        title: Optional[str] = None,
+        parameter_name: Optional[str] = None,
+    ):
+        self.foreign_key = foreign_key
+        self.foreign_display_field = foreign_display_field
+        self.foreign_model = foreign_model
+        self.title = title or get_title(foreign_key)
+        self.parameter_name = parameter_name or get_parameter_name(foreign_key)
+
+    async def lookups(
+        self, request: Request, model: Any, run_query: Callable[[Select], Any]
+    ) -> List[Tuple[str, str]]:
+        foreign_key_obj = get_column_obj(self.foreign_key, model)
+        if self.foreign_model is None and isinstance(self.foreign_display_field, str):
+            raise ValueError("foreign_model is required for string foreign key filters")
+        if self.foreign_model is None:
+            assert not isinstance(self.foreign_display_field, str)
+            foreign_display_field_obj = self.foreign_display_field
+        else:
+            foreign_display_field_obj = get_column_obj(
+                self.foreign_display_field, self.foreign_model
+            )
+        if not self.foreign_model:
+            self.foreign_model = get_model_from_column(foreign_display_field_obj)
+        foreign_model_key_name = get_foreign_column_name(foreign_key_obj)
+        foreign_model_key_obj = getattr(self.foreign_model, foreign_model_key_name)
+
+        return [("", "All")] + [
+            (str(key), str(value))
+            for key, value in await run_query(
+                select(foreign_model_key_obj, foreign_display_field_obj).distinct()
+            )
+        ]
+
+    async def get_filtered_query(self, query: Select, value: Any, model: Any) -> Select:
+        foreign_key_obj = get_column_obj(self.foreign_key, model)
+        column_type = foreign_key_obj.type
+        if isinstance(column_type, Integer):
+            value = int(value)
+
+        return query.filter(foreign_key_obj == value)

{sqladmin-0.20.1 → sqladmin-0.21.0}/sqladmin/helpers.py

@@ -152,8 +152,10 @@ class _PseudoBuffer:
     interface.
     """
 
-    def write(self, value: T) -> T:
-        return value
+    encoding = "utf-8"
+
+    def write(self, value: T) -> bytes:
+        return str(value).encode(self.encoding)
 
 
 def stream_to_csv(

{sqladmin-0.20.1 → sqladmin-0.21.0}/sqladmin/models.py

@@ -36,7 +36,7 @@ from wtforms import Field, Form
 from wtforms.fields.core import UnboundField
 
 from sqladmin._queries import Query
-from sqladmin._types import MODEL_ATTR
+from sqladmin._types import MODEL_ATTR, ColumnFilter
 from sqladmin.ajax import create_ajax_loader
 from sqladmin.exceptions import InvalidModelError
 from sqladmin.formatters import BASE_FORMATTERS
@@ -183,6 +183,9 @@ class BaseView(BaseModelView):
     category: ClassVar[str] = ""
     """Category name to group views together."""
 
+    category_icon: ClassVar[str] = ""
+    """Display icon for category in the sidebar."""
+
 
 class ModelView(BaseView, metaclass=ModelViewMeta):
     """Base class for defining admnistrative behaviour for the model.
@@ -312,6 +315,17 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         ```
     """
 
+    column_filters: ClassVar[Sequence[ColumnFilter]] = []
+    """Collection of the filterable columns for the list view.
+    Columns can either be string names or SQLAlchemy columns.
+
+    ???+ example
+        ```python
+        class UserAdmin(ModelView, model=User):
+            column_filters = [User.is_admin]
+        ```
+    """
+
     column_sortable_list: ClassVar[Sequence[MODEL_ATTR]] = []
     """Collection of the sortable columns for the list view.
 
@@ -398,7 +412,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
     """
 
     save_as: ClassVar[bool] = False
-    """Set `save_as` to enable a “save as new” feature on admin change forms.
+    """Set `save_as` to enable a "save as new" feature on admin change forms.
 
     Normally, objects have three save options:
     ``Save`, `Save and continue editing` and `Save and add another`.
@@ -432,6 +446,12 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
     edit_template: ClassVar[str] = "sqladmin/edit.html"
     """Edit view template. Default is `sqladmin/edit.html`."""
 
+    # Template configuration
+    show_compact_lists: ClassVar[bool] = True
+    """Show compact lists. Default is `True`. 
+    If False, when showing lists of objects, each object will be \
+    displayed in a separate line."""
+
     # Export
     column_export_list: ClassVar[List[MODEL_ATTR]] = []
     """List of columns to include when exporting.
@@ -645,7 +665,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         - None will be displayed as an empty string
         - bool will be displayed as a checkmark if it is True otherwise as an X.
 
-    If you don’t like the default behavior and don’t want any type formatters applied,
+    If you don't like the default behavior and don't want any type formatters applied,
     just override this property with an empty dictionary:
 
     ???+ example
@@ -718,6 +738,19 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         self._custom_actions_in_detail: Dict[str, str] = {}
         self._custom_actions_confirmation: Dict[str, str] = {}
 
+    def _run_arbitrary_query_sync(self, stmt: ClauseElement) -> Any:
+        with self.session_maker(expire_on_commit=False) as session:
+            result = session.execute(stmt)
+            return result.all()
+
+    async def _run_arbitrary_query(self, stmt: ClauseElement) -> Any:
+        if self.is_async:
+            async with self.session_maker(expire_on_commit=False) as session:
+                result = await session.execute(stmt)
+                return result.all()
+        else:
+            return self._run_arbitrary_query_sync(stmt)
+
     def _run_query_sync(self, stmt: ClauseElement) -> Any:
         with self.session_maker(expire_on_commit=False) as session:
             result = session.execute(stmt)
@@ -803,6 +836,12 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         for relation in self._list_relations:
             stmt = stmt.options(selectinload(relation))
 
+        for filter in self.get_filters():
+            if request.query_params.get(filter.parameter_name):
+                stmt = await filter.get_filtered_query(
+                    stmt, request.query_params.get(filter.parameter_name), self.model
+                )
+
         stmt = self.sort_query(stmt, request)
 
         if search:
@@ -840,12 +879,8 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
         rows = await self._run_query(stmt)
         return rows[0] if rows else None
 
-    async def get_object_for_details(self, value: Any) -> Any:
-        stmt = self._stmt_by_identifier(value)
-
-        for relation in self._details_relations:
-            stmt = stmt.options(selectinload(relation))
-
+    async def get_object_for_details(self, request: Request) -> Any:
+        stmt = self.details_query(request)
         return await self._get_object_by_pk(stmt)
 
     async def get_object_for_edit(self, request: Request) -> Any:
@@ -973,6 +1008,15 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
             defaults=self._list_prop_names,
         )
 
+    def get_filters(self) -> List[ColumnFilter]:
+        """Get list of filters."""
+
+        filters = getattr(self, "column_filters", None)
+        if not filters:
+            return []
+
+        return filters
+
     async def on_model_change(
         self, data: dict, model: Any, is_created: bool, request: Request
     ) -> None:
@@ -1088,6 +1132,14 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
 
         return select(self.model)
 
+    def details_query(self, request: Request) -> Select:
+        """
+        The SQLAlchemy select expression used for the details page which can be
+        customized. By default it will select all objects without any filters.
+        """
+
+        return self.form_edit_query(request)
+
     def edit_form_query(self, request: Request) -> Select:
         msg = (
             "Overriding 'edit_form_query' is deprecated. Use 'form_edit_query' instead."
@@ -1184,7 +1236,7 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
 
         return StreamingResponse(
             content=stream_to_csv(generate),
-            media_type="text/csv",
+            media_type="text/csv; charset=utf-8",
             headers={"Content-Disposition": f"attachment;filename={filename}"},
         )
 
@@ -1203,7 +1255,9 @@ class ModelView(BaseView, metaclass=ModelViewMeta):
                     name: str(await self.get_prop_value(row, name))
                     for name in self._export_prop_names
                 }
-                yield json.dumps(row_dict) + (separator if idx < last_idx else "")
+                yield json.dumps(row_dict, ensure_ascii=False) + (
+                    separator if idx < last_idx else ""
+                )
 
             yield "]"
 

sqladmin-0.21.0/sqladmin/statics/css/main.css

@@ -0,0 +1,10 @@
+.table thead th {
+    text-transform: none;
+}
+
+.required-label::before {
+    content: "*";
+    color: red;
+    margin-right: 5px;
+}
+

{sqladmin-0.20.1 → sqladmin-0.21.0}/sqladmin/templates/sqladmin/_macros.html

@@ -1,5 +1,5 @@
 {% macro menu_category(menu, request) %}
-{% if menu.is_active(request) %}
+{% if menu.is_visible(request) and menu.is_accessible(request) %}
 <li class="nav-item dropdown">
   <a class="nav-link dropdown-toggle {% if menu.is_active(request) %}active{% endif %}" data-bs-toggle="dropdown"
     href="#">
@@ -56,7 +56,10 @@
 
 {% macro render_field(field, kwargs={}) %}
 <div class="mb-3 form-group row">
-  {{ field.label(class_="form-label col-sm-2 col-form-label") }}
+  {{ field.label(
+    class_="form-label col-sm-2 col-form-label" + (' required-label' if field.flags.required else ''),
+    **({'title': "This is a required field"} if field.flags.required else {})
+  ) }}
   <div class="col-sm-10">
     {% if field.errors %}
     {{ field(class_="form-control is-invalid") }}

{sqladmin-0.20.1 → sqladmin-0.21.0}/sqladmin/templates/sqladmin/details.html

@@ -28,7 +28,11 @@
               {% 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>
+                  {% if model_view.show_compact_lists %}
+                    <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">({{ formatted_elem }})</a>
+                  {% else %}
+                    <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">{{ formatted_elem }}</a><br/>
+                  {% endif %}
                 {% endfor %}
               </td>
               {% else %}

sqladmin-0.21.0/sqladmin/templates/sqladmin/list.html

@@ -0,0 +1,261 @@
+{% extends "sqladmin/layout.html" %}
+{% block content %}
+<div class="container-fluid">
+  <div class="row">
+    <div class="col-12">
+      <div class="d-flex">
+        <div class="flex-grow-1 me-2">
+          <div class="card">
+            <div class="card-header">
+              <h3 class="card-title">{{ model_view.name_plural }}</h3>
+              <div class="ms-auto">
+                {% 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">
+                    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>
+                    {% 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">
+                    Export
+                  </a>
+                </div>
+                {% endif %}
+                {% endif %}
+                {% if model_view.can_create %}
+                <div class="ms-3 d-inline-block">
+                  <a href="{{ url_for('admin:create', identity=model_view.identity) }}" class="btn btn-primary">
+                    + New {{ model_view.name }}
+                  </a>
+                </div>
+                {% endif %}
+              </div>
+            </div>
+            <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">
+                    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>
+                    {% 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 }}">
+                      {{ label }}
+                    </a>
+                    {% else %}
+                    <a class="dropdown-item" id="action-custom-{{ custom_action }}" href="#"
+                      data-url="{{ model_view._url_for_action(request, custom_action) }}">
+                      {{ label }}
+                    </a>
+                    {% endif %}
+                    {% endfor %}
+                  </div>
+                  {% endif %}
+                </div>
+                {% 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', '') }}">
+                    <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>
+                  </div>
+                </div>
+                {% endif %}
+              </div>
+            </div>
+            <div class="table-responsive">
+              <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"></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-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-down"></i> {{ label
+                        }}</a>
+                      {% else %}
+                      <a href="{{ request.url.include_query_params(sortBy=name, sort='asc') }}">{{ label }}</a>
+                      {% endif %}
+                      {% else %}
+                      {{ label }}
+                      {% endif %}
+                    </th>
+                    {% endfor %}
+                  </tr>
+                </thead>
+                <tbody>
+                  {% for row in pagination.rows %}
+                  <tr>
+                    <td>
+                      <input type="hidden" value="{{ get_object_identifier(row) }}">
+                      <input class="form-check-input m-0 align-middle select-box" type="checkbox" aria-label="Select item">
+                    </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">
+                        <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">
+                        <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">
+                        <span class="me-1"><i class="fa-solid fa-trash"></i></span>
+                      </a>
+                      {% endif %}
+                    </td>
+                    {% for name in model_view._list_prop_names %}
+                    {% set value, formatted_value = model_view.get_list_value(row, name) %}
+                    {% if name in model_view._relation_names %}
+                    {% if is_list( value ) %}
+                    <td>
+                      {% for elem, formatted_elem in zip(value, formatted_value) %}
+                        {% if model_view.show_compact_lists %}
+                          <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">({{ formatted_elem }})</a>
+                        {% else %}
+                          <a href="{{ model_view._build_url_for('admin:details', request, elem) }}">{{ formatted_elem }}</a><br/>
+                        {% endif %}
+                      {% endfor %}
+                    </td>
+                    {% else %}
+                    <td><a href="{{ model_view._url_for_details_with_prop(request, row, name) }}">{{ formatted_value }}</a></td>
+                    {% endif %}
+                    {% else %}
+                    <td>{{ formatted_value }}</td>
+                    {% endif %}
+                    {% endfor %}
+                  </tr>
+                  {% endfor %}
+                </tbody>
+              </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>
+              <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>
+                </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>
+                {% 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>
+                </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">
+                  {{ request.query_params.get("pageSize") or model_view.page_size }} / Page
+                </a>
+                <div class="dropdown-menu">
+                  {% for page_size_option in model_view.page_size_options %}
+                  <a class="dropdown-item" href="{{ request.url.include_query_params(pageSize=page_size_option, page=pagination.resize(page_size_option).page) }}">
+                    {{ page_size_option }} / Page
+                  </a>
+                  {% endfor %}
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+        {% if model_view.get_filters() %}
+        <div class="col-md-3" style="width: 300px; flex-shrink: 0;">
+          <div id="filter-sidebar" class="card">
+            <div class="card-header">
+              <h3 class="card-title">Filters</h3>
+            </div>
+            <div class="card-body p-0">
+              <div class="list-group list-group-flush">
+                {% for filter in model_view.get_filters() %}
+                <div class="list-group-item">
+                  <div class="p-2">
+                    <div class="fw-bold text-truncate">{{ filter.title }}</div>
+                    <div>
+                      {% for lookup in filter.lookups(request, model_view.model, model_view._run_arbitrary_query) %}
+                      <a href="{{ request.url.include_query_params(**{filter.parameter_name: lookup[0]}) }}" class="d-block text-decoration-none text-truncate">
+                        {{ lookup[1] }}
+                      </a>
+                      {% endfor %}
+                    </div>
+                  </div>
+                </div>
+                {% endfor %}
+              </div>
+            </div>
+          </div>
+        </div>
+        {% endif %}
+      </div>
+    </div>
+  </div>
+  {% if model_view.can_delete %}
+  {% 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 'sqladmin/modals/list_action_confirmation.html' %}
+  {% endwith %}
+  {% endif %}
+  {% endfor %}
+</div>
+{% endblock %}

sqladmin-0.20.1/sqladmin/_types.py

@@ -1,9 +0,0 @@
-from typing import Union
-
-from sqlalchemy.engine import Engine
-from sqlalchemy.ext.asyncio import AsyncEngine
-from sqlalchemy.orm import ColumnProperty, InstrumentedAttribute, RelationshipProperty
-
-MODEL_PROPERTY = Union[ColumnProperty, RelationshipProperty]
-ENGINE_TYPE = Union[Engine, AsyncEngine]
-MODEL_ATTR = Union[str, InstrumentedAttribute]

sqladmin-0.20.1/sqladmin/statics/css/main.css

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

sqladmin-0.20.1/sqladmin/templates/sqladmin/list.html

@@ -1,222 +0,0 @@
-{% extends "sqladmin/layout.html" %}
-{% block content %}
-<div class="col-12">
-  <div class="card">
-    <div class="card-header">
-      <h3 class="card-title">{{ model_view.name_plural }}</h3>
-      <div class="ms-auto">
-        {% 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">
-            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>
-            {% 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">
-            Export
-          </a>
-        </div>
-        {% endif %}
-        {% endif %}
-        {% if model_view.can_create %}
-        <div class="ms-3 d-inline-block">
-          <a href="{{ url_for('admin:create', identity=model_view.identity) }}" class="btn btn-primary">
-            + New {{ model_view.name }}
-          </a>
-        </div>
-        {% endif %}
-      </div>
-    </div>
-    <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">
-            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>
-            {% 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 }}">
-              {{ label }}
-            </a>
-            {% else %}
-            <a class="dropdown-item" id="action-custom-{{ custom_action }}" href="#"
-              data-url="{{ model_view._url_for_action(request, custom_action) }}">
-              {{ label }}
-            </a>
-            {% endif %}
-            {% endfor %}
-          </div>
-          {% endif %}
-        </div>
-        {% 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', '') }}">
-            <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>
-          </div>
-        </div>
-        {% endif %}
-      </div>
-    </div>
-    <div class="table-responsive">
-      <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"></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-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-down"></i> {{ label
-                }}</a>
-              {% else %}
-              <a href="{{ request.url.include_query_params(sortBy=name, sort='asc') }}">{{ label }}</a>
-              {% endif %}
-              {% else %}
-              {{ label }}
-              {% endif %}
-            </th>
-            {% endfor %}
-          </tr>
-        </thead>
-        <tbody>
-          {% for row in pagination.rows %}
-          <tr>
-            <td>
-              <input type="hidden" value="{{ get_object_identifier(row) }}">
-              <input class="form-check-input m-0 align-middle select-box" type="checkbox" aria-label="Select item">
-            </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">
-                <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">
-                <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">
-                <span class="me-1"><i class="fa-solid fa-trash"></i></span>
-              </a>
-              {% endif %}
-            </td>
-            {% for name in model_view._list_prop_names %}
-            {% set value, formatted_value = model_view.get_list_value(row, name) %}
-            {% 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 %}
-            </td>
-            {% else %}
-            <td><a href="{{ model_view._url_for_details_with_prop(request, row, name) }}">{{ formatted_value }}</a></td>
-            {% endif %}
-            {% else %}
-            <td>{{ formatted_value }}</td>
-            {% endif %}
-            {% endfor %}
-          </tr>
-          {% endfor %}
-        </tbody>
-      </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>
-      <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>
-        </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>
-        {% 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>
-        </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">
-          {{ request.query_params.get("pageSize") or model_view.page_size }} / Page
-        </a>
-        <div class="dropdown-menu">
-          {% for page_size_option in model_view.page_size_options %}
-          <a class="dropdown-item" href="{{ request.url.include_query_params(pageSize=page_size_option, page=pagination.resize(page_size_option).page) }}">
-            {{ page_size_option }} / Page
-          </a>
-          {% endfor %}
-        </div>
-      </div>
-    </div>
-  </div>
-  {% if model_view.can_delete %}
-  {% 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 'sqladmin/modals/list_action_confirmation.html' %}
-  {% endwith %}
-  {% endif %}
-  {% endfor %}
-</div>
-{% endblock %}