PyPDFForm 1.5.1__tar.gz → 1.5.3__tar.gz

{pypdfform-1.5.1 → pypdfform-1.5.3}/PKG-INFO

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

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.5.1"
+__version__ = "1.5.3"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/adapter.py

@@ -12,7 +12,7 @@ def readable(obj: Any) -> bool:
 
 
 def fp_or_f_obj_or_stream_to_stream(
-    fp_or_f_obj_or_stream: Union[bytes, str, BinaryIO]
+    fp_or_f_obj_or_stream: Union[bytes, str, BinaryIO],
 ) -> bytes:
     """Converts a file path or a file object to a stream."""
 

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/constants.py

@@ -76,11 +76,11 @@ NEW_LINE_SYMBOL = "\n"
 IMAGE_FIELD_IDENTIFIER = "event.target.buttonImportIcon();"
 
 DEFAULT_CHECKBOX_STYLE = "\u2713"
-DEFAULT_RADIO_STYLE = "\u25CF"
+DEFAULT_RADIO_STYLE = "\u25cf"
 BUTTON_STYLES = {
     "4": "\u2713",  # check
-    "5": "\u00D7",  # cross
-    "l": "\u25CF",  # circle
+    "5": "\u00d7",  # cross
+    "l": "\u25cf",  # circle
 }
 
 COORDINATE_GRID_FONT_SIZE_MARGIN_RATIO = DEFAULT_FONT_SIZE / 100

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/coordinate.py

@@ -40,6 +40,9 @@ def get_draw_checkbox_radio_coordinates(
 
 def get_draw_image_coordinates_resolutions(
     widget: dict,
+    preserve_aspect_ratio: bool,
+    image_width: float,
+    image_height: float,
 ) -> Tuple[float, float, float, float]:
     """
     Returns coordinates and resolutions to draw image at given a PDF form signature/image widget.
@@ -50,6 +53,18 @@ def get_draw_image_coordinates_resolutions(
     width = abs(float(widget[Rect][0]) - float(widget[Rect][2]))
     height = abs(float(widget[Rect][1]) - float(widget[Rect][3]))
 
+    if preserve_aspect_ratio:
+        ratio = max(image_width / width, image_height / height)
+
+        new_width = image_width / ratio
+        new_height = image_height / ratio
+
+        x += abs(new_width - width) / 2
+        y += abs(new_height - height) / 2
+
+        width = new_width
+        height = new_height
+
     return x, y, width, height
 
 

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/filler.py

@@ -13,7 +13,7 @@ from .coordinate import (get_draw_checkbox_radio_coordinates,
                          get_draw_text_coordinates,
                          get_text_line_x_coordinates)
 from .font import checkbox_radio_font_size
-from .image import any_image_to_jpg
+from .image import any_image_to_jpg, get_image_dimensions
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -62,7 +62,10 @@ def signature_image_handler(
     if stream is not None:
         any_image_to_draw = True
         stream = any_image_to_jpg(stream)
-        x, y, width, height = get_draw_image_coordinates_resolutions(widget)
+        image_width, image_height = get_image_dimensions(stream)
+        x, y, width, height = get_draw_image_coordinates_resolutions(
+            widget, middleware.preserve_aspect_ratio, image_width, image_height
+        )
         images_to_draw.append(
             [
                 stream,

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/image.py

@@ -2,7 +2,7 @@
 """Contains helpers for image."""
 
 from io import BytesIO
-from typing import Union
+from typing import Tuple, Union
 
 from PIL import Image
 
@@ -28,6 +28,18 @@ def rotate_image(image_stream: bytes, rotation: Union[float, int]) -> bytes:
     return result
 
 
+def get_image_dimensions(image_stream: bytes) -> Tuple[float, float]:
+    """Gets the width and height of an image."""
+
+    buff = BytesIO()
+    buff.write(image_stream)
+    buff.seek(0)
+
+    image = Image.open(buff)
+
+    return image.size
+
+
 def any_image_to_jpg(image_stream: bytes) -> bytes:
     """Converts an image of any type to jpg."""
 

pypdfform-1.5.3/PyPDFForm/middleware/image.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+"""Contains image field middleware."""
+
+from typing import BinaryIO, Union
+
+from .signature import Signature
+
+
+class Image(Signature):
+    """A class to represent an image field widget."""
+
+    def __init__(
+        self,
+        name: str,
+        value: Union[bytes, str, BinaryIO] = None,
+    ) -> None:
+        """Constructs all attributes for the image field."""
+
+        super().__init__(name, value)
+
+        self.preserve_aspect_ratio = False

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/middleware/signature.py

@@ -20,6 +20,8 @@ class Signature(Widget):
 
         super().__init__(name, value)
 
+        self.preserve_aspect_ratio = True
+
     @property
     def schema_definition(self) -> dict:
         """Json schema definition of the signature field."""

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm/wrapper.py

@@ -71,6 +71,13 @@ class FormWrapper:
 class PdfWrapper(FormWrapper):
     """A class to represent a PDF form."""
 
+    USER_PARAMS = [
+        "global_font",
+        "global_font_size",
+        "global_font_color",
+        "use_full_widget_name",
+    ]
+
     def __init__(
         self,
         template: Union[bytes, str, BinaryIO] = b"",
@@ -82,11 +89,8 @@ class PdfWrapper(FormWrapper):
         self.widgets = {}
         self._keys_to_update = []
 
-        self.global_font = kwargs.get("global_font")
-        self.global_font_size = kwargs.get("global_font_size")
-        self.global_font_color = kwargs.get("global_font_color")
-
-        self.use_full_widget_name = kwargs.get("use_full_widget_name", False)
+        for each in self.USER_PARAMS:
+            setattr(self, each, kwargs.get(each))
 
         self._init_helper()
 
@@ -95,7 +99,9 @@ class PdfWrapper(FormWrapper):
 
         refresh_not_needed = {}
         new_widgets = (
-            build_widgets(self.read(), self.use_full_widget_name) if self.read() else {}
+            build_widgets(self.read(), getattr(self, "use_full_widget_name"))
+            if self.read()
+            else {}
         )
         for k, v in self.widgets.items():
             if k in new_widgets:
@@ -109,9 +115,9 @@ class PdfWrapper(FormWrapper):
                 and isinstance(value, Text)
                 and not refresh_not_needed.get(key)
             ):
-                value.font = self.global_font
-                value.font_size = self.global_font_size
-                value.font_color = self.global_font_color
+                value.font = getattr(self, "global_font")
+                value.font_size = getattr(self, "global_font_size")
+                value.font_color = getattr(self, "global_font_color")
 
     @property
     def sample_data(self) -> dict:
@@ -133,7 +139,12 @@ class PdfWrapper(FormWrapper):
     def pages(self) -> List[PdfWrapper]:
         """Returns a list of pdf wrapper objects where each is a page of the PDF form."""
 
-        return [self.__class__(each) for each in get_page_streams(self.stream)]
+        return [
+            self.__class__(
+                each, **{param: getattr(self, param) for param in self.USER_PARAMS}
+            )
+            for each in get_page_streams(self.stream)
+        ]
 
     def change_version(self, version: str) -> PdfWrapper:
         """Changes the version of the PDF."""
@@ -258,7 +269,7 @@ class PdfWrapper(FormWrapper):
     ) -> PdfWrapper:
         """Updates the key of an existed widget on a PDF form."""
 
-        if self.use_full_widget_name:
+        if getattr(self, "use_full_widget_name"):
             raise NotImplementedError
 
         if defer:
@@ -275,7 +286,7 @@ class PdfWrapper(FormWrapper):
     def commit_widget_key_updates(self) -> PdfWrapper:
         """Commits all deferred widget key updates on a PDF form."""
 
-        if self.use_full_widget_name:
+        if getattr(self, "use_full_widget_name"):
             raise NotImplementedError
 
         old_keys = [each[0] for each in self._keys_to_update]

{pypdfform-1.5.1 → pypdfform-1.5.3}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-1.5.1 → pypdfform-1.5.3}/tests/test_functional.py

@@ -516,6 +516,22 @@ def test_pages(template_stream, pdf_samples, request):
         assert obj.pages[0].read() == f.read()
 
 
+def test_pages_inherit_attributes(template_stream):
+    obj = PdfWrapper(
+        template_stream,
+        global_font="Courier",
+        global_font_size=20,
+        global_font_color=(1, 0, 0),
+        use_full_widget_name=True,
+    )
+
+    for page in obj.pages:
+        assert getattr(page, "global_font") == "Courier"
+        assert getattr(page, "global_font_size") == 20
+        assert getattr(page, "global_font_color") == (1, 0, 0)
+        assert getattr(page, "use_full_widget_name")
+
+
 def test_generate_coordinate_grid(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "test_generate_coordinate_grid.pdf")
     with open(expected_path, "rb+") as f:

pypdfform-1.5.3/tests/test_signature.py

@@ -0,0 +1,180 @@
+# -*- coding: utf-8 -*-
+
+import os
+
+from PyPDFForm import PdfWrapper
+
+
+def test_fill_signature(pdf_samples, image_samples, request):
+    expected_path = os.path.join(pdf_samples, "signature", "test_fill_signature.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(pdf_samples, "signature", "sample_template_with_signature.pdf")
+        ).fill({"signature": os.path.join(image_samples, "sample_signature.png")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
+def test_signature_schema(pdf_samples):
+    obj = PdfWrapper(
+        os.path.join(pdf_samples, "signature", "sample_template_with_signature.pdf")
+    )
+
+    assert obj.widgets["signature"].schema_definition == {"type": "string"}
+
+
+def test_signature_sample_value(pdf_samples):
+    obj = PdfWrapper(
+        os.path.join(pdf_samples, "signature", "sample_template_with_signature.pdf")
+    )
+
+    assert obj.widgets["signature"].sample_value == os.path.expanduser(
+        "~/Downloads/sample_image.jpg"
+    )
+
+
+def test_fill_signature_overlap(pdf_samples, image_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "signature", "test_fill_signature_overlap.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(
+                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
+            )
+        ).fill({"signature": os.path.join(image_samples, "sample_signature.png")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
+def test_fill_signature_overlap_not_preserve_aspect_ratio(
+    pdf_samples, image_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples,
+        "signature",
+        "test_fill_signature_overlap_not_preserve_aspect_ratio.pdf",
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(
+                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
+            )
+        )
+        obj.widgets["signature"].preserve_aspect_ratio = False
+        obj.fill({"signature": os.path.join(image_samples, "sample_signature.png")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
+def test_fill_small_icon(pdf_samples, image_samples, request):
+    expected_path = os.path.join(pdf_samples, "signature", "test_fill_small_icon.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(
+                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
+            )
+        )
+        obj.fill({"signature": os.path.join(image_samples, "small_icon.png")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
+def test_fill_small_icon_not_preserve_aspect_ratio(pdf_samples, image_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "signature", "test_fill_small_icon_not_preserve_aspect_ratio.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(
+                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
+            )
+        )
+        obj.widgets["signature"].preserve_aspect_ratio = False
+        obj.fill({"signature": os.path.join(image_samples, "small_icon.png")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
+def test_fill_vertical_image(pdf_samples, image_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "signature", "test_fill_vertical_image.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(
+                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
+            )
+        )
+        obj.fill({"signature": os.path.join(image_samples, "vertical_image.jpg")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
+def test_fill_vertical_image_not_preserve_aspect_ratio(
+    pdf_samples, image_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples,
+        "signature",
+        "test_fill_vertical_image_not_preserve_aspect_ratio.pdf",
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(
+            os.path.join(
+                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
+            )
+        )
+        obj.widgets["signature"].preserve_aspect_ratio = False
+        obj.fill({"signature": os.path.join(image_samples, "vertical_image.jpg")})
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected

pypdfform-1.5.1/PyPDFForm/middleware/image.py

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

pypdfform-1.5.1/tests/test_signature.py

@@ -1,61 +0,0 @@
-# -*- coding: utf-8 -*-
-
-import os
-
-from PyPDFForm import PdfWrapper
-
-
-def test_fill_signature(pdf_samples, image_samples, request):
-    expected_path = os.path.join(pdf_samples, "signature", "test_fill_signature.pdf")
-    with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(
-            os.path.join(pdf_samples, "signature", "sample_template_with_signature.pdf")
-        ).fill({"signature": os.path.join(image_samples, "sample_signature.png")})
-
-        request.config.results["expected_path"] = expected_path
-        request.config.results["stream"] = obj.read()
-
-        expected = f.read()
-
-        if os.name != "nt":
-            assert len(obj.read()) == len(expected)
-            assert obj.read() == expected
-
-
-def test_signature_schema(pdf_samples):
-    obj = PdfWrapper(
-        os.path.join(pdf_samples, "signature", "sample_template_with_signature.pdf")
-    )
-
-    assert obj.widgets["signature"].schema_definition == {"type": "string"}
-
-
-def test_signature_sample_value(pdf_samples):
-    obj = PdfWrapper(
-        os.path.join(pdf_samples, "signature", "sample_template_with_signature.pdf")
-    )
-
-    assert obj.widgets["signature"].sample_value == os.path.expanduser(
-        "~/Downloads/sample_image.jpg"
-    )
-
-
-def test_fill_signature_overlap(pdf_samples, image_samples, request):
-    expected_path = os.path.join(
-        pdf_samples, "signature", "test_fill_signature_overlap.pdf"
-    )
-    with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(
-            os.path.join(
-                pdf_samples, "signature", "sample_template_with_signature_overlap.pdf"
-            )
-        ).fill({"signature": os.path.join(image_samples, "sample_signature.png")})
-
-        request.config.results["expected_path"] = expected_path
-        request.config.results["stream"] = obj.read()
-
-        expected = f.read()
-
-        if os.name != "nt":
-            assert len(obj.read()) == len(expected)
-            assert obj.read() == expected