Skip to content

Scrapy, a fast high-level web crawling & scraping framework for Python.

cleaned up code relating to issue #3689

drs-118b84a65a6b2d
diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py
index f709c5057..e265685fb 100644
--- a/scrapy/pipelines/images.py
+++ b/scrapy/pipelines/images.py
@@ -6,6 +6,7 @@ See documentation in topics/media-pipeline.rst
import functools
import hashlib
import six
+import warnings
try:
from cStringIO import StringIO as BytesIO
@@ -19,6 +20,7 @@ from scrapy.utils.python import to_bytes, get_func_args
from scrapy.http import Request
from scrapy.settings import Settings
from scrapy.exceptions import DropItem
+from scrapy.exceptions import ScrapyDeprecationWarning
#TODO: from scrapy.pipelines.media import MediaPipeline
from scrapy.pipelines.files import FileException, FilesPipeline
@@ -132,8 +134,6 @@ class ImagesPipeline(FilesPipeline):
if self._deprecated_convert_image is None:
self._deprecated_convert_image = 'response_body' not in get_func_args(self.convert_image)
if self._deprecated_convert_image:
- from scrapy.exceptions import ScrapyDeprecationWarning
- import warnings
warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, '
'overriden method does not accept response_body argument.',
category=ScrapyDeprecationWarning, stacklevel=1)
@@ -153,9 +153,7 @@ class ImagesPipeline(FilesPipeline):
yield thumb_path, thumb_image, thumb_buf
def convert_image(self, image, size=None, response_body=None):
- if not response_body:
- from scrapy.exceptions import ScrapyDeprecationWarning
- import warnings
+ if response_body is None:
warnings.warn('ImagesPipeline.convert_image() method called in a deprecated way, '
'method called without response_body argument.',
category=ScrapyDeprecationWarning, stacklevel=1)
@@ -175,7 +173,7 @@ class ImagesPipeline(FilesPipeline):
if size:
image = image.copy()
image.thumbnail(size, Image.ANTIALIAS)
- elif response_body and image.format == 'JPEG':
+ elif response_body is not None and image.format == 'JPEG':
return image, response_body
buf = BytesIO()
@@ -193,8 +191,6 @@ class ImagesPipeline(FilesPipeline):
def file_path(self, request, response=None, info=None):
## start of deprecation warning block (can be removed in the future)
def _warn():
- from scrapy.exceptions import ScrapyDeprecationWarning
- import warnings
warnings.warn('ImagesPipeline.image_key(url) and file_key(url) methods are deprecated, '
'please use file_path(request, response=None, info=None) instead',
category=ScrapyDeprecationWarning, stacklevel=1)
@@ -221,8 +217,6 @@ class ImagesPipeline(FilesPipeline):
def thumb_path(self, request, thumb_id, response=None, info=None):
## start of deprecation warning block (can be removed in the future)
def _warn():
- from scrapy.exceptions import ScrapyDeprecationWarning
- import warnings
warnings.warn('ImagesPipeline.thumb_key(url) method is deprecated, please use '
'thumb_path(request, thumb_id, response=None, info=None) instead',
category=ScrapyDeprecationWarning, stacklevel=1)
diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py
index ec0c87264..915b6a579 100644
--- a/tests/test_pipeline_images.py
+++ b/tests/test_pipeline_images.py
@@ -75,41 +75,7 @@ class ImagesPipelineTestCase(unittest.TestCase):
info=object()),
'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg')
- def test_convert_image(self):
- # tests for old API
- with warnings.catch_warnings(record=True) as w:
- warnings.simplefilter('always')
- SIZE = (100, 100)
- # straigh forward case: RGB and JPEG
- COLOUR = (0, 127, 255)
- im, _ = _create_image('JPEG', 'RGB', SIZE, COLOUR)
- converted, _ = self.pipeline.convert_image(im)
- self.assertEqual(converted.mode, 'RGB')
- self.assertEqual(converted.getcolors(), [(10000, COLOUR)])
-
- # check that thumbnail keep image ratio
- thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25))
- self.assertEqual(thumbnail.mode, 'RGB')
- self.assertEqual(thumbnail.size, (10, 10))
-
- # transparency case: RGBA and PNG
- COLOUR = (0, 127, 255, 50)
- im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR)
- converted, _ = self.pipeline.convert_image(im)
- self.assertEqual(converted.mode, 'RGB')
- self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))])
-
- # transparency case with palette: P and PNG
- COLOUR = (0, 127, 255, 50)
- im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR)
- im = im.convert('P')
- converted, _ = self.pipeline.convert_image(im)
- self.assertEqual(converted.mode, 'RGB')
- self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))])
-
- # ensure that we recieved deprecation warnings
- self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a deprecated way' in str(warning.message)]) == 4)
-
+ def test_convert_image_new(self):
# tests for new API
SIZE = (100, 100)
# straigh forward case: RGB and JPEG
@@ -207,6 +173,42 @@ class DeprecatedImagesPipelineTestCase(unittest.TestCase):
self.assertEqual(len(w), 1)
self.assertTrue('thumb_key(url) method is deprecated' in str(w[-1].message))
+ def test_overriden_convert_image_method(self):
+ self.init_pipeline(ImagesPipeline)
+ # tests for old API
+ with warnings.catch_warnings(record=True) as w:
+ warnings.simplefilter('always')
+ SIZE = (100, 100)
+ # straigh forward case: RGB and JPEG
+ COLOUR = (0, 127, 255)
+ im, _ = _create_image('JPEG', 'RGB', SIZE, COLOUR)
+ converted, _ = self.pipeline.convert_image(im)
+ self.assertEqual(converted.mode, 'RGB')
+ self.assertEqual(converted.getcolors(), [(10000, COLOUR)])
+
+ # check that thumbnail keep image ratio
+ thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25))
+ self.assertEqual(thumbnail.mode, 'RGB')
+ self.assertEqual(thumbnail.size, (10, 10))
+
+ # transparency case: RGBA and PNG
+ COLOUR = (0, 127, 255, 50)
+ im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR)
+ converted, _ = self.pipeline.convert_image(im)
+ self.assertEqual(converted.mode, 'RGB')
+ self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))])
+
+ # transparency case with palette: P and PNG
+ COLOUR = (0, 127, 255, 50)
+ im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR)
+ im = im.convert('P')
+ converted, _ = self.pipeline.convert_image(im)
+ self.assertEqual(converted.mode, 'RGB')
+ self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))])
+
+ # ensure that we recieved deprecation warnings
+ self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a deprecated way' in str(warning.message)]) == 4)
+
def tearDown(self):
rmtree(self.tempdir)