Merge pull request #17 from jowilf/odmantic-example

Add null support for EnumField & Add odmantic example

Author: jowilf

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2022-09-20
+
+---
+
+### Fixed
+
+*  Null support for EnumField by @jowilf in https://github.com/jowilf/starlette-admin/pull/17
+
+**Full Changelog**: https://github.com/jowilf/starlette-admin/compare/0.2.1...0.2.2
+
+
 ## [0.2.1] - 2022-09-19
 
 ---

README.md

@@ -20,7 +20,7 @@
 </a>
 </p>
 
-![Starlette-Admin Promo Image](docs/images/promo.png)
+![Starlette-Admin Promo Image](https://github.com/jowilf/starlette-admin/raw/main/docs/images/promo.png)
 
 The key features are:
 

docs/changelog.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2022-09-20
+
+---
+
+### Fixed
+
+*  Null support for EnumField in [#17](https://github.com/jowilf/starlette-admin/pull/17)
+
+
 ## [0.2.1] - 2022-09-19
 
 ---

examples/basic/app.py

@@ -58,7 +58,7 @@ class PostView(BaseModelView):
     sortable_fields = ("id", "title", "content")
     search_builder = False
     page_size = 10
-    page_size_options = [2, -1]
+    page_size_options = [5, 10, -1]
 
     async def count(
         self,

examples/odmantic/README.md

@@ -0,0 +1,30 @@
+This example shows how you can easily extend BaseModelView to use *Starlette-Admin*
+with [odmantic](https://github.com/art049/odmantic)
+
+To run this example:
+
+1. Clone the repository::
+
+```shell
+git clone https://github.com/jowilf/starlette-admin.git
+cd starlette-admin
+```
+
+2. Create and activate a virtual environment::
+
+```shell
+python3 -m venv env
+source env/bin/activate
+```
+
+3. Install requirements
+
+```shell
+pip install -r 'examples/odmantic/requirements.txt'
+```
+
+4. Run the application:
+
+```shell
+uvicorn examples.odmantic.app:app
+```

examples/odmantic/__init__.py

@@ -0,0 +1,116 @@
+from typing import Any, Dict, List, Optional, Union
+
+from bson import ObjectId
+from odmantic import AIOEngine, Field, Model
+from pydantic import ValidationError
+from starlette.applications import Starlette
+from starlette.requests import Request
+from starlette.responses import HTMLResponse
+from starlette.routing import Route
+from starlette_admin import BaseAdmin as Admin
+from starlette_admin import BaseModelView, EnumField, IntegerField, StringField
+from starlette_admin.exceptions import FormValidationError
+
+from examples.odmantic.helpers import build_raw_query
+
+engine = AIOEngine()
+app = Starlette(
+    routes=[
+        Route(
+            "/",
+            lambda r: HTMLResponse('<a href="/admin/">Click me to get to Admin!</a>'),
+        )
+    ]
+)
+
+
+class Author(Model):
+    name: str = Field(min_length=3, max_length=100)
+    age: int = Field(ge=5, lt=150)
+    sex: Optional[str]
+
+
+def build_query(where: Union[Dict[str, Any], str, None] = None) -> Any:
+    if where is None:
+        return {}
+    if isinstance(where, dict):
+        return build_raw_query(where)  # from mongoengine integration
+    else:
+        return Author.name.match(where)
+
+
+def build_order_clauses(order_list: List[str]):
+    clauses = []
+    for value in order_list:
+        key, order = value.strip().split(maxsplit=1)
+        clause = getattr(Author, key)
+        clauses.append(clause.desc() if order.lower() == "desc" else clause)
+    return tuple(clauses) if len(clauses) > 0 else None
+
+
+def pydantic_error_to_form_validation_errors(exc: ValidationError):
+    errors: Dict[str, str] = dict()
+    for pydantic_error in exc.errors():
+        errors[str(pydantic_error["loc"][-1])] = pydantic_error["msg"]
+    return FormValidationError(errors)
+
+
+class AuthorView(BaseModelView):
+    identity = "author"
+    name = "Author"
+    label = "Authors"
+    pk_attr = "id"
+    fields = [
+        StringField("id"),
+        StringField("name"),
+        IntegerField("age"),
+        EnumField.from_choices("sex", [("male", "MALE"), ("female", "FEMALE")]),
+    ]
+
+    async def count(
+        self,
+        request: Request,
+        where: Union[Dict[str, Any], str, None] = None,
+    ) -> int:
+        return await engine.count(Author, build_query(where))
+
+    async def find_all(
+        self,
+        request: Request,
+        skip: int = 0,
+        limit: int = 100,
+        where: Union[Dict[str, Any], str, None] = None,
+        order_by: Optional[List[str]] = None,
+    ) -> List[Any]:
+        return await engine.find(
+            Author,
+            build_query(where),
+            sort=build_order_clauses(order_by),
+            skip=skip,
+            limit=limit,
+        )
+
+    async def find_by_pk(self, request: Request, pk: Any) -> Any:
+        return await engine.find_one(Author, Author.id == ObjectId(pk))
+
+    async def find_by_pks(self, request: Request, pks: List[Any]) -> List[Any]:
+        return await engine.find(Author.id.in_(pks))
+
+    async def create(self, request: Request, data: Dict) -> Any:
+        try:
+            return await engine.save(Author(**data))
+        except ValidationError as exc:
+            raise pydantic_error_to_form_validation_errors(exc)
+
+    async def edit(self, request: Request, pk: Any, data: Dict[str, Any]) -> Any:
+        try:
+            author = await self.find_by_pk(request, pk)
+            author.update(data)
+            return await engine.save(author)
+        except ValidationError as exc:
+            raise pydantic_error_to_form_validation_errors(exc)
+
+
+admin = Admin()
+admin.add_view(AuthorView)
+admin.mount_to(app)

examples/odmantic/app.py

@@ -0,0 +1,40 @@
+from typing import Any, Dict
+
+comparison_map = {
+    "eq": "$eq",
+    "neq": "$ne",
+    "ge": "$gte",
+    "gt": "$gt",
+    "le": "$lte",
+    "lt": "$lt",
+    "in": "$in",
+    "not_in": "$nin",
+}
+
+
+def build_raw_query(dt_query: Dict[str, Any]) -> Dict[str, Any]:
+    raw_query: Dict[str, Any] = dict()
+    for key in dt_query:
+        if key == "or":
+            raw_query["$or"] = [build_raw_query(q) for q in dt_query[key]]
+        elif key == "and":
+            raw_query["$and"] = [build_raw_query(q) for q in dt_query[key]]
+        elif key == "not":
+            raw_query["$not"] = build_raw_query(dt_query[key])
+        elif key == "between":
+            values = dt_query[key]
+            raw_query = {"$gte": values[0], "$lte": values[1]}
+        elif key == "not_between":
+            values = dt_query[key]
+            raw_query = {"$not": {"$gte": values[0], "$lte": values[1]}}
+        elif key == "contains":
+            raw_query = {"$regex": dt_query[key], "$options": "mi"}
+        elif key == "startsWith":
+            raw_query = {"$regex": "^%s" % dt_query[key], "$options": "mi"}
+        elif key == "endsWith":
+            raw_query = {"$regex": "%s$" % dt_query[key], "$options": "mi"}
+        elif key in comparison_map:
+            raw_query[comparison_map[key]] = dt_query[key]
+        else:
+            raw_query[key] = build_raw_query(dt_query[key])
+    return raw_query

examples/odmantic/helpers.py

@@ -0,0 +1,3 @@
+starlette-admin
+odmantic
+uvicorn

examples/odmantic/requirements.txt

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "starlette-admin"
-version = "0.2.1"
+version = "0.2.2"
 description = "Simple and extensible admin interface framework for Starlette/FastApi"
 authors = ["Jocelin Hounon <hounonj@gmail.com>"]
 license = "MIT"
@@ -34,11 +34,11 @@ python-multipart = "*"
 [tool.poetry.dev-dependencies]
 pytest = "^7.1.3"
 sqlmodel = "^0.0.8"
-fastapi = "^0.82.0"
+fastapi = "^0.85.0"
 uvicorn = "^0.18.3"
 PyMySQL = { extras = ["rsa"], version = "^1.0.2" }
 Pillow = "^9.2.0"
-fasteners = "^0.17.3"
+fasteners = "^0.18"
 mongoengine = "^0.24.2"
 black = "^22.6.0"
 isort = "^5.10.1"
@@ -49,15 +49,15 @@ flake8 = "^3.9.2"
 async-asgi-testclient = "^1.4.11"
 pytest-asyncio = "^0.19.0"
 psycopg2-binary = "^2.9.3"
-mkdocs-material = "^8.4.3"
+mkdocs-material = "^8.5.2"
 mkdocstrings = { extras = ["python"], version = "^0.19.0" }
 itsdangerous = "^2.1.2"
-autoflake = "^1.5.3"
+autoflake = "^1.6.0"
 SQLAlchemy = { extras = ["asyncio"], version = "^1.4.41" }
 aiosqlite = "^0.17.0"
 asyncpg = "^0.26.0"
 aiomysql = "^0.1.1"
-beanie = "^1.11.9"
+odmantic = "^0.8.0"
 
 [tool.coverage.report]
 fail_under = 99

pyproject.toml

@@ -1,4 +1,4 @@
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 from starlette_admin.base import BaseAdmin
 from starlette_admin.fields import *

starlette_admin/__init__.py

@@ -285,8 +285,8 @@ async def _render_login(self, request: Request) -> Response:
             try:
                 assert self.auth_provider is not None
                 return await self.auth_provider.login(
-                    form.get("username"),
-                    form.get("password"),
+                    form.get("username"),  # type: ignore
+                    form.get("password"),  # type: ignore
                     form.get("remember_me") == "on",
                     request,
                     RedirectResponse(