PyPDFForm 1.4.20__tar.gz → 1.4.21__tar.gz

{pypdfform-1.4.20 → pypdfform-1.4.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.20
+Version: 1.4.21
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.4.20"
+__version__ = "1.4.21"
 
 from .wrapper import FormWrapper, PdfWrapper, PyPDFForm

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm/constants.py

@@ -27,6 +27,8 @@ WIDGET_TYPES = Union[Text, Checkbox, Radio, Dropdown, Signature]
 DEPRECATION_NOTICE = "{} will be deprecated soon. Use {} instead."
 
 Annots = "/Annots"
+A = "/A"
+JS = "/JS"
 T = "/T"
 Rect = "/Rect"
 Subtype = "/Subtype"
@@ -64,6 +66,8 @@ PREVIEW_FONT_COLOR = (1, 0, 0)
 
 NEW_LINE_SYMBOL = "\n"
 
+IMAGE_FIELD_IDENTIFIER = "event.target.buttonImportIcon();"
+
 DEFAULT_CHECKBOX_STYLE = "\u2713"
 DEFAULT_RADIO_STYLE = "\u25CF"
 BUTTON_STYLES = {

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm/coordinate.py

@@ -38,11 +38,11 @@ def get_draw_checkbox_radio_coordinates(
     )
 
 
-def get_draw_sig_coordinates_resolutions(
+def get_draw_image_coordinates_resolutions(
     widget: dict,
 ) -> Tuple[float, float, float, float]:
     """
-    Returns coordinates and resolutions to draw signature at given a PDF form signature widget.
+    Returns coordinates and resolutions to draw image at given a PDF form signature/image widget.
     """
 
     x = float(widget[Rect][0])

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm/filler.py

@@ -9,13 +9,14 @@ from pypdf.generic import DictionaryObject
 
 from .constants import WIDGET_TYPES, Annots
 from .coordinate import (get_draw_checkbox_radio_coordinates,
-                         get_draw_sig_coordinates_resolutions,
+                         get_draw_image_coordinates_resolutions,
                          get_draw_text_coordinates,
                          get_text_line_x_coordinates)
 from .font import checkbox_radio_font_size
 from .image import any_image_to_jpg
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
+from .middleware.image import Image
 from .middleware.radio import Radio
 from .middleware.signature import Signature
 from .middleware.text import Text
@@ -69,12 +70,14 @@ def fill(
                     radio_button_tracker[key] += 1
                     if widgets[key].value == radio_button_tracker[key] - 1:
                         text_needs_to_be_drawn = True
-            elif isinstance(widgets[key], Signature):
+            elif isinstance(widgets[key], (Signature, Image)):
                 stream = widgets[key].stream
                 if stream is not None:
                     any_image_to_draw = True
                     stream = any_image_to_jpg(stream)
-                    x, y, width, height = get_draw_sig_coordinates_resolutions(_widget)
+                    x, y, width, height = get_draw_image_coordinates_resolutions(
+                        _widget
+                    )
                     images_to_draw[page].append(
                         [
                             stream,

pypdfform-1.4.21/PyPDFForm/middleware/image.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+"""Contains image field middleware."""
+
+from .signature import Signature
+
+
+class Image(Signature):
+    """A class to represent an image field widget."""

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm/patterns.py

@@ -4,15 +4,21 @@
 from pypdf.generic import (DictionaryObject, NameObject, NumberObject,
                            TextStringObject)
 
-from .constants import (AP, AS, CA, DA, FT, MK, READ_ONLY, Btn, Ch, D, Ff, Off,
-                        Opt, Parent, Q, Sig, Subtype, T, Tx, V, Widget)
+from .constants import (AP, AS, CA, DA, FT, IMAGE_FIELD_IDENTIFIER, JS, MK,
+                        READ_ONLY, A, Btn, Ch, D, Ff, Off, Opt, Parent, Q, Sig,
+                        Subtype, T, Tx, V, Widget)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
+from .middleware.image import Image
 from .middleware.radio import Radio
 from .middleware.signature import Signature
 from .middleware.text import Text
 
 WIDGET_TYPE_PATTERNS = [
+    (
+        ({A: {JS: IMAGE_FIELD_IDENTIFIER}},),
+        Image,
+    ),
     (
         ({FT: Sig},),
         Signature,

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.20
+Version: 1.4.21
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li

{pypdfform-1.4.20 → pypdfform-1.4.21}/PyPDFForm.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ PyPDFForm/middleware/__init__.py
 PyPDFForm/middleware/base.py
 PyPDFForm/middleware/checkbox.py
 PyPDFForm/middleware/dropdown.py
+PyPDFForm/middleware/image.py
 PyPDFForm/middleware/radio.py
 PyPDFForm/middleware/signature.py
 PyPDFForm/middleware/text.py

{pypdfform-1.4.20 → pypdfform-1.4.21}/tests/test_functional.py

@@ -610,3 +610,21 @@ def test_radio_change_size_and_button_style(
 
         assert len(obj.read()) == len(expected)
         assert obj.stream == expected
+
+
+def test_fill_image(
+    sample_template_with_image_field, image_samples, pdf_samples, request
+):
+    expected_path = os.path.join(pdf_samples, "sample_filled_image.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(sample_template_with_image_field).fill(
+            {"image_1": os.path.join(image_samples, "sample_image.jpg")},
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.stream == expected