PyPDFForm 1.4.35__tar.gz → 1.4.37__tar.gz

{pypdfform-1.4.35 → pypdfform-1.4.37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.35
+Version: 1.4.37
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{pypdfform-1.4.35 → pypdfform-1.4.37}/PyPDFForm/__init__.py

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

{pypdfform-1.4.35 → pypdfform-1.4.37}/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.35 → pypdfform-1.4.37}/PyPDFForm/middleware/base.py

@@ -16,7 +16,7 @@ class Widget:
 
         super().__init__()
         self._name = name
-        self.value = value
+        self._value = value
 
     @property
     def name(self) -> str:
@@ -24,6 +24,18 @@ class Widget:
 
         return self._name
 
+    @property
+    def value(self) -> Any:
+        """Value to fill for the widget."""
+
+        return self._value
+
+    @value.setter
+    def value(self, value: Any) -> None:
+        """Sets value to fill for the widget."""
+
+        self._value = value
+
     @property
     def schema_definition(self) -> dict:
         """Json schema definition of the widget."""

{pypdfform-1.4.35 → pypdfform-1.4.37}/PyPDFForm/middleware/text.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 """Contains text middleware."""
 
+from typing import Any
+
 from .base import Widget
 
 
@@ -27,6 +29,21 @@ class Text(Widget):
         self.text_line_x_coordinates = None
         self.preview = False
 
+    @property
+    def value(self) -> Any:
+        """Value to fill for the text field."""
+
+        if isinstance(self._value, (int, float)):
+            return str(self._value)
+
+        return self._value
+
+    @value.setter
+    def value(self, value: str) -> None:
+        """Sets value to fill for the text field."""
+
+        self._value = value
+
     @property
     def schema_definition(self) -> dict:
         """Json schema definition of the text field."""

{pypdfform-1.4.35 → pypdfform-1.4.37}/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.35 → pypdfform-1.4.37}/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.35 → pypdfform-1.4.37}/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.35 → pypdfform-1.4.37}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.35
+Version: 1.4.37
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{pypdfform-1.4.35 → pypdfform-1.4.37}/PyPDFForm.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ tests/test_dropdown.py
 tests/test_dropdown_simple.py
 tests/test_fill_max_length_text_field.py
 tests/test_fill_max_length_text_field_simple.py
+tests/test_fill_method.py
 tests/test_functional.py
 tests/test_functional_simple.py
 tests/test_paragraph.py

{pypdfform-1.4.35 → pypdfform-1.4.37}/setup.py

@@ -35,6 +35,7 @@ setuptools.setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Topic :: Software Development :: Libraries :: Python Modules",

pypdfform-1.4.37/tests/test_fill_method.py

@@ -0,0 +1,141 @@
+# -*- coding: utf-8 -*-
+
+import os
+
+from PyPDFForm import PdfWrapper
+
+
+def test_fill_with_varied_int_values(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "fill_method", "sample_filled_varied_ints.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(
+            {
+                "test": 100,
+                "test_2": -250,
+                "test_3": 0,
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
+def test_fill_with_boolean_and_int_values(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "fill_method", "sample_filled_boolean_and_ints.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(
+            {
+                "test": 42,
+                "test_2": True,
+                "test_3": False,
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
+def test_fill_with_empty_string_and_int(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "fill_method", "sample_filled_with_empty_string_and_int.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(
+            {
+                "test": 42,
+                "test_2": "",
+                "test_3": 33,
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
+def test_fill_with_large_and_small_ints(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "fill_method", "sample_filled_large_and_small_ints.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(
+            {
+                "test": 999999999999,
+                "test_2": -999999999999,
+                "test_3": 1,
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
+def test_fill_with_varied_float_values(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "fill_method", "sample_filled_varied_float_values.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(
+            {
+                "test": 1.5,
+                "test_2": 13.8,
+                "test_3": 543,
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
+def test_fill_with_negative_and_positive_floats_and_int(
+    template_stream, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples,
+        "fill_method",
+        "sample_filled_negative_and_positive_floats_and_int.pdf",
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(
+            {
+                "test": -1.5,
+                "test_2": -6.9,
+                "test_3": 22,
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected

{pypdfform-1.4.35 → pypdfform-1.4.37}/tests/test_functional.py

@@ -626,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