sqladmin 0.8.0__tar.gz → 0.10.0__tar.gz

{sqladmin-0.8.0 → sqladmin-0.10.0}/.gitignore

@@ -11,3 +11,4 @@ htmlcov/
 coverage.xml
 examples/
 .vscode/
+.uploads

{sqladmin-0.8.0 → sqladmin-0.10.0}/PKG-INFO

@@ -1,14 +1,15 @@
 Metadata-Version: 2.1
 Name: sqladmin
-Version: 0.8.0
+Version: 0.10.0
 Summary: SQLAlchemy admin for FastAPI and Starlette
 Project-URL: Documentation, https://aminalaee.dev/sqladmin
 Project-URL: Issues, https://github.com/aminalaee/sqladmin/issues
 Project-URL: Source, https://github.com/aminalaee/sqladmin
 Author-email: Amin Alaee <mohammadamin.alaee@gmail.com>
+License-Expression: BSD-3-Clause
 License-File: LICENSE.md
 Keywords: admin,fastapi,sqlalchemy,starlette
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
@@ -21,7 +22,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Requires-Python: >=3.7
-Requires-Dist: sqlalchemy<1.5,>=1.4
+Requires-Dist: sqlalchemy>=1.4
 Requires-Dist: starlette[full]
 Requires-Dist: typing-extensions>=4.0; python_version < '3.8'
 Requires-Dist: wtforms<4,>=3
@@ -83,6 +84,11 @@ $ pip install sqladmin
 
 ---
 
+## Screenshots
+
+<img width="1492" alt="sqladmin-1" src="https://user-images.githubusercontent.com/19784933/208232730-0114a155-2740-4e89-9d73-64a4e51a5cf5.png">
+<img width="1492" alt="sqladmin-2" src="https://user-images.githubusercontent.com/19784933/208232731-6d783dde-b93e-41c0-911b-3d1c3c73f1d5.png">
+
 ## Quickstart
 
 Let's define an example SQLAlchemy model:

{sqladmin-0.8.0 → sqladmin-0.10.0}/README.md

@@ -54,6 +54,11 @@ $ pip install sqladmin
 
 ---
 
+## Screenshots
+
+<img width="1492" alt="sqladmin-1" src="https://user-images.githubusercontent.com/19784933/208232730-0114a155-2740-4e89-9d73-64a4e51a5cf5.png">
+<img width="1492" alt="sqladmin-2" src="https://user-images.githubusercontent.com/19784933/208232731-6d783dde-b93e-41c0-911b-3d1c3c73f1d5.png">
+
 ## Quickstart
 
 Let's define an example SQLAlchemy model:

{sqladmin-0.8.0 → sqladmin-0.10.0}/pyproject.toml

@@ -13,7 +13,7 @@ authors = [
   { name = "Amin Alaee", email = "mohammadamin.alaee@gmail.com" },
 ]
 classifiers = [
-  "Development Status :: 3 - Alpha",
+  "Development Status :: 4 - Beta",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
@@ -29,7 +29,7 @@ classifiers = [
 dependencies = [
   "starlette[full]",
   "typing_extensions>=4.0;python_version < '3.8'",
-  "sqlalchemy >=1.4, <1.5",
+  "sqlalchemy >=1.4",
   "wtforms >=3, <4",
 ]
 dynamic = ["version"]
@@ -53,38 +53,77 @@ exclude = [
   "tests/*",
 ]
 
-[tool.hatch.envs.default]
+[tool.hatch.envs.test]
 dependencies = [
   "aiosqlite==0.17.0",
+  "arrow==1.2.3",
   "asyncpg==0.27.0",
-  "autoflake==1.7.7",
   "babel==2.10.3",
-  "black==22.10.0",
   "build==0.9.0",
+  "colour==0.1.5",
   "coverage==6.5.0",
   "email-validator==1.3.0",
   "greenlet==2.0.0",
   "httpx==0.23.0",
-  "isort==5.10.1",
   "itsdangerous==2.1.2",
+  "phonenumbers==8.13.5",
+  "psycopg2-binary==2.9.5",
+  "pytest==7.2.0",
+  "python-dateutil==2.8.2",
+  "sqlalchemy_utils==0.38.3",
+  "sqlalchemy-fields",
+]
+
+[tool.hatch.envs.lint]
+dependencies = [
+  "black==22.10.0",
+  "isort==5.10.1",
+  "mypy==0.982",
+  "ruff==0.0.237",
+  "sqlalchemy~=1.4", # MyPy issues with SQLAlchemy V2
+]
+
+[tool.hatch.envs.docs]
+dependencies = [
   "mkdocs-material==8.5.7",
   "mkdocs==1.4.1",
   "mkdocstrings==0.18.1",
-  "mypy==0.982",
-  "psycopg2==2.9.5",
-  "pytest==7.2.0",
-  "sqlalchemy_utils==0.38.3",
-  "sqlmodel==0.0.8",
 ]
-[tool.hatch.envs.default.scripts]
-check = "isort --check --project=sqladmin . && black --check . && mypy sqladmin"
-clean = "rm -r dist site"
-cov = "coverage report --show-missing --skip-covered --fail-under=99 && coverage xml"
-docs = "mkdocs serve"
-docs_build = "mkdocs build"
-docs_deploy = "mkdocs gh-deploy --force"
-lint = "autoflake --in-place --recursive .s && isort --project=sqladmin . && black ."
-test = "python -m coverage run --concurrency=thread,greenlet -m pytest"
+
+[tool.hatch.envs.test.scripts]
+cov = [
+  "coverage report --show-missing --skip-covered --fail-under=99",
+  "coverage xml",
+]
+test = "coverage run -a --concurrency=thread,greenlet -m pytest"
+
+[tool.hatch.envs.lint.scripts]
+check = [
+  "ruff .",
+  "isort --check --project=sqladmin .",
+  "black --check .",
+  "mypy sqladmin",
+]
+format = [
+  "isort --project=sqladmin .",
+  "black .",
+  "ruff --fix .",
+]
+
+[tool.hatch.envs.docs.scripts]
+build = "mkdocs build"
+serve = "mkdocs serve --dev-addr localhost:8080"
+deploy = "mkdocs gh-deploy --force"
+
+[[tool.hatch.envs.test.matrix]]
+sqlalchemy = ["1.4", "2.0"]
+
+[tool.hatch.envs.test.overrides]
+matrix.sqlalchemy.dependencies = [
+  { value = "sqlalchemy==1.4.41", if = ["1.4"] },
+  { value = "sqlmodel==0.0.8", if = ["1.4"] },
+  { value = "sqlalchemy==2.0", if = ["2.0"] },
+]
 
 [tool.mypy]
 disallow_untyped_defs = true

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/__init__.py

@@ -1,7 +1,7 @@
 from sqladmin.application import Admin, expose
 from sqladmin.models import BaseView, ModelAdmin, ModelView
 
-__version__ = "0.8.0"
+__version__ = "0.10.0"
 
 __all__ = [
     "Admin",

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/_queries.py

@@ -1,4 +1,3 @@
-from re import L
 from typing import TYPE_CHECKING, Any, Dict, List
 
 import anyio
@@ -7,7 +6,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import Session, joinedload
 from sqlalchemy.sql.expression import Select
 
-from sqladmin._types import MODEL_ATTR_TYPE
+from sqladmin._types import MODEL_PROPERTY
 from sqladmin.helpers import get_column_python_type, get_direction, get_primary_key
 
 if TYPE_CHECKING:
@@ -18,7 +17,7 @@ class Query:
     def __init__(self, model_view: "ModelView") -> None:
         self.model_view = model_view
 
-    def _get_to_many_stmt(self, relation: MODEL_ATTR_TYPE, values: List[Any]) -> Select:
+    def _get_to_many_stmt(self, relation: MODEL_PROPERTY, values: List[Any]) -> Select:
         target = relation.mapper.class_
         target_pk = get_primary_key(target)
         target_pk_type = get_column_python_type(target_pk)
@@ -26,14 +25,14 @@ class Query:
         related_stmt = select(target).where(target_pk.in_(pk_values))
         return related_stmt
 
-    def _get_to_one_stmt(self, relation: MODEL_ATTR_TYPE, value: Any) -> Select:
+    def _get_to_one_stmt(self, relation: MODEL_PROPERTY, value: Any) -> Select:
         target = relation.mapper.class_
         target_pk = get_primary_key(target)
         target_pk_type = get_column_python_type(target_pk)
         related_stmt = select(target).where(target_pk == target_pk_type(value))
         return related_stmt
 
-    def _set_many_to_one(self, obj: Any, relation: MODEL_ATTR_TYPE, value: Any) -> Any:
+    def _set_many_to_one(self, obj: Any, relation: MODEL_PROPERTY, value: Any) -> Any:
         fk = relation.local_remote_pairs[0][0]
         fk_type = get_column_python_type(fk)
         setattr(obj, fk.name, fk_type(value))
@@ -46,7 +45,12 @@ class Query:
 
             if not value:
                 # Set falsy values to None, if column is Nullable
-                if not relation and column.nullable and value is not False:
+                if (
+                    not relation
+                    and column.nullable
+                    and isinstance(value, bool)
+                    and value is not False
+                ):
                     value = None
 
                 setattr(obj, key, value)
@@ -79,7 +83,12 @@ class Query:
 
             if not value:
                 # Set falsy values to None, if column is Nullable
-                if not relation and column.nullable and value is not False:
+                if (
+                    not relation
+                    and column.nullable
+                    and isinstance(value, bool)
+                    and value is not False
+                ):
                     value = None
 
                 setattr(obj, key, value)
@@ -119,8 +128,8 @@ class Query:
         pk = get_column_python_type(self.model_view.pk_column)(pk)
         stmt = select(self.model_view.model).where(self.model_view.pk_column == pk)
 
-        for relation in self.model_view._relations:
-            stmt = stmt.options(joinedload(relation.key))
+        for relation in self.model_view._relation_attrs:
+            stmt = stmt.options(joinedload(relation))
 
         async with self.model_view.sessionmaker(expire_on_commit=False) as session:
             result = await session.execute(stmt)

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/_types.py

@@ -4,5 +4,5 @@ from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncEngine
 from sqlalchemy.orm import ColumnProperty, RelationshipProperty
 
-MODEL_ATTR_TYPE = Union[ColumnProperty, RelationshipProperty]
+MODEL_PROPERTY = Union[ColumnProperty, RelationshipProperty]
 ENGINE_TYPE = Union[Engine, AsyncEngine]

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/_validators.py

@@ -15,6 +15,30 @@ class CurrencyValidator:
             raise ValidationError("Not a valid ISO currency code (e.g. USD, EUR, CNY).")
 
 
+class PhoneNumberValidator:
+    """Form validator for sqlalchemy_utils PhoneNumberType."""
+
+    def __call__(self, form: Form, field: Field) -> None:
+        from sqlalchemy_utils import PhoneNumber, PhoneNumberParseException
+
+        try:
+            PhoneNumber(field.data)
+        except PhoneNumberParseException:
+            raise ValidationError("Not a valid phone number.")
+
+
+class ColorValidator:
+    """General Color validator using `colour` package."""
+
+    def __call__(self, form: Form, field: Field) -> None:
+        from colour import Color
+
+        try:
+            Color(field.data)
+        except ValueError:
+            raise ValidationError('Not a valid color (e.g. "red", "#f00", "#ff0000").')
+
+
 class TimezoneValidator:
     """Form validator for sqlalchemy_utils TimezoneType."""
 

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/ajax.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING, Any, Dict, List
 
-from sqlalchemy import String, cast, inspect, or_, select, text
+from sqlalchemy import String, cast, inspect, or_, select
 
 from sqladmin.helpers import get_primary_key
 

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/application.py

@@ -1,12 +1,22 @@
 import inspect
-from typing import Any, Callable, List, Optional, Sequence, Type, Union, no_type_check
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    Sequence,
+    Type,
+    Union,
+    no_type_check,
+)
 
 from jinja2 import ChoiceLoader, FileSystemLoader, PackageLoader
 from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
 from sqlalchemy.orm import Session, sessionmaker
 from starlette.applications import Starlette
-from starlette.datastructures import FormData
+from starlette.datastructures import URL, FormData, UploadFile
 from starlette.exceptions import HTTPException
 from starlette.middleware import Middleware
 from starlette.requests import Request
@@ -404,7 +414,7 @@ class Admin(BaseAdminView):
 
             await model_view.delete_model(model)
 
-        return Response(content=request.url_for("admin:list", identity=identity))
+        return Response(content=str(request.url_for("admin:list", identity=identity)))
 
     @login_required
     async def create(self, request: Request) -> Response:
@@ -416,7 +426,7 @@ class Admin(BaseAdminView):
         model_view = self._find_model_view(identity)
 
         Form = await model_view.scaffold_form()
-        form_data = await request.form()
+        form_data = await self._handle_form_data(request)
         form = Form(form_data)
 
         context = {
@@ -472,7 +482,7 @@ class Admin(BaseAdminView):
         if request.method == "GET":
             return self.templates.TemplateResponse(model_view.edit_template, context)
 
-        form_data = await request.form()
+        form_data = await self._handle_form_data(request, model)
         form = Form(form_data)
         if not form.validate():
             context["form"] = form
@@ -559,8 +569,11 @@ class Admin(BaseAdminView):
 
     def get_save_redirect_url(
         self, request: Request, form: FormData, model_view: ModelView, obj: Any
-    ) -> str:
-        """Get the redirect URL after a save action is triggered from create/edit page."""
+    ) -> Union[str, URL]:
+        """
+        Get the redirect URL after a save action
+        which is triggered from create/edit page.
+        """
 
         identity = request.path_params["identity"]
         pk = getattr(obj, model_view.pk_column.name)
@@ -573,6 +586,32 @@ class Admin(BaseAdminView):
             return request.url_for("admin:edit", identity=identity, pk=pk)
         return request.url_for("admin:create", identity=identity)
 
+    async def _handle_form_data(self, request: Request, obj: Any = None) -> FormData:
+        """
+        Handle form data and modify in case of UplaodFile.
+        This is needed since in edit page
+        there's no way to show current file of object.
+        """
+
+        form = await request.form()
+        form_data: Dict[str, Any] = {}
+
+        for key, value in form.items():
+            if not isinstance(value, UploadFile):
+                form_data[key] = value
+                continue
+
+            should_clear = form.get(key + "_checkbox")
+            empty_upload = len(await value.read(1)) != 1
+            if should_clear:
+                form_data[key] = None
+            elif empty_upload and getattr(obj, key):
+                f = getattr(obj, key)  # In case of update, imitate UploadFile
+                form_data[key] = UploadFile(filename=f.name, file=f.open())
+            else:
+                form_data[key] = value
+        return FormData(form_data)
+
 
 def expose(
     path: str,

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/authentication.py

@@ -1,10 +1,10 @@
 import functools
-from typing import Any, Callable
+from typing import Any, Callable, Optional
 
 from starlette.middleware import Middleware
 from starlette.middleware.sessions import SessionMiddleware
 from starlette.requests import Request
-from starlette.responses import RedirectResponse
+from starlette.responses import Response
 
 
 class AuthenticationBackend:
@@ -31,10 +31,14 @@ class AuthenticationBackend:
         """
         raise NotImplementedError()
 
-    async def authenticate(self, request: Request) -> bool:
+    async def authenticate(self, request: Request) -> Optional[Response]:
         """Implement authenticate logic here.
         This method will be called for each incoming request
         to validate the authentication.
+
+        If the request is authenticated, this method should return `None` or do nothing.
+        Otherwise it should return a `Response` object,
+        like a redirect to the login page or SSO page.
         """
         raise NotImplementedError()
 
@@ -49,9 +53,9 @@ def login_required(func: Callable[..., Any]) -> Callable[..., Any]:
         admin, request = args[0], args[1]
         auth_backend = admin.authentication_backend
         if auth_backend is not None:
-            is_authenticated = await auth_backend.authenticate(request)
-            if not is_authenticated:
-                return RedirectResponse(request.url_for("admin:login"), status_code=302)
+            response = await auth_backend.authenticate(request)
+            if response and isinstance(response, Response):
+                return response
 
         return await func(*args, **kwargs)
 

{sqladmin-0.8.0 → sqladmin-0.10.0}/sqladmin/fields.py

@@ -3,16 +3,18 @@ import operator
 from typing import Any, Callable, Generator, List, Optional, Set, Tuple, Union
 
 from sqlalchemy import inspect
-from wtforms import Form, SelectFieldBase, ValidationError, fields, widgets
+from wtforms import Form, ValidationError, fields, widgets
 
 from sqladmin import widgets as sqladmin_widgets
 from sqladmin.ajax import QueryAjaxModelLoader
+from sqladmin.helpers import parse_interval
 
 __all__ = [
     "AjaxSelectField",
     "AjaxSelectMultipleField",
     "DateField",
     "DateTimeField",
+    "IntervalField",
     "JSONField",
     "QuerySelectField",
     "QuerySelectMultipleField",
@@ -46,6 +48,22 @@ class TimeField(fields.TimeField):
     widget = sqladmin_widgets.TimePickerWidget()
 
 
+class IntervalField(fields.StringField):
+    """
+    A text field which stores a `datetime.timedelta` object.
+    """
+
+    def process_formdata(self, valuelist: List[str]) -> None:
+        if not valuelist:
+            return
+
+        interval = parse_interval(valuelist[0])
+        if not interval:
+            raise ValueError("Invalide timedelta format.")
+
+        self.data = interval
+
+
 class SelectField(fields.SelectField):
     def __init__(
         self,
@@ -166,7 +184,11 @@ class QuerySelectField(fields.SelectFieldBase):
             yield ("__None", self.blank_text, self.data is None)
 
         if self.data:
-            primary_key = str(inspect(self.data).identity[0])
+            primary_key = (
+                self.data
+                if isinstance(self.data, str)
+                else str(inspect(self.data).identity[0])
+            )
         else:
             primary_key = None
 
@@ -251,7 +273,11 @@ class QuerySelectMultipleField(QuerySelectField):
 
     def iter_choices(self) -> Generator[Tuple[str, Any, bool], None, None]:
         if self.data is not None:
-            primary_keys = [str(inspect(m).identity[0]) for m in self.data]
+            primary_keys = (
+                self.data
+                if all(isinstance(d, str) for d in self.data)
+                else [str(inspect(m).identity[0]) for m in self.data]
+            )
             for pk, label in self._select_data:
                 yield (pk, self.get_label(label), pk in primary_keys)
 
@@ -268,7 +294,7 @@ class QuerySelectMultipleField(QuerySelectField):
                     raise ValidationError(self.gettext("Not a valid choice"))
 
 
-class AjaxSelectField(SelectFieldBase):
+class AjaxSelectField(fields.SelectFieldBase):
     widget = sqladmin_widgets.AjaxSelect2Widget()
     separator = ","
 
@@ -310,7 +336,7 @@ class AjaxSelectField(SelectFieldBase):
             raise ValidationError("Not a valid choice")
 
 
-class AjaxSelectMultipleField(SelectFieldBase):
+class AjaxSelectMultipleField(fields.SelectFieldBase):
     widget = sqladmin_widgets.AjaxSelect2Widget(multiple=True)
     separator = ","
 
@@ -349,3 +375,24 @@ class AjaxSelectMultipleField(SelectFieldBase):
         for field in valuelist:
             for n in field.split(self.separator):
                 self._formdata.add(n)
+
+
+class Select2TagsField(fields.SelectField):
+    widget = sqladmin_widgets.Select2TagsWidget()
+
+    def pre_validate(self, form: Form) -> None:
+        ...
+
+    def process_formdata(self, valuelist: list) -> None:
+        self.data = valuelist
+
+    def process_data(self, value: Optional[list]) -> None:
+        self.data = value or []
+
+
+class FileField(fields.FileField):
+    """
+    File field which is clearable.
+    """
+
+    widget = sqladmin_widgets.FileInputWidget()