PyPDFForm 1.4.35__py3-none-any.whl → 1.4.37__py3-none-any.whl

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/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/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/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/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/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/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.dist-info → PyPDFForm-1.4.37.dist-info}/METADATA

@@ -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.dist-info → PyPDFForm-1.4.37.dist-info}/RECORD

@@ -1,30 +1,30 @@
-PyPDFForm/__init__.py,sha256=9dfihKc09ZglJuveuHbEH6vycHLDKZba-wMkcRdv3zI,179
+PyPDFForm/__init__.py,sha256=c3mPBn4GLmtOK5zrTSR2Rn966Uj7N3n20D6rJnw0pC8,179
 PyPDFForm/adapter.py,sha256=WFP-r8FLeKa-D9mFO9AphOcuXgyeAI1Ak0d-YsqxsK4,861
 PyPDFForm/constants.py,sha256=FMsdOvnYpchEfki3gf_Y2Wj1SThUxMzsPbOx12_S1GA,1738
 PyPDFForm/coordinate.py,sha256=V_ZZQ1pXtVPAyfMJCX7fKoEimK7XwX6bU3VQ0nKOhQA,7314
-PyPDFForm/filler.py,sha256=pgMA7EC8axKUganmbk7X1uDdsb4OQQFoiI85td3pOO4,7486
+PyPDFForm/filler.py,sha256=ztYU-Rk_LKfCw-BhmdIDnK7ez-5jSPoi2Ho3xvbO4Io,7487
 PyPDFForm/font.py,sha256=TbFLY4G72d7cQ3VG2g4HaYKROzQPQUmh6-8ynN6hzXY,5713
 PyPDFForm/image.py,sha256=sjXPg9fjenNFj12a321xHX6JvuJs6PJRGLzpSNw5mVU,1180
-PyPDFForm/patterns.py,sha256=9DFI-2cVZxzJKWmWBjK-dRSeAMNQr7ovHmw1YevrkiQ,5028
-PyPDFForm/template.py,sha256=a9rDzhHHfnYFo8cDnHnRE9UriUykXvrsyFKVGq9DYd0,13166
+PyPDFForm/patterns.py,sha256=NluZyGSiKTV8ijqvBYSV8q389TuijI4wbv6fooHD6hk,5353
+PyPDFForm/template.py,sha256=AaJ9qHw2Fw-51CRSfOy4POeEvFlKJ5h-WdqlFsGBuY4,14230
 PyPDFForm/utils.py,sha256=9omR-oT3OdZqioxpiGqA9_P0GSFC6mg4Y1xrLvWOzkk,4309
 PyPDFForm/watermark.py,sha256=L4LfzjjyJ6TDq9ad2dbtQYheBOic1_oZ7smhFFekNog,4725
-PyPDFForm/wrapper.py,sha256=EC5ugli6Nj1q0un8je3f5xtRIfIxDSf9YrG50QipTPk,9715
+PyPDFForm/wrapper.py,sha256=PRtiLJAtO3Sbpvr3qDy1ElitSRcNghpbkwSSiCMQ-7E,10231
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-PyPDFForm/middleware/base.py,sha256=p-3XsZJ6d7ai2JFLF7LisMWi9yzM3pN7CsFECxtEoI0,751
+PyPDFForm/middleware/base.py,sha256=GjBiFllppO5Xz8U8cEVBxrmK447bUivvrn_WX1IRow4,1005
 PyPDFForm/middleware/checkbox.py,sha256=3-9CMhhtyO9U6lLXDciW-59ng8uS4m6_clPB02mzV9c,1317
 PyPDFForm/middleware/dropdown.py,sha256=7_DuacMQCRvp2pYxDvzEjUNKDUsTfU0aGTRMBtYWTIA,692
 PyPDFForm/middleware/image.py,sha256=xjPxRiGBWFEU3EQGGqJXY1iMX1kmr0jO8O9iVUC5rcc,177
 PyPDFForm/middleware/radio.py,sha256=ZDrRRF0Tu_3VBQ69x0G-IaZVf8FSOVz8xVpQsyiKhBc,725
 PyPDFForm/middleware/signature.py,sha256=m7tNvGZ7fQ0yuVKzSlLbNQ2IILo1GDnjzMDzMnYCKVM,1104
-PyPDFForm/middleware/text.py,sha256=BvdfmHu3GIWPMALahhHOz39mJPuMBx0c9ubYwi2kSZk,1144
+PyPDFForm/middleware/text.py,sha256=PSU-4u54NkefDRM-cMZ-3-hn-fVG6Q3_m3q8JS50dPE,1516
 PyPDFForm/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 PyPDFForm/widgets/base.py,sha256=nb6HEfRdWSjZc_Th1XI62PIlgREn_JiApGC-epb6jAg,3348
 PyPDFForm/widgets/checkbox.py,sha256=MGB6NGI-XMBz4j2erykgYOCd1pswvthuQ6UFowQOd4o,503
 PyPDFForm/widgets/dropdown.py,sha256=2_R5xcLUWAL0G4raVgWWtE7TJdiWJITay-Gtl8YI2QI,705
 PyPDFForm/widgets/text.py,sha256=sCB8CQAjh30QOGr8FTIDSk3X6dXSHJztOz6YkKEBDss,691
-PyPDFForm-1.4.35.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-PyPDFForm-1.4.35.dist-info/METADATA,sha256=NGXpVEkFdAFv0SY4Di2p8JBEiEJLcmbD9-LCFLO-RTo,4151
-PyPDFForm-1.4.35.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-PyPDFForm-1.4.35.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-PyPDFForm-1.4.35.dist-info/RECORD,,
+PyPDFForm-1.4.37.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+PyPDFForm-1.4.37.dist-info/METADATA,sha256=pjzxkLQNmIdUgWis6c_CV4EvsRmlV33A5CWxZh2pvuE,4202
+PyPDFForm-1.4.37.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+PyPDFForm-1.4.37.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+PyPDFForm-1.4.37.dist-info/RECORD,,

{PyPDFForm-1.4.35.dist-info → PyPDFForm-1.4.37.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any