Merge pull request #192 from chinapandaman/PPF-191

PPF-191: allowing setting element value to file path or file object

Author: chinapandaman

PyPDFForm/middleware/element.py

@@ -2,10 +2,11 @@
 """Contains element middleware."""
 
 from enum import Enum
-from typing import Union
+from typing import BinaryIO, Union
 
 from ..core.font import Font as FontCore
 from ..core.image import Image as ImageCore
+from .adapter import FileAdapter
 from .exceptions.element import (InvalidElementNameError,
                                  InvalidElementTypeError,
                                  InvalidElementValueError,
@@ -30,13 +31,21 @@ def __init__(
         self,
         element_name: str,
         element_type: "ElementType",
-        element_value: Union[str, bool, bytes, int] = None,
+        element_value: Union[str, bool, bytes, int, BinaryIO] = None,
     ) -> None:
         """Constructs all attributes for the Element object."""
 
+        if element_type == ElementType.image and (
+            isinstance(element_value, (bytes, str))
+            or FileAdapter().readable(element_value)
+        ):
+            adapted = FileAdapter().fp_or_f_obj_or_stream_to_stream(element_value)
+            if adapted is not None:
+                element_value = adapted
+
         self._name = element_name
         self._type = element_type
-        self.value = element_value
+        self._value = element_value
 
         if element_type == ElementType.text:
             self.font = None
@@ -46,6 +55,25 @@ def __init__(
             self.text_y_offset = None
             self.text_wrap_length = None
 
+    @property
+    def value(self) -> Union[str, bool, bytes, int, BinaryIO]:
+        """Value of the element."""
+
+        return self._value
+
+    @value.setter
+    def value(self, v) -> None:
+        """Insures the value gets converted to bytes when set to fp or f object."""
+
+        if self._type == ElementType.image and (
+            isinstance(v, (bytes, str)) or FileAdapter().readable(v)
+        ):
+            adapted = FileAdapter().fp_or_f_obj_or_stream_to_stream(v)
+            if adapted is not None:
+                v = adapted
+
+        self._value = v
+
     @property
     def name(self) -> str:
         """Name of the element."""

docs/v2/api_reference.md

@@ -171,7 +171,8 @@ It currently supports the following based on the type of the element:
   1) A `string`, if the element is a `text`.
   2) A `boolean`, if the element is a `checkbox`.
   3) An `integer`, if the element is a `radio`.
-  4) A valid image `bytes` stream, if the element is an `image`.
+  4) A valid image `bytes` stream, if the element is an `image`. When setting the value of an `image` element explicitly, 
+    a file path or file object of the image is also accepted. In either case however the attribute will still be converted to a `bytes` stream.
 
 ### **name**
 
@@ -190,7 +191,8 @@ It currently supports the following based on the type of the element:
 1) A `string`, if the element is a `text`.
 2) A `boolean`, if the element is a `checkbox`.
 3) An `integer`, if the element is a `radio`.
-4) A valid image `bytes` stream, if the element is an `image`.
+4) A valid image `bytes` stream, if the element is an `image`. When setting the value of an `image` element explicitly, 
+    a file path or file object of the image is also accepted. In either case however the attribute will still be converted to a `bytes` stream.
 
 ### **font** = *None*
 

tests/functional/test_fill.py

@@ -469,6 +469,59 @@ def test_fill_images_f_obj_params(pdf_samples, image_samples):
         assert obj.stream[:32767] == expected[:32767]
 
 
+def test_fill_images_fp_params_explicitly_setting_elements(pdf_samples, image_samples):
+    with open(os.path.join(pdf_samples, "sample_filled_images.pdf"), "rb+") as f:
+        expected = f.read()
+
+    obj = PyPDFForm(
+        os.path.join(pdf_samples, "sample_template_with_image_field.pdf"),
+        simple_mode=False,
+    )
+
+    obj.elements["image_1"].value = os.path.join(image_samples, "sample_image.jpg")
+    obj.elements["image_2"].value = os.path.join(image_samples, "sample_image_2.jpg")
+    obj.elements["image_3"].value = os.path.join(image_samples, "sample_image_3.jpg")
+
+    obj.fill({})
+
+    if os.name == "nt":
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+    else:
+        assert obj.stream[:32767] == expected[:32767]
+
+
+def test_fill_images_f_obj_params_explicitly_setting_elements(
+    pdf_samples, image_samples
+):
+    with open(os.path.join(pdf_samples, "sample_filled_images.pdf"), "rb+") as f:
+        expected = f.read()
+
+    with open(
+        os.path.join(pdf_samples, "sample_template_with_image_field.pdf"), "rb+"
+    ) as template:
+        with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as image:
+            with open(
+                os.path.join(image_samples, "sample_image_2.jpg"), "rb+"
+            ) as image_2:
+                with open(
+                    os.path.join(image_samples, "sample_image_3.jpg"), "rb+"
+                ) as image_3:
+                    obj = PyPDFForm(template, simple_mode=False)
+
+                    obj.elements["image_1"].value = image
+                    obj.elements["image_2"].value = image_2
+                    obj.elements["image_3"].value = image_3
+
+                    obj.fill({})
+
+    if os.name == "nt":
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+    else:
+        assert obj.stream[:32767] == expected[:32767]
+
+
 def test_simple_fill_radiobutton(pdf_samples, template_with_radiobutton_stream):
     with open(
         os.path.join(pdf_samples, "sample_filled_radiobutton_simple.pdf"), "rb+"

tests/unit/test_element.py

@@ -253,3 +253,23 @@ def test_invalid_constants(text_element):
         assert False
     except InvalidElementTypeError:
         assert True
+
+
+def test_value_set_and_get_with_fp_and_f_obj(image_samples, image_stream):
+    path = os.path.join(image_samples, "sample_image.jpg")
+
+    foo = Element("foo", ElementType.image, path)
+    assert foo.value == image_stream
+
+    with open(path, "rb+") as f:
+        bar = Element("bar", ElementType.image, f)
+        assert bar.value == image_stream
+
+    foo_bar = Element("foo_bar", ElementType.image)
+    foo_bar.value = path
+    assert foo_bar.value == image_stream
+
+    bar_foo = Element("bar_foo", ElementType.image)
+    with open(path, "rb+") as i:
+        bar_foo.value = i
+        assert bar_foo.value == image_stream