The WandAnalyzer class has been removed, some documentation is also updated, #112, #113

Author: pylover

setup.py

@@ -11,6 +11,7 @@
 
 dependencies = [
     'sqlalchemy >= 1.1.0b3',
+    'pillow',
 ]
 
 

sqlalchemy_media/__init__.py

@@ -7,8 +7,7 @@
     StreamCloserDescriptor, LocalFileSystemDescriptor, UrlDescriptor, \
     CgiFieldStorageDescriptor, AttachableDescriptor
 from .processors import Processor, ImageProcessor, Analyzer, MagicAnalyzer, \
-    WandAnalyzer, Validator, ContentTypeValidator, ImageValidator, \
-    ImageAnalyzer
+    Validator, ContentTypeValidator, ImageValidator, ImageAnalyzer
 
 
 __version__ = '0.16.0'

sqlalchemy_media/exceptions.py

@@ -97,7 +97,6 @@ class OptionalPackageRequirementError(SqlAlchemyMediaException):
 
     __optional_packages__ = [
         'python-magic >= 0.4.12',
-        'wand >= 0.4.3',
         'requests-aws4auth >= 0.9',
         'requests-aliyun >= 0.2.5'
     ]

sqlalchemy_media/optionals.py

@@ -40,26 +40,6 @@ def magic_mime_from_buffer(buffer: bytes) -> str:
     return magic.from_buffer(buffer, mime=True)
 
 
-# wand image
-
-try:
-    import wand
-except ImportError:  # pragma: no cover
-    wand = None
-
-
-def ensure_wand():
-    """
-
-    .. warning:: :exc:`.OptionalPackageRequirementError` will be raised if
-                 ``wand`` is not installed.
-
-    """
-
-    if wand is None:  # pragma: no cover
-        raise OptionalPackageRequirementError('wand')
-
-
 # requests-aws4auth
 try:
     from requests_aws4auth import AWS4Auth

sqlalchemy_media/processors.py

@@ -8,7 +8,7 @@
     AspectRatioValidationError, AnalyzeError
 from .helpers import validate_width_height_ratio, deprecated
 from .mimetypes_ import guess_extension, guess_type
-from .optionals import magic_mime_from_buffer, ensure_wand
+from .optionals import magic_mime_from_buffer
 from .typing_ import Dimension
 
 
@@ -95,89 +95,6 @@ def process(self, descriptor: StreamDescriptor, context: dict):
         )
 
 
-@deprecated
-class WandAnalyzer(Analyzer):
-    """
-    .. deprecated:: 0.16
-
-    .. versionadded:: 0.4
-
-    .. versionchanged:: 0.5
-
-       - Inherited from :class:`.Analyzer`
-       - The ``analyze`` method renamed to ``process`` to override the parent
-         method.
-
-    Analyze an image using ``wand``.
-
-    .. warning:: Installing ``wand`` is required for using this class.
-                 otherwise, an :exc:`.OptionalPackageRequirementError` will be
-                 raised.
-
-    Use it as follow
-
-    ..  testcode::
-
-        from sqlalchemy import TypeDecorator, Unicode, Column, Integer
-        from sqlalchemy.ext.declarative import declarative_base
-        from sqlalchemy.dialects.postgresql import JSONB
-
-        from sqlalchemy_media import Image, WandAnalyzer
-
-
-        class ProfileImage(Image):
-           __pre_processors__ = WandAnalyzer()
-
-        Base = declarative_base()
-
-        class Member(Base):
-            __tablename__ = 'person'
-
-            id = Column(Integer, primary_key=True)
-            avatar = Column(ProfileImage.as_mutable(JSONB))
-
-    The use it inside :class:`.ContextManager` context:
-
-    ::
-
-        from sqlalchemy_media import ContextManager
-
-        session = <....>
-
-        with ContextManager(session):
-            me = Member(avatar=ProfileImage.create_from('donkey.jpg'))
-            print(me.avatar.width)
-            print(me.avatar.height)
-            print(me.avatar.content_type)
-
-    .. note:: This object currently selects ``width``, ``height`` and
-              ``mimetype`` of the image.
-
-    """
-
-    def process(self, descriptor: StreamDescriptor, context: dict):
-        ensure_wand()
-        from wand.image import Image as WandImage
-        from wand.exceptions import WandException
-
-        # This processor requires seekable stream.
-        descriptor.prepare_to_read(backend='memory')
-
-        try:
-            with WandImage(file=descriptor)as img:
-                context.update(
-                    width=img.width,
-                    height=img.height,
-                    content_type=img.mimetype
-                )
-
-        except WandException:
-            raise AnalyzeError(str(WandException))
-
-        # prepare for next processor, calling this method is not bad.
-        descriptor.prepare_to_read(backend='memory')
-
-
 class Validator(Processor):
     """
 
@@ -360,39 +277,16 @@ class ImageProcessor(Processor):
        - If you pass both ``width`` and ``height``, aspect ratio may not be
          preserved.
 
-    :param fmt: This argument will be directly passing to ``Wand`` or
-                ``Pillow``. so, for list of available choices, see:
-                `ImageMagic Documentation
-                <http://www.imagemagick.org/script/formats.php>`_
-
+    :param format: The image format. i.e jpeg, gif, png
     :param width: The new image width.
     :param height: The new image height.
     :param crop: Used to crop the image.
 
     .. versionadded:: 0.6
 
-    The crop dimension as a dictionary containing the keys described
-    `here <http://docs.wand-py.org/en/0.4.1/wand/image.html#wand.image.BaseImage.crop>`_.
-
-    Including you can
-    use percent ``%`` sing to automatically calculate the values from original
-    image dimension::
+    The crop argument is 4-tuple of (left, top, right, bottom)
 
-        ImageProcessor(crop=dict(width='50%', height='50%', gravity='center'))
-        ImageProcessor(crop=dict(width='10%', height='10%', gravity='south_east'))
-
-    Or::
-
-        ImageProcessor(crop=dict(
-        top='10%',
-        bottom='10%',
-        left='10%',
-        right='10%',
-        width='80%',
-        height='80%'
-        ))
-
-    Included from wand documentation::
+        ImageProcessor(crop=(10, 10, 120, 230))
 
         +--------------------------------------------------+
         |              ^                         ^         |
@@ -410,12 +304,6 @@ class ImageProcessor(Processor):
         | <--------------- right ---------->               |
         +--------------------------------------------------+
 
-    .. seealso::
-
-       - ``crop`` `method <http://docs.wand-py.org/en/0.4.1/wand/image.html#wand.image.BaseImage.crop>`_.  # noqa
-       - ``gravity`` `argument <http://docs.wand-py.org/en/0.4.1/wand/image.html#wand.image.GRAVITY_TYPES>`_.
-       - `Wand <http://docs.wand-py.org/>`_
-
     """
 
     def __init__(self, fmt: str = None, width: int = None, height: int = None, crop=None):
@@ -489,9 +377,6 @@ class ImageAnalyzer(Analyzer):
     Analyze an image using available image library by calling the
     :classmethod:`.imaging.ImagingLibrary.get_available()
 
-    .. warning:: If none of ``Wand`` or ``Pillow`` are installed the
-                 :exc:`.OptionalPackageRequirementError` will be raised.
-
     .. note:: This object currently selects ``width``, ``height`` and
               ``mimetype`` of an image.
 

sqlalchemy_media/tests/test_analyzers.py

@@ -3,7 +3,7 @@
 import io
 from os.path import dirname, abspath, join
 
-from sqlalchemy_media.processors import MagicAnalyzer, WandAnalyzer
+from sqlalchemy_media.processors import MagicAnalyzer
 from sqlalchemy_media.descriptors import AttachableDescriptor
 
 
@@ -36,17 +36,6 @@ def test_magic(self):
             analyzer.process(d, ctx)
             self.assertEqual(ctx['content_type'], 'image/png')
 
-    def test_wand(self):
-        analyzer = WandAnalyzer()
-        with AttachableDescriptor(self.cat_jpeg) as d:
-            ctx = {}
-            analyzer.process(d, ctx)
-            self.assertDictEqual(ctx, {
-                'width': 640,
-                'height': 480,
-                'content_type': 'image/jpeg'
-            })
-
 
 if __name__ == '__main__':  # pragma: no cover
     unittest.main()