Add thumbnail_size property to ImageField

jowilf · jowilf · commit ce9a13ae81d5 · 2022-08-23T13:59:41.000+01:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 
 **SQLAlchemy-file** is a [SQLAlchemy](https://www.sqlalchemy.org/) extension for attaching files to SQLAlchemy model and
-uploading them to various storage such as Amazon S3, Rackspace CloudFiles, Google Storage and others
+uploading them to various storage such as Local Storage, Amazon S3, Rackspace CloudFiles, Google Storage and others
 using [Apache Libcloud](https://github.com/apache/libcloud).
 
 <p align="center">
@@ -123,7 +123,9 @@ with Session(engine) as session:
 
 ## Related projects and inspirations
 
-* [Depot: ](https://github.com/amol-/depot) When I was looking for a library like this, depot was the
-best I saw. But it offers less storage backend, doesn't support multiple files and doesn't work with 
-[SQLModel](https://github.com/tiangolo/sqlmodel). This project inspired **SQLAlchemy-file** extensively
+* [filedepot: ](https://github.com/amol-/depot) When I was looking for a library like this, depot was the
+best I saw. This project inspired **SQLAlchemy-file** extensively
 and some features are implemented the same.
+* [sqlalchemy-media](https://github.com/pylover/sqlalchemy-media) Another attachment extension for SqlAlchemy 
+to manage assets which are associated with database models
+
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,7 @@
 # Overview
 
 **SQLAlchemy-file** is a [SQLAlchemy](https://www.sqlalchemy.org/) extension for attaching files to SQLAlchemy model and
-uploading them to various storage such as Amazon S3, Rackspace CloudFiles, Google Storage and others
+uploading them to various storage such as Local Storage, Amazon S3, Rackspace CloudFiles, Google Storage and others
 using [Apache Libcloud](https://github.com/apache/libcloud).
 
 <p align="center">
@@ -122,7 +122,8 @@ with Session(engine) as session:
 
 ## Related projects and inspirations
 
-* [Depot: ](https://github.com/amol-/depot) When I was looking for a library like this, depot was the
-best I saw. But it offers less storage backend, doesn't support multiple files and doesn't work with 
-[SQLModel](https://github.com/tiangolo/sqlmodel). This project inspired **SQLAlchemy-file** extensively
+* [filedepot: ](https://github.com/amol-/depot) When I was looking for a library like this, depot was the
+best I saw. This project inspired **SQLAlchemy-file** extensively
 and some features are implemented the same.
+* [sqlalchemy-media](https://github.com/pylover/sqlalchemy-media) Another attachment extension for SqlAlchemy 
+to manage assets which are associated with database models
diff --git a/docs/tutorial/using-files-in-models.md b/docs/tutorial/using-files-in-models.md
@@ -29,16 +29,17 @@ You can use two Column type in your model.
 
 Inherits all attributes and methods from [FileField][sqlalchemy_file.types.FileField], but also validates that the
 uploaded file is a valid image.
-!!! info
+!!! note
     Using [ImageField][sqlalchemy_file.types.ImageField] is like
     using  [FileField][sqlalchemy_file.types.FileField]
-    with [ImageValidator][sqlalchemy_file.validators.ImageValidator] 
+    with [ImageValidator][sqlalchemy_file.validators.ImageValidator] and
+    [ThumbnailGenerator][sqlalchemy_file.processors.ThumbnailGenerator]
+    
 
 !!! example
     ```Python
     from sqlalchemy import Column, Integer, String
     from sqlalchemy.ext.declarative import declarative_base
-    
     from sqlalchemy_file import ImageField
     
     Base = declarative_base()
@@ -49,7 +50,7 @@ uploaded file is a valid image.
     
         id = Column(Integer, autoincrement=True, primary_key=True)
         title = Column(String(100), unique=True)
-        cover = Column(ImageField)
+        cover = Column(ImageField(thumbnail_size=(128, 128)))
     ```
 ## Uploaded Files Information
 Whenever a supported object is assigned to a [FileField][sqlalchemy_file.types.FileField] or [ImageField][sqlalchemy_file.types.ImageField]
diff --git a/docs_src/tutorial/using-files-in-models/002_imagefield_example.py b/docs_src/tutorial/using-files-in-models/002_imagefield_example.py
@@ -10,4 +10,4 @@ class Book(Base):
 
     id = Column(Integer, autoincrement=True, primary_key=True)
     title = Column(String(100), unique=True)
-    cover = Column(ImageField)
+    cover = Column(ImageField(thumbnail_size=(128, 128)))
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: SQLAlchemy File
-site_description: SQLAlchemy-file is a SQLAlchemy extension for attaching files to SQLAlchemy model and uploading them to various storage such as Amazon S3, Rackspace CloudFiles, Google Storage and others using Apache Libcloud.
+site_description: SQLAlchemy-file is a SQLAlchemy extension for attaching files to SQLAlchemy model and uploading them to various storage such as Local Storage Amazon S3, Rackspace CloudFiles, Google Storage and others using Apache Libcloud.
 site_url: https://jowilf.github.io/sqlalchemy-file
 repo_name: jowilf/sqlalchemy-file
 repo_url: https://github.com/jowilf/sqlalchemy-file
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sqlalchemy-file"
-version = "0.1.2"
+version = "0.1.3"
 description = "SQLAlchemy-file is a SQLAlchemy extension for attaching files to SQLAlchemy model and uploading them to various storage."
 authors = ["Jocelin Hounon <hounonj@gmail.com>"]
 license = "MIT"
@@ -38,7 +38,6 @@ fasteners = "^0.17.3"
 black = "^22.6.0"
 coverage = { extras = ["toml"], version = "^6.4.2" }
 flake8 = "^5.0.4"
-flake8-bugbear = "^22.7.1"
 mypy = "^0.971"
 isort = "^5.10.1"
 mkdocs-material = "^8.2.7"
diff --git a/sqlalchemy_file/__init__.py b/sqlalchemy_file/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "0.1.3"
 
 from .file import File as File
 from .types import FileField as FileField
diff --git a/sqlalchemy_file/helpers.py b/sqlalchemy_file/helpers.py
@@ -9,6 +9,7 @@
 INMEMORY_FILESIZE = 1024 * 1024
 LOCAL_STORAGE_DRIVER_NAME = "Local Storage"
 
+
 def get_metadata_file_obj(metadata: Dict[str, Any]) -> "SpooledTemporaryFile[bytes]":
     f = SpooledTemporaryFile(INMEMORY_FILESIZE)
     f.write(json.dumps(metadata).encode())
diff --git a/sqlalchemy_file/storage.py b/sqlalchemy_file/storage.py
@@ -2,7 +2,7 @@
 
 from libcloud.storage.base import Container
 from libcloud.storage.types import ObjectDoesNotExistError
-from sqlalchemy_file.helpers import get_metadata_file_obj, LOCAL_STORAGE_DRIVER_NAME
+from sqlalchemy_file.helpers import LOCAL_STORAGE_DRIVER_NAME, get_metadata_file_obj
 from sqlalchemy_file.stored_file import StoredFile
 
 
diff --git a/sqlalchemy_file/stored_file.py b/sqlalchemy_file/stored_file.py
@@ -4,7 +4,6 @@
 
 from libcloud.storage.base import Object
 from libcloud.storage.types import ObjectDoesNotExistError
-
 from sqlalchemy_file.helpers import LOCAL_STORAGE_DRIVER_NAME
 
 
@@ -32,7 +31,7 @@ def get_cdn_url(self) -> Optional[str]:
             return None
 
     def read(self, n: int = -1) -> bytes:
-        if self.object.driver == LOCAL_STORAGE_DRIVER_NAME:
+        if self.object.driver.name == LOCAL_STORAGE_DRIVER_NAME:
             return open(self.object.get_cdn_url(), "rb").read(n)
         _file = tempfile.NamedTemporaryFile()
         self.object.download(_file.name, overwrite_existing=True)
diff --git a/sqlalchemy_file/types.py b/sqlalchemy_file/types.py
@@ -6,12 +6,12 @@
 from sqlalchemy.orm.attributes import get_history
 from sqlalchemy_file.file import File
 from sqlalchemy_file.mutable_list import MutableList
-from sqlalchemy_file.processors import Processor
+from sqlalchemy_file.processors import Processor, ThumbnailGenerator
 from sqlalchemy_file.storage import StorageManager
 from sqlalchemy_file.validators import ImageValidator, Validator
 
 
-class FileField(types.TypeDecorator):  # type: ignore
+class FileField(types.TypeDecorator):
 
     """
     Provides support for storing attachments to **SQLAlchemy** models.
@@ -107,6 +107,7 @@ def __init__(
         self,
         *args: Tuple[Any],
         upload_storage: Optional[str] = None,
+        thumbnail_size: Optional[Tuple[int, int]] = None,
         image_validator: Optional[ImageValidator] = None,
         validators: Optional[List[Validator]] = None,
         processors: Optional[List[Processor]] = None,
@@ -119,6 +120,9 @@ def __init__(
             upload_storage: storage to use
             image_validator: ImageField use default image
                   validator, Use this property to customize it.
+            thumbnail_size: If set, a thumbnail will be generated
+                from original image using [ThumbnailGenerator]
+                [sqlalchemy_file.processors.ThumbnailGenerator]
             validators: List of additional validators to apply
             processors: List of validators to apply
             upload_type: File class to use, could be
@@ -129,8 +133,11 @@ def __init__(
             validators = []
         if image_validator is None:
             image_validator = ImageValidator()
-        assert isinstance(image_validator, ImageValidator)
-        validators.insert(0, image_validator)
+        if thumbnail_size is not None:
+            if processors is None:
+                processors = []
+            processors.append(ThumbnailGenerator(thumbnail_size))
+        validators.append(image_validator)
         super().__init__(
             *args,
             upload_storage=upload_storage,
diff --git a/tests/test_processor.py b/tests/test_processor.py
@@ -4,7 +4,6 @@
 import pytest
 from sqlalchemy import Column, Integer, String, select
 from sqlalchemy.orm import Session, declarative_base
-from sqlalchemy_file.processors import ThumbnailGenerator
 from sqlalchemy_file.storage import StorageManager
 from sqlalchemy_file.types import ImageField
 
@@ -36,7 +35,9 @@ class Book(Base):
 
     id = Column(Integer, autoincrement=True, primary_key=True)
     title = Column(String(100), unique=True)
-    cover = Column(ImageField(processors=[ThumbnailGenerator()]))
+    cover = Column(
+        ImageField(thumbnail_size=(128, 128))
+    )  # will add thumbnail generator
 
     def __repr__(self):
         return "<Book: id %s ; name: %s; cover %s;>" % (

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = "0.1.0"`
	`1`	`+__version__ = "0.1.3"`
`2`	`2`
`3`	`3`	`from .file import File as File`
`4`	`4`	`from .types import FileField as FileField`