img: refactor Image.from_file()

Steve Canny · Steve Canny · commit 16a588fcff49 · 2013-12-30T00:18:39.000-08:00
… to remove duplication and to improve naming.
diff --git a/docx/package.py b/docx/package.py
@@ -72,7 +72,7 @@ def get_or_add_image_part(self, image_descriptor):
         *image_descriptor*, newly created if a matching one is not present in
         the collection.
         """
-        image = Image.load(image_descriptor)
+        image = Image.from_file(image_descriptor)
         matching_image_part = self._get_by_sha1(image.sha1)
         if matching_image_part is not None:
             return matching_image_part
diff --git a/docx/parts/image.py b/docx/parts/image.py
@@ -73,15 +73,26 @@ def filename(self):
     @classmethod
     def from_blob(cls, blob):
         stream = StringIO(blob)
-        content_type, px_width, px_height, horz_dpi, vert_dpi = (
-            cls._analyze_image(stream)
-        )
-        stream.close()
-        filename = 'image%s' % cls._def_mime_ext(content_type)
-        return cls(
-            blob, filename, content_type, px_width, px_height, horz_dpi,
-            vert_dpi
-        )
+        return cls._from_stream(stream, blob)
+
+    @classmethod
+    def from_file(cls, image_descriptor):
+        """
+        Return a new |Image| instance loaded from the image file identified
+        by *image_descriptor*, a path or file-like object.
+        """
+        if isinstance(image_descriptor, basestring):
+            path = image_descriptor
+            with open(path, 'rb') as f:
+                blob = f.read()
+                stream = StringIO(blob)
+            filename = os.path.basename(path)
+        else:
+            stream = image_descriptor
+            stream.seek(0)
+            blob = stream.read()
+            filename = None
+        return cls._from_stream(stream, blob, filename)
 
     @property
     def horz_dpi(self):
@@ -91,16 +102,6 @@ def horz_dpi(self):
         """
         return self._horz_dpi
 
-    @classmethod
-    def load(cls, image_descriptor):
-        """
-        Return a new |Image| instance loaded from the image file identified
-        by *image_descriptor*, a path or file-like object.
-        """
-        if isinstance(image_descriptor, basestring):
-            return cls._load_from_path(image_descriptor)
-        return cls._load_from_stream(image_descriptor)
-
     @property
     def px_width(self):
         """
@@ -166,26 +167,12 @@ def _format_content_type(cls, format):
         return format_content_types[format]
 
     @classmethod
-    def _load_from_path(cls, path):
-        with open(path, 'rb') as f:
-            blob = f.read()
-            content_type, px_width, px_height, horz_dpi, vert_dpi = (
-                cls._analyze_image(f)
-            )
-        filename = os.path.basename(path)
-        return cls(
-            blob, filename, content_type, px_width, px_height, horz_dpi,
-            vert_dpi
-        )
-
-    @classmethod
-    def _load_from_stream(cls, stream):
-        stream.seek(0)
-        blob = stream.read()
+    def _from_stream(cls, stream, blob, filename=None):
         content_type, px_width, px_height, horz_dpi, vert_dpi = (
             cls._analyze_image(stream)
         )
-        filename = 'image%s' % cls._def_mime_ext(content_type)
+        if filename is None:
+            filename = 'image%s' % cls._def_mime_ext(content_type)
         return cls(
             blob, filename, content_type, px_width, px_height, horz_dpi,
             vert_dpi
diff --git a/tests/parts/test_image.py b/tests/parts/test_image.py
@@ -23,28 +23,28 @@ class DescribeImage(object):
 
     def it_can_construct_from_an_image_path(self):
         image_file_path = test_file('monty-truth.png')
-        image = Image.load(image_file_path)
+        image = Image.from_file(image_file_path)
         assert isinstance(image, Image)
         assert image.sha1 == '79769f1e202add2e963158b532e36c2c0f76a70c'
         assert image.filename == 'monty-truth.png'
 
     def it_can_construct_from_an_image_stream(self):
         image_file_path = test_file('monty-truth.png')
         with open(image_file_path, 'rb') as image_file_stream:
-            image = Image.load(image_file_stream)
+            image = Image.from_file(image_file_stream)
         assert isinstance(image, Image)
         assert image.sha1 == '79769f1e202add2e963158b532e36c2c0f76a70c'
         assert image.filename == 'image.png'
 
     def it_knows_the_extension_of_a_file_based_image(self):
         image_file_path = test_file('monty-truth.png')
-        image = Image.load(image_file_path)
+        image = Image.from_file(image_file_path)
         assert image.ext == '.png'
 
     def it_knows_the_extension_of_a_stream_based_image(self):
         image_file_path = test_file('monty-truth.png')
         with open(image_file_path, 'rb') as image_file_stream:
-            image = Image.load(image_file_stream)
+            image = Image.from_file(image_file_stream)
         assert image.ext == '.png'
 
     def it_correctly_characterizes_a_few_known_images(
@@ -54,7 +54,7 @@ def it_correctly_characterizes_a_few_known_images(
             characteristics
         )
         with open(test_file(image_path), 'rb') as stream:
-            image = Image.load(stream)
+            image = Image.from_file(stream)
             assert image.ext == ext
             assert image.content_type == content_type
             assert image.px_width == px_width
@@ -121,7 +121,7 @@ def blob_(self, request):
     @pytest.fixture(params=['loaded', 'new'])
     def dimensions_fixture(self, request):
         image_file_path = test_file('monty-truth.png')
-        image = Image.load(image_file_path)
+        image = Image.from_file(image_file_path)
         expected_cx, expected_cy = 1905000, 2717800
 
         # case 1: image part is loaded by PartFactory w/no Image inst
diff --git a/tests/test_package.py b/tests/test_package.py
@@ -81,7 +81,7 @@ def get_image_part_fixture(self, Image_, image_part_, image_descriptor_):
     @pytest.fixture
     def Image_(self, request, image_):
         Image_ = class_mock(request, 'docx.package.Image')
-        Image_.load.return_value = image_
+        Image_.from_file.return_value = image_
         return Image_
 
     @pytest.fixture
