fastadmin 0.4.8__tar.gz → 0.5.0__tar.gz

fastadmin-0.5.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: fastadmin
+Version: 0.5.0
+Summary: FastAdmin is an easy-to-use Admin Dashboard App for FastAPI/Flask/Django inspired by Django Admin.
+Keywords: admin,dashboard,fastapi,flask,django,tortoise-orm,sqlalchemy,pony,admin-dashboard,django-admin
+Author: Seva D
+Author-email: Seva D <vsdudakov@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.md
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Django
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Widget Sets
+Classifier: Typing :: Typed
+Requires-Dist: pyjwt>=2.6
+Requires-Dist: asgiref>=3.11
+Requires-Dist: django>=6,<7 ; extra == 'django'
+Requires-Dist: fastapi>=0.100,<1 ; extra == 'fastapi'
+Requires-Dist: python-multipart>=0.0.5,<1 ; extra == 'fastapi'
+Requires-Dist: flask>=3,<4 ; extra == 'flask'
+Requires-Dist: pony>=0.7,<1 ; extra == 'pony'
+Requires-Dist: sqlalchemy[asyncio]>=2,<3 ; extra == 'sqlalchemy'
+Requires-Dist: greenlet>=3 ; extra == 'sqlalchemy'
+Requires-Dist: tortoise-orm>=1,<2 ; extra == 'tortoise-orm'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://vsdudakov.github.io/fastadmin/
+Project-URL: Repository, https://github.com/vsdudakov/fastadmin
+Project-URL: Documentation, https://vsdudakov.github.io/fastadmin/
+Project-URL: Issues, https://github.com/vsdudakov/fastadmin/issues
+Provides-Extra: django
+Provides-Extra: fastapi
+Provides-Extra: flask
+Provides-Extra: pony
+Provides-Extra: sqlalchemy
+Provides-Extra: tortoise-orm
+Description-Content-Type: text/markdown
+
+<h1 align="center">FastAdmin — Admin Dashboard for FastAPI, Flask and Django</h1>
+
+<p align="center">
+  <a href="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml"><img src="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://app.codecov.io/gh/vsdudakov/fastadmin"><img src="https://codecov.io/gh/vsdudakov/fastadmin/branch/main/graph/badge.svg?token=RNGX5HOW3T" alt="codecov"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://badgen.net/pypi/v/fastadmin" alt="PyPI"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://img.shields.io/badge/python-3.12%2B-blue.svg" alt="Python 3.12+"></a>
+  <a href="https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/vsdudakov/fastadmin" alt="License: MIT"></a>
+</p>
+
+**FastAdmin** is an easy-to-use **admin dashboard (admin panel) for FastAPI, Flask and
+Django**, inspired by Django Admin. It gives your Python web application a
+production-ready **CRUD admin interface** in minutes — on top of **Tortoise ORM,
+Django ORM, SQLAlchemy or Pony ORM** — with authentication, filters, search,
+inline editing, file uploads, CSV/JSON export and dashboard charts out of the box.
+
+FastAdmin is built with relationships in mind and admiration for Django Admin.
+It aims to be minimal, functional and familiar: if you know Django Admin, you
+already know FastAdmin.
+
+📚 **Documentation: [https://vsdudakov.github.io/fastadmin/](https://vsdudakov.github.io/fastadmin/)**
+
+## Demo
+
+![FastAdmin demo — admin panel for FastAPI, Flask and Django](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/demo.gif)
+
+## Features
+
+- **Familiar Django-Admin-style API** — `list_display`, `list_filter`,
+  `search_fields`, `fieldsets`, `readonly_fields`, inlines, actions and more.
+- **Any web framework** — mount as a FastAPI sub-app, a Flask blueprint or
+  Django urlpatterns.
+- **Any ORM** — first-class admin classes for Tortoise ORM, Django ORM,
+  SQLAlchemy (async) and Pony ORM.
+- **Authentication & permissions** — pluggable sign-in against your own user
+  model, per-action permission hooks, request/user context in every admin method.
+- **Rich form widgets** — 20+ antd-based widgets (rich text, JSON, async
+  select, phone, slug, date/time pickers, switches, radio groups, …) via
+  `formfield_overrides`.
+- **File & image uploads** — storage-agnostic `upload_file` hook and
+  presigned-URL support via `get_file_url` (local disk, S3, …).
+- **Dashboard widgets** — declarative line/area/column/bar/pie charts and
+  action widgets with filters, powered by antd charts.
+- **Bulk actions & export** — custom bulk actions, CSV/JSON export.
+- **Quality** — fully typed and linted (ruff + ty), 100% backend test coverage,
+  modern React (Vite + antd) frontend bundled with the package — no Node.js
+  needed at install time.
+
+## Installation
+
+Install with the extras matching your web framework and ORM (each combination
+works standalone):
+
+```bash
+pip install fastadmin[fastapi,django]        # FastAPI with Django ORM
+pip install fastadmin[fastapi,tortoise-orm]  # FastAPI with Tortoise ORM
+pip install fastadmin[fastapi,pony]          # FastAPI with Pony ORM
+pip install fastadmin[fastapi,sqlalchemy]    # FastAPI with SQLAlchemy (includes greenlet)
+pip install fastadmin[django]                # Django with Django ORM
+pip install fastadmin[django,pony]           # Django with Pony ORM
+pip install fastadmin[flask,sqlalchemy]      # Flask with SQLAlchemy (includes greenlet)
+```
+
+> **Note:** on zsh (the default macOS shell) quote the extras: `pip install 'fastadmin[fastapi,django]'`.
+
+Configure the required settings:
+
+```bash
+export ADMIN_USER_MODEL=User
+export ADMIN_USER_MODEL_USERNAME_FIELD=username
+export ADMIN_SECRET_KEY=secret_key
+```
+
+## Quick start
+
+```python
+import bcrypt
+from fastapi import FastAPI
+
+from fastadmin import TortoiseModelAdmin, register
+from fastadmin import fastapi_app as admin_app
+
+from models import User
+
+
+@register(User)
+class UserAdmin(TortoiseModelAdmin):
+    exclude = ("hash_password",)
+    list_display = ("id", "username", "is_superuser", "is_active")
+    list_display_links = ("id", "username")
+    list_filter = ("id", "username", "is_superuser", "is_active")
+    search_fields = ("username",)
+
+    async def authenticate(self, username: str, password: str) -> int | None:
+        user = await User.filter(username=username, is_superuser=True).first()
+        if not user:
+            return None
+        if not bcrypt.checkpw(password.encode(), user.hash_password.encode()):
+            return None
+        return user.id
+
+    async def change_password(self, id: int, password: str) -> None:
+        user = await User.filter(id=id).first()
+        if not user:
+            return
+        user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
+        await user.save(update_fields=("hash_password",))
+
+
+app = FastAPI()
+app.mount("/admin", admin_app)
+```
+
+Run `uvicorn example:app` and open `http://localhost:8000/admin`.
+
+Mounting for the other frameworks:
+
+```python
+# Flask
+from fastadmin import flask_app as admin_app
+app.register_blueprint(admin_app, url_prefix="/admin")
+
+# Django (urls.py)
+from fastadmin import get_django_admin_urls as get_admin_urls
+urlpatterns = [path("admin/", get_admin_urls())]
+```
+
+## Documentation
+
+Full documentation lives at
+**[vsdudakov.github.io/fastadmin](https://vsdudakov.github.io/fastadmin/)**:
+
+- [Installation](https://vsdudakov.github.io/fastadmin/getting-started/installation/)
+  and [Quick start](https://vsdudakov.github.io/fastadmin/getting-started/quickstart/)
+- [Settings](https://vsdudakov.github.io/fastadmin/guides/settings/) — all environment variables
+- [Registering models](https://vsdudakov.github.io/fastadmin/guides/registering-models/) — complete runnable examples for all four ORMs
+- [Authentication](https://vsdudakov.github.io/fastadmin/guides/authentication/) and permissions
+- [Model admins](https://vsdudakov.github.io/fastadmin/guides/model-admins/) — attributes, actions, display fields, exports
+- [Form widgets & file uploads](https://vsdudakov.github.io/fastadmin/guides/form-widgets/)
+- [Inline admins](https://vsdudakov.github.io/fastadmin/guides/inline-admins/)
+- [Dashboard widgets](https://vsdudakov.github.io/fastadmin/guides/dashboard-widgets/) — charts and actions
+- [API reference](https://vsdudakov.github.io/fastadmin/api-reference/)
+
+Runnable example apps for every framework/ORM combination are in
+[`examples/`](https://github.com/vsdudakov/fastadmin/tree/main/examples).
+
+## Why FastAdmin?
+
+If you are looking for a **Django-Admin-like admin panel for FastAPI**, an
+**admin interface for SQLAlchemy or Tortoise ORM**, or a lightweight
+**alternative to building a custom back office**, FastAdmin gives you a
+batteries-included, themeable admin UI without code generation, without tying
+your app to a specific framework, and without writing a single React component.
+
+## Contributing
+
+Contributions are welcome — see the
+[contributing guide](https://vsdudakov.github.io/fastadmin/contributing/).
+Development uses `uv` and `make`: `make dev`, `make lint`, `make test`.
+See [CHANGELOG.md](https://github.com/vsdudakov/fastadmin/blob/main/CHANGELOG.md)
+for release history.
+
+If you have questions beyond the documentation, feel free to
+[email us](mailto:vsdudakov@gmail.com).
+
+## License
+
+FastAdmin is released under the
+[MIT License](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md).

fastadmin-0.5.0/README.md

@@ -0,0 +1,169 @@
+<h1 align="center">FastAdmin — Admin Dashboard for FastAPI, Flask and Django</h1>
+
+<p align="center">
+  <a href="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml"><img src="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://app.codecov.io/gh/vsdudakov/fastadmin"><img src="https://codecov.io/gh/vsdudakov/fastadmin/branch/main/graph/badge.svg?token=RNGX5HOW3T" alt="codecov"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://badgen.net/pypi/v/fastadmin" alt="PyPI"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://img.shields.io/badge/python-3.12%2B-blue.svg" alt="Python 3.12+"></a>
+  <a href="https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/vsdudakov/fastadmin" alt="License: MIT"></a>
+</p>
+
+**FastAdmin** is an easy-to-use **admin dashboard (admin panel) for FastAPI, Flask and
+Django**, inspired by Django Admin. It gives your Python web application a
+production-ready **CRUD admin interface** in minutes — on top of **Tortoise ORM,
+Django ORM, SQLAlchemy or Pony ORM** — with authentication, filters, search,
+inline editing, file uploads, CSV/JSON export and dashboard charts out of the box.
+
+FastAdmin is built with relationships in mind and admiration for Django Admin.
+It aims to be minimal, functional and familiar: if you know Django Admin, you
+already know FastAdmin.
+
+📚 **Documentation: [https://vsdudakov.github.io/fastadmin/](https://vsdudakov.github.io/fastadmin/)**
+
+## Demo
+
+![FastAdmin demo — admin panel for FastAPI, Flask and Django](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/demo.gif)
+
+## Features
+
+- **Familiar Django-Admin-style API** — `list_display`, `list_filter`,
+  `search_fields`, `fieldsets`, `readonly_fields`, inlines, actions and more.
+- **Any web framework** — mount as a FastAPI sub-app, a Flask blueprint or
+  Django urlpatterns.
+- **Any ORM** — first-class admin classes for Tortoise ORM, Django ORM,
+  SQLAlchemy (async) and Pony ORM.
+- **Authentication & permissions** — pluggable sign-in against your own user
+  model, per-action permission hooks, request/user context in every admin method.
+- **Rich form widgets** — 20+ antd-based widgets (rich text, JSON, async
+  select, phone, slug, date/time pickers, switches, radio groups, …) via
+  `formfield_overrides`.
+- **File & image uploads** — storage-agnostic `upload_file` hook and
+  presigned-URL support via `get_file_url` (local disk, S3, …).
+- **Dashboard widgets** — declarative line/area/column/bar/pie charts and
+  action widgets with filters, powered by antd charts.
+- **Bulk actions & export** — custom bulk actions, CSV/JSON export.
+- **Quality** — fully typed and linted (ruff + ty), 100% backend test coverage,
+  modern React (Vite + antd) frontend bundled with the package — no Node.js
+  needed at install time.
+
+## Installation
+
+Install with the extras matching your web framework and ORM (each combination
+works standalone):
+
+```bash
+pip install fastadmin[fastapi,django]        # FastAPI with Django ORM
+pip install fastadmin[fastapi,tortoise-orm]  # FastAPI with Tortoise ORM
+pip install fastadmin[fastapi,pony]          # FastAPI with Pony ORM
+pip install fastadmin[fastapi,sqlalchemy]    # FastAPI with SQLAlchemy (includes greenlet)
+pip install fastadmin[django]                # Django with Django ORM
+pip install fastadmin[django,pony]           # Django with Pony ORM
+pip install fastadmin[flask,sqlalchemy]      # Flask with SQLAlchemy (includes greenlet)
+```
+
+> **Note:** on zsh (the default macOS shell) quote the extras: `pip install 'fastadmin[fastapi,django]'`.
+
+Configure the required settings:
+
+```bash
+export ADMIN_USER_MODEL=User
+export ADMIN_USER_MODEL_USERNAME_FIELD=username
+export ADMIN_SECRET_KEY=secret_key
+```
+
+## Quick start
+
+```python
+import bcrypt
+from fastapi import FastAPI
+
+from fastadmin import TortoiseModelAdmin, register
+from fastadmin import fastapi_app as admin_app
+
+from models import User
+
+
+@register(User)
+class UserAdmin(TortoiseModelAdmin):
+    exclude = ("hash_password",)
+    list_display = ("id", "username", "is_superuser", "is_active")
+    list_display_links = ("id", "username")
+    list_filter = ("id", "username", "is_superuser", "is_active")
+    search_fields = ("username",)
+
+    async def authenticate(self, username: str, password: str) -> int | None:
+        user = await User.filter(username=username, is_superuser=True).first()
+        if not user:
+            return None
+        if not bcrypt.checkpw(password.encode(), user.hash_password.encode()):
+            return None
+        return user.id
+
+    async def change_password(self, id: int, password: str) -> None:
+        user = await User.filter(id=id).first()
+        if not user:
+            return
+        user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
+        await user.save(update_fields=("hash_password",))
+
+
+app = FastAPI()
+app.mount("/admin", admin_app)
+```
+
+Run `uvicorn example:app` and open `http://localhost:8000/admin`.
+
+Mounting for the other frameworks:
+
+```python
+# Flask
+from fastadmin import flask_app as admin_app
+app.register_blueprint(admin_app, url_prefix="/admin")
+
+# Django (urls.py)
+from fastadmin import get_django_admin_urls as get_admin_urls
+urlpatterns = [path("admin/", get_admin_urls())]
+```
+
+## Documentation
+
+Full documentation lives at
+**[vsdudakov.github.io/fastadmin](https://vsdudakov.github.io/fastadmin/)**:
+
+- [Installation](https://vsdudakov.github.io/fastadmin/getting-started/installation/)
+  and [Quick start](https://vsdudakov.github.io/fastadmin/getting-started/quickstart/)
+- [Settings](https://vsdudakov.github.io/fastadmin/guides/settings/) — all environment variables
+- [Registering models](https://vsdudakov.github.io/fastadmin/guides/registering-models/) — complete runnable examples for all four ORMs
+- [Authentication](https://vsdudakov.github.io/fastadmin/guides/authentication/) and permissions
+- [Model admins](https://vsdudakov.github.io/fastadmin/guides/model-admins/) — attributes, actions, display fields, exports
+- [Form widgets & file uploads](https://vsdudakov.github.io/fastadmin/guides/form-widgets/)
+- [Inline admins](https://vsdudakov.github.io/fastadmin/guides/inline-admins/)
+- [Dashboard widgets](https://vsdudakov.github.io/fastadmin/guides/dashboard-widgets/) — charts and actions
+- [API reference](https://vsdudakov.github.io/fastadmin/api-reference/)
+
+Runnable example apps for every framework/ORM combination are in
+[`examples/`](https://github.com/vsdudakov/fastadmin/tree/main/examples).
+
+## Why FastAdmin?
+
+If you are looking for a **Django-Admin-like admin panel for FastAPI**, an
+**admin interface for SQLAlchemy or Tortoise ORM**, or a lightweight
+**alternative to building a custom back office**, FastAdmin gives you a
+batteries-included, themeable admin UI without code generation, without tying
+your app to a specific framework, and without writing a single React component.
+
+## Contributing
+
+Contributions are welcome — see the
+[contributing guide](https://vsdudakov.github.io/fastadmin/contributing/).
+Development uses `uv` and `make`: `make dev`, `make lint`, `make test`.
+See [CHANGELOG.md](https://github.com/vsdudakov/fastadmin/blob/main/CHANGELOG.md)
+for release history.
+
+If you have questions beyond the documentation, feel free to
+[email us](mailto:vsdudakov@gmail.com).
+
+## License
+
+FastAdmin is released under the
+[MIT License](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md).

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/api/frameworks/django/app/api.py

@@ -301,12 +301,14 @@ async def upload_file(
             return JsonResponse({"error": "File not found"}, status=400)
         file_name = file.name
         file_content = file.read()
+        obj_id = request.GET.get("id") or None
         file_url = await api_service.upload_file(
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             field_name,
             file_name,
             file_content,
+            id=obj_id,
             request=request,
         )
         return JsonResponse(file_url, safe=False)
@@ -315,7 +317,7 @@ async def upload_file(
 
 
 @csrf_exempt
-async def export(request: HttpRequest, model: str) -> JsonResponse:
+async def export(request: HttpRequest, model: str) -> JsonResponse | StreamingHttpResponse:
     """This method is used to export a list of objects.
 
     :params request: a request object.

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/api/frameworks/fastapi/api.py

@@ -244,6 +244,7 @@ async def upload_file(
     model: str,
     field_name: str,
     file: UploadFile,
+    id: str | None = None,
 ) -> str:
     """This method is used to upload files.
 
@@ -251,6 +252,7 @@ async def upload_file(
     :params model: a name of model.
     :params field_name: a name of field.
     :params file: a file object.
+    :params id: an optional id of an existing object (change page). None on the add page.
     :return: A file url.
     """
     try:
@@ -264,6 +266,7 @@ async def upload_file(
             field_name,
             file_name,
             file_content,
+            id=id,
             request=request,
         )
     except AdminApiException as e:
@@ -304,7 +307,7 @@ async def export(
         )
         headers = {"Content-Disposition": f'attachment; filename="{file_name}"'}
         return StreamingResponse(
-            stream,  # type: ignore [arg-type]
+            stream,  # ty: ignore[invalid-argument-type]
             headers=headers,
             media_type=content_type,
         )

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/api/frameworks/flask/api.py

@@ -188,7 +188,7 @@ async def add(model: str) -> dict:
         raise http_exception from e
 
 
-@api_router.route("/change-password/<string:id>", methods=["PATCH"])  # type: ignore [type-var]
+@api_router.route("/change-password/<string:id>", methods=["PATCH"])  # ty: ignore[invalid-argument-type]
 async def change_password(id: UUID | int | str) -> UUID | int | str:
     """This method is used to change password.
 
@@ -267,12 +267,14 @@ async def upload_file(
             http_exception.code = 422
             raise http_exception from None
         file_content = file.read()
+        obj_id = request.args.get("id") or None
         return await api_service.upload_file(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             field_name,
             file_name,
             file_content,
+            id=obj_id,
             request=request,
         )
     except AdminApiException as e:
@@ -320,7 +322,7 @@ async def export(model: str) -> Response:
         raise http_exception from e
 
 
-@api_router.route("/delete/<string:model>/<string:id>", methods=["DELETE"])  # type: ignore [type-var]
+@api_router.route("/delete/<string:model>/<string:id>", methods=["DELETE"])  # ty: ignore[invalid-argument-type]
 async def delete(
     model: str,
     id: UUID | int | str,

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/api/service.py

@@ -1,7 +1,7 @@
 import inspect
 import logging
 from collections.abc import Sequence
-from datetime import datetime, timedelta, timezone
+from datetime import UTC, datetime, timedelta
 from io import BytesIO, StringIO
 from typing import Any, cast
 from uuid import UUID
@@ -68,7 +68,7 @@ async def get_user_id_from_session_id(session_id: str | None) -> UUID | int | No
     if not session_expired_at:
         return None
 
-    if datetime.fromisoformat(session_expired_at).replace(tzinfo=timezone.utc) < datetime.now(timezone.utc):
+    if datetime.fromisoformat(session_expired_at).replace(tzinfo=UTC) < datetime.now(UTC):
         return None
 
     user_id = token_payload.get("user_id")
@@ -125,7 +125,7 @@ class ApiService:
         if not user_id or not isinstance(user_id, int | UUID):
             raise AdminApiException(401, detail="Invalid credentials.")
 
-        now = datetime.now(timezone.utc)
+        now = datetime.now(UTC)
         session_expired_at = now + timedelta(seconds=settings.ADMIN_SESSION_EXPIRED_AT)
         if isinstance(user_id, UUID):
             user_id = str(user_id)
@@ -254,7 +254,7 @@ class ApiService:
             raise AdminApiException(404, detail=f"{model} model is not registered.")
         self._bind_admin_context(admin_model, request=request, user=current_user)
         try:
-            return await admin_model.save_model(None, payload)  # type: ignore [return-value]
+            return await admin_model.save_model(None, payload)  # ty: ignore[invalid-return-type]
         except Exception as e:
             logger.error("Error adding %s: %s", model, e)
             raise AdminApiException(500, detail=f"Error adding {model}: {e}") from e
@@ -329,6 +329,7 @@ class ApiService:
         field_name: str,
         file_name: str,
         file_content: bytes,
+        id: UUID | int | str | None = None,
         request: Any | None = None,
     ) -> str:
         _current_user_id, current_user = await self._get_authenticated_user(session_id)
@@ -339,16 +340,23 @@ class ApiService:
         self._bind_admin_context(admin_model, request=request, user=current_user)
 
         try:
+            obj = await admin_model.orm_get_obj(id) if id is not None else None
+            if id is not None and obj is None:
+                raise AdminApiException(404, detail=f"{model} with id {id} not found.")
+
             if inspect.iscoroutinefunction(admin_model.upload_file):
                 upload_file_fn = admin_model.upload_file
             else:
                 upload_file_fn = sync_to_async(admin_model.upload_file)  # type: ignore [arg-type]
 
-            return await upload_file_fn(
+            return await upload_file_fn(  # ty: ignore[invalid-return-type]
                 field_name,
                 file_name,
                 file_content,
+                obj=obj,
             )
+        except AdminApiException:
+            raise
         except Exception as e:
             raise AdminApiException(500, detail=f"Error uploading file for {model}: {e}") from e
 

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/models/base.py

@@ -14,6 +14,8 @@ from asgiref.sync import sync_to_async
 from fastadmin.api.schemas import ExportFormat
 from fastadmin.models.schemas import ModelFieldWidgetSchema, WidgetType
 
+Model = Any
+
 
 class BaseModelAdmin:
     """Base class for model admin"""
@@ -373,7 +375,7 @@ class BaseModelAdmin:
         return sort_by
 
     async def serialize_obj_attributes(
-        self, obj: Any, attributes_to_serizalize: list[ModelFieldWidgetSchema]
+        self, obj: Any, attributes_to_serizalize: list[ModelFieldWidgetSchema], list_view: bool = False
     ) -> dict[str, Any]:
         """Serialize orm model obj attribute to dict.
 
@@ -388,7 +390,10 @@ class BaseModelAdmin:
                 # Avoid scientific notation for Decimal values in API responses,
                 # e.g. 3.75E+3 -> "3750"
                 value = format(value, "f")
+
             serialized_dict[field.name] = value
+            if not list_view and field.form_widget_type in (WidgetType.UploadFile, WidgetType.UploadImage) and value:
+                serialized_dict[f"{field.name}__url"] = await self.get_file_url(field.name, value, obj)
         if inspect.iscoroutinefunction(obj.__str__):
             str_fn = obj.__str__
         else:
@@ -435,7 +440,7 @@ class BaseModelAdmin:
             else:
                 attributes_to_serizalize.append(field)
 
-        obj_dict.update(await self.serialize_obj_attributes(obj, attributes_to_serizalize))
+        obj_dict.update(await self.serialize_obj_attributes(obj, attributes_to_serizalize, list_view=list_view))
 
         for field_name in fields_for_serialize:
             display_field_function = getattr(self, field_name, None)
@@ -464,6 +469,7 @@ class BaseModelAdmin:
                 return datetime.datetime.fromisoformat(value).date()
             case WidgetType.DateTimePicker:
                 return datetime.datetime.fromisoformat(value)
+
             case _:
                 return value
 
@@ -541,17 +547,51 @@ class BaseModelAdmin:
         """
         await self.orm_delete_obj(id)
 
+    async def get_file_url(self, field_name: str, value: str, obj: Any | None = None) -> str:
+        """Return the display URL for an uploaded file field.
+
+        Called during serialization for every ``UploadFile`` and ``UploadImage``
+        field that has a non-empty stored value.  The result is emitted alongside
+        the stored value as ``{field_name}__url`` and forwarded to the upload
+        widget as ``valueRepr`` so the clickable link can differ from the raw
+        stored key (e.g. an S3 presigned URL instead of an ``s3://`` URI).
+
+        The stored ``value`` is never modified — it is still what the form
+        submits on save — so there is no risk of data corruption.
+
+        Override to return a dynamic URL.  Example using aiobotocore:
+
+        .. code-block:: python
+
+            async def get_file_url(self, field_name: str, value: str, obj=None) -> str:
+                bucket, key = value.replace("s3://", "").split("/", 1)
+                async with aiobotocore.session.get_session().create_client("s3") as s3:
+                    return await s3.generate_presigned_url(
+                        "get_object",
+                        Params={"Bucket": bucket, "Key": key},
+                        ExpiresIn=3600,
+                    )
+
+        :params field_name: name of the upload field being serialized.
+        :params value: raw stored value (e.g. ``"s3://bucket/key"`` or ``"/media/file.pdf"``).
+        :params obj: the orm/db model instance being serialized, or None.
+        :return: URL string to expose to the frontend for display/download.
+        """
+        return value
+
     async def upload_file(
         self,
         field_name: str,
         file_name: str,
         file_content: bytes,
+        obj: Any | None = None,
     ) -> str:
         """This method is used to upload files.
 
         :params field_name: a name of field.
         :params file_name: a name of file.
         :params file_content: a content of file.
+        :params obj: an orm/db model object. None on the add (create) page; the existing model instance on the change (edit) page.
         :return: A file url.
         """
         raise NotImplementedError
@@ -597,11 +637,11 @@ class BaseModelAdmin:
             case ExportFormat.JSON:
 
                 class JSONEncoder(json.JSONEncoder):
-                    def default(self, obj):
+                    def default(self, o):
                         try:
-                            return super().default(obj)
+                            return super().default(o)
                         except TypeError:
-                            return str(obj)
+                            return str(o)
 
                 output = StringIO()
                 json.dump([await self.serialize_obj(obj, list_view=True) for obj in objs], output, cls=JSONEncoder)

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/models/decorators.py

@@ -200,7 +200,7 @@ def register(*orm_model_classes, **kwargs):
         if not issubclass(model_admin_cls, ModelAdmin):
             raise ValueError("Wrapped class must subclass ModelAdmin.")
 
-        register_admin_model_class(model_admin_cls, orm_model_classes, **kwargs)
+        register_admin_model_class(model_admin_cls, list(orm_model_classes), **kwargs)
 
         return model_admin_cls
 

{fastadmin-0.4.8 → fastadmin-0.5.0}/fastadmin/models/helpers.py

@@ -284,7 +284,7 @@ async def generate_models_schema(
                     save_as=admin_model_obj.save_as,
                     save_as_continue=admin_model_obj.save_as_continue,
                     view_on_site=admin_model_obj.view_on_site,
-                    inlines=await generate_models_schema(
+                    inlines=await generate_models_schema(  # ty: ignore[invalid-argument-type]
                         {inline.model: inline(inline.model) for inline in admin_model_obj.inlines},
                         user=user,
                         request=request,