Fix upload file functionality. Fix examples.

Author: vsdudakov

README.md

@@ -504,7 +504,7 @@ class UserAdmin(TortoiseModelAdmin):
         user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
         await user.save(update_fields=("hash_password",))
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -529,8 +529,6 @@ class UserAdmin(TortoiseModelAdmin):
 
 
 ```python
-import typing as tp
-
 from django.db import models
 
 from fastadmin import DjangoModelAdmin, register
@@ -563,7 +561,7 @@ class UserAdmin(DjangoModelAdmin):
             return None
         return obj.id
 
-    def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
+    def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -588,7 +586,6 @@ class UserAdmin(DjangoModelAdmin):
 
 
 ```python
-import typing as tp
 import uuid
 
 import bcrypt
@@ -654,7 +651,7 @@ class UserAdmin(SqlAlchemyModelAdmin):
             await session.execute(query)
             await session.commit()
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -679,7 +676,6 @@ class UserAdmin(SqlAlchemyModelAdmin):
 
 
 ```python
-import typing as tp
 import uuid
 
 import bcrypt
@@ -733,7 +729,7 @@ class UserAdmin(PonyORMModelAdmin):
         obj.hash_password = hash_password
         commit()
 
-    def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
+    def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 

docs/build.py

@@ -42,6 +42,12 @@ def read_cls_docstring(cls):
 
 def get_versions():
     return [
+        {
+            "version": "0.4.1",
+            "changes": [
+                "Fix upload file functionality. Fix examples.",
+            ],
+        },
         {
             "version": "0.4.0",
             "changes": [

docs/code/models/tortoise.py

@@ -1,4 +1,3 @@
-import typing as tp
 from uuid import UUID
 
 import bcrypt
@@ -77,9 +76,7 @@ async def activate(self, ids: list[int]) -> None:
     async def deactivate(self, ids: list[int]) -> None:
         await self.model_cls.filter(id__in=ids).update(is_active=False)
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         url = f"/media/{file_name}"
-        setattr(obj, field_name, url)
-        await obj.save(update_fields=(field_name,))
         return url

docs/code/quick_tutorial/djangoorm.py

@@ -1,5 +1,3 @@
-import typing as tp
-
 from django.db import models
 
 from fastadmin import DjangoModelAdmin, register
@@ -32,6 +30,6 @@ def authenticate(self, username, password):
             return None
         return obj.id
 
-    def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
+    def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"

docs/code/quick_tutorial/ponyorm.py

@@ -1,4 +1,3 @@
-import typing as tp
 import uuid
 
 import bcrypt
@@ -52,6 +51,6 @@ def change_password(self, id: uuid.UUID | int, password: str) -> None:
         obj.hash_password = hash_password
         commit()
 
-    def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
+    def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"

docs/code/quick_tutorial/sqlalchemy.py

@@ -1,4 +1,3 @@
-import typing as tp
 import uuid
 
 import bcrypt
@@ -64,6 +63,6 @@ async def change_password(self, id: uuid.UUID | int | str, password: str) -> Non
             await session.execute(query)
             await session.commit()
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"

docs/code/quick_tutorial/tortoise.py

@@ -53,6 +53,6 @@ async def change_password(self, id: UUID | int | str, password: str) -> None:
         user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
         await user.save(update_fields=("hash_password",))
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"

docs/index.html

@@ -196,6 +196,10 @@ <h4 class="title">FastAdmin</h4>
 
               <ul class="nav flex-column">
 
+                <li class="nav-item">
+                  <a class="nav-link" href="#v0_4_1">v0.4.1</a>
+                </li>
+                
                 <li class="nav-item">
                   <a class="nav-link" href="#v0_4_0">v0.4.0</a>
                 </li>
@@ -355,7 +359,7 @@ <h1>FastAdmin | Documentation</h1>
               <div class="row">
                 <div class="col-sm-6 col-lg-4">
                   <ul class="list-unstyled">
-                    <li><strong>Version:</strong> 0.4.0</li>
+                    <li><strong>Version:</strong> 0.4.1</li>
                     <li>
                       <strong>Author:</strong>
                       <a href="mailto:vsdudakov@gmail.com" target="_blank">
@@ -953,7 +957,7 @@ <h3>Quick Tutorial</h3>
         user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
         await user.save(update_fields=("hash_password",))
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -980,8 +984,6 @@ <h3>Quick Tutorial</h3>
 
 <pre>
   <code class="language-python">
-import typing as tp
-
 from django.db import models
 
 from fastadmin import DjangoModelAdmin, register
@@ -1014,7 +1016,7 @@ <h3>Quick Tutorial</h3>
             return None
         return obj.id
 
-    def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
+    def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -1041,7 +1043,6 @@ <h3>Quick Tutorial</h3>
 
 <pre>
   <code class="language-python">
-import typing as tp
 import uuid
 
 import bcrypt
@@ -1107,7 +1108,7 @@ <h3>Quick Tutorial</h3>
             await session.execute(query)
             await session.commit()
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -1134,7 +1135,6 @@ <h3>Quick Tutorial</h3>
 
 <pre>
   <code class="language-python">
-import typing as tp
 import uuid
 
 import bcrypt
@@ -1188,7 +1188,7 @@ <h3>Quick Tutorial</h3>
         obj.hash_password = hash_password
         commit()
 
-    def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
+    def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:  # type: ignore[override]
         # save file to media directory or s3/filestorage, then return the file url
         return f"/media/{file_name}"
 
@@ -1883,7 +1883,6 @@ <h3>Registering Models</h3>
 
 <pre>
   <code class="language-python">
-import typing as tp
 from uuid import UUID
 
 import bcrypt
@@ -1962,11 +1961,9 @@ <h3>Registering Models</h3>
     async def deactivate(self, ids: list[int]) -> None:
         await self.model_cls.filter(id__in=ids).update(is_active=False)
 
-    async def upload_file(self, obj: tp.Any, field_name: str, file_name: str, file_content: bytes) -> str:
+    async def upload_file(self, field_name: str, file_name: str, file_content: bytes) -> str:
         # save file to media directory or s3/filestorage, then return the file url
         url = f"/media/{file_name}"
-        setattr(obj, field_name, url)
-        await obj.save(update_fields=(field_name,))
         return url
 
   </code>
@@ -2628,14 +2625,12 @@ <h3>Methods and Attributes</h3>
 
     async def upload_file(
         self,
-        obj: Any,
         field_name: str,
         file_name: str,
         file_content: bytes,
     ) -> str:
         """This method is used to upload files.
 
-        :params obj: an object.
         :params field_name: a name of field.
         :params file_name: a name of file.
         :params file_content: a content of file.
@@ -3402,6 +3397,31 @@ <h2>Changelog</h2>
 
 
 
+                <section id="v0_4_1">
+                <h3>v0.4.1</h3>
+
+                
+                  
+<p class="text-4">
+  Fix upload file functionality. Fix examples.
+</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+                
+                </section>
+
+              
                 <section id="v0_4_0">
                 <h3>v0.4.0</h3>
 

examples/django_djangoorm/orm/models.py

@@ -1,4 +1,3 @@
-import typing as tp
 import uuid
 
 from django.db import models
@@ -110,7 +109,6 @@ def change_password(self, id: uuid.UUID | int, password: str) -> None:
 
     def upload_file(
         self,
-        obj: tp.Any,
         field_name: str,
         file_name: str,
         file_content: bytes,

examples/fastapi_ponyorm/example.py

@@ -1,5 +1,4 @@
 import os
-import typing as tp
 import uuid
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
@@ -61,7 +60,6 @@ def change_password(self, id: uuid.UUID | int, password: str) -> None:
 
     def upload_file(
         self,
-        obj: tp.Any,
         field_name: str,
         file_name: str,
         file_content: bytes,