PyPDFForm 1.4.34__tar.gz → 1.4.36__tar.gz

{pypdfform-1.4.34 → pypdfform-1.4.36}/PKG-INFO

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

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm/__init__.py

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

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm/filler.py

@@ -128,7 +128,7 @@ def fill(
                     widget_dict, widgets[key], radio_button_tracker
                 )
             elif isinstance(widgets[key], (Signature, Image)):
-                any_image_to_draw = signature_image_handler(
+                any_image_to_draw |= signature_image_handler(
                     widget_dict, widgets[key], images_to_draw[page]
                 )
             else:

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm/patterns.py

@@ -160,6 +160,15 @@ def simple_flatten_generic(annot: DictionaryObject) -> None:
         )
 
 
+def update_annotation_name(annot: DictionaryObject, val: str) -> None:
+    """Patterns to update the name of an annotation."""
+
+    if Parent in annot and T not in annot:
+        annot[NameObject(Parent)][NameObject(T)] = TextStringObject(val)  # noqa
+    else:
+        annot[NameObject(T)] = TextStringObject(val)  # noqa
+
+
 def update_created_text_field_alignment(annot: DictionaryObject, val: int) -> None:
     """Patterns to update text alignment for text annotations created by the library."""
 

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm/template.py

@@ -2,14 +2,16 @@
 """Contains helpers for generic template related processing."""
 
 from functools import lru_cache
+from io import BytesIO
 from sys import maxsize
-from typing import Dict, List, Tuple, Union
+from typing import Dict, List, Tuple, Union, cast
 
-from pypdf import PdfReader
+from pypdf import PdfReader, PdfWriter
+from pypdf.generic import DictionaryObject
 from reportlab.pdfbase.pdfmetrics import stringWidth
 
 from .constants import (COMB, DEFAULT_FONT_SIZE, MULTILINE, NEW_LINE_SYMBOL,
-                        WIDGET_TYPES, MaxLen, Rect)
+                        WIDGET_TYPES, Annots, MaxLen, Rect)
 from .font import (adjust_paragraph_font_size, adjust_text_field_font_size,
                    auto_detect_font, get_text_field_font_color,
                    get_text_field_font_size, text_field_font_size)
@@ -19,7 +21,8 @@ from .middleware.radio import Radio
 from .middleware.text import Text
 from .patterns import (BUTTON_STYLE_PATTERNS, DROPDOWN_CHOICE_PATTERNS,
                        TEXT_FIELD_FLAG_PATTERNS, WIDGET_ALIGNMENT_PATTERNS,
-                       WIDGET_KEY_PATTERNS, WIDGET_TYPE_PATTERNS)
+                       WIDGET_KEY_PATTERNS, WIDGET_TYPE_PATTERNS,
+                       update_annotation_name)
 from .utils import find_pattern_match, stream_to_io, traverse_pattern
 from .watermark import create_watermarks_and_draw
 
@@ -403,3 +406,43 @@ def get_paragraph_auto_wrap_length(widget_middleware: Text) -> int:
         result = min(result, len(line))
 
     return result
+
+
+def update_widget_key(
+    template: bytes,
+    widgets: Dict[str, WIDGET_TYPES],
+    old_key: str,
+    new_key: str,
+    index: int,
+) -> bytes:
+    """Updates the key of a widget."""
+    # pylint: disable=R0801
+
+    pdf = PdfReader(stream_to_io(template))
+    out = PdfWriter()
+    out.append(pdf)
+
+    tracker = -1
+
+    for page in out.pages:
+        for annot in page.get(Annots, []):  # noqa
+            annot = cast(DictionaryObject, annot.get_object())
+            key = get_widget_key(annot.get_object())
+
+            widget = widgets.get(key)
+            if widget is None:
+                continue
+
+            if old_key != key:
+                continue
+
+            tracker += 1
+            if not isinstance(widget, Radio) and tracker != index:
+                continue
+
+            update_annotation_name(annot, new_key)
+
+    with BytesIO() as f:
+        out.write(f)
+        f.seek(0)
+        return f.read()

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm/widgets/base.py

@@ -52,6 +52,7 @@ class Widget:
                         value[0],
                         value[1],
                         value[2],
+                        value[3] if len(value) == 4 else 1,
                     )
                 self.acro_form_params[param] = value
             elif user_input in self.NONE_DEFAULTS:

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm/wrapper.py

@@ -18,7 +18,7 @@ from .middleware.dropdown import Dropdown
 from .middleware.text import Text
 from .template import (build_widgets, dropdown_to_text,
                        set_character_x_paddings, update_text_field_attributes,
-                       widget_rect_watermarks)
+                       update_widget_key, widget_rect_watermarks)
 from .utils import (get_page_streams, merge_two_pdfs, preview_widget_to_draw,
                     remove_all_widgets)
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
@@ -235,6 +235,22 @@ class PdfWrapper(FormWrapper):
 
         return self
 
+    def update_widget_key(
+        self, old_key: str, new_key: str, index: int = 0
+    ) -> PdfWrapper:
+        """Updates the key of an existed widget on a PDF form."""
+
+        self.__init__(
+            template=update_widget_key(
+                self.read(), self.widgets, old_key, new_key, index
+            ),
+            global_font=self.global_font,
+            global_font_size=self.global_font_size,
+            global_font_color=self.global_font_color,
+        )
+
+        return self
+
     def draw_text(
         self,
         text: str,

{pypdfform-1.4.34 → pypdfform-1.4.36}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-1.4.34 → pypdfform-1.4.36}/tests/test_create_widget.py

@@ -198,6 +198,30 @@ def test_create_text_default(template_stream, pdf_samples, request):
         assert obj.stream == expected
 
 
+def test_create_text_alpha_bg_color(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "widget", "create_text_alpha_bg_color.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).create_widget(
+            "text",
+            "foo",
+            1,
+            100,
+            100,
+            bg_color=(0, 0, 1, 0),
+        )
+        assert obj.schema["properties"]["foo"]["type"] == "string"
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
 def test_create_text_align_center(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "widget", "create_text_align_center.pdf")
     with open(expected_path, "rb+") as f:

{pypdfform-1.4.34 → pypdfform-1.4.36}/tests/test_functional.py

@@ -258,7 +258,7 @@ def test_draw_image_on_one_page(template_stream, image_samples, pdf_samples, req
 
         expected = f.read()
 
-        if os.name == "nt":
+        if os.name != "nt":
             request.config.results["expected_path"] = expected_path
             request.config.results["stream"] = obj.read()
             assert len(obj.stream) == len(expected)
@@ -281,7 +281,7 @@ def test_draw_png_image_on_one_page(
 
         expected = f.read()
 
-        if os.name == "nt":
+        if os.name != "nt":
             request.config.results["expected_path"] = expected_path
             request.config.results["stream"] = obj.read()
             assert len(obj.stream) == len(expected)
@@ -304,7 +304,7 @@ def test_draw_transparent_png_image_on_one_page(
 
         expected = f.read()
 
-        if os.name == "nt":
+        if os.name != "nt":
             request.config.results["expected_path"] = expected_path
             request.config.results["stream"] = obj.read()
             assert len(obj.stream) == len(expected)
@@ -510,24 +510,15 @@ def test_fill_complex_fonts(sample_template_with_complex_fonts, pdf_samples, req
             assert obj.stream == expected
 
 
-def test_pages(template_stream, pdf_samples):
+def test_pages(template_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "pages", "sample_template_page_1.pdf")
     obj = PdfWrapper(template_stream)
 
-    with open(
-        os.path.join(pdf_samples, "pages", "sample_template_page_1.pdf"), "rb+"
-    ) as f:
+    with open(expected_path, "rb+") as f:
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.pages[0].read()
         assert obj.pages[0].read() == f.read()
 
-    with open(
-        os.path.join(pdf_samples, "pages", "sample_template_page_2.pdf"), "rb+"
-    ) as f:
-        assert obj.pages[1].read() == f.read()
-
-    with open(
-        os.path.join(pdf_samples, "pages", "sample_template_page_3.pdf"), "rb+"
-    ) as f:
-        assert obj.pages[2].read() == f.read()
-
 
 def test_generate_coordinate_grid(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "test_generate_coordinate_grid.pdf")
@@ -635,3 +626,36 @@ def test_fill_image(
 
         assert len(obj.read()) == len(expected)
         assert obj.stream == expected
+
+
+def test_update_radio_key(template_with_radiobutton_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "test_update_radio_key.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_with_radiobutton_stream)
+        obj.update_widget_key("radio_3", "RADIO")
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.preview) == len(expected)
+        assert obj.preview == expected
+
+
+def test_update_sejda_key(sejda_template, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "test_update_sejda_key.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(sejda_template)
+        obj.update_widget_key("year", "YEAR")
+        obj.update_widget_key("at_future_date", "FUTURE_DATE")
+        obj.update_widget_key("purchase_option", "PURCHASE_OPTION")
+        obj.update_widget_key("buyer_signed_date", "BUYER_SIGNED_DATE")
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.preview) == len(expected)
+        assert obj.preview == expected