PyPDFForm 2.2.2__py3-none-any.whl → 2.2.4__py3-none-any.whl

PyPDFForm/__init__.py

@@ -5,7 +5,7 @@ This package provides tools for filling PDF forms, drawing text and images,
 and manipulating PDF form elements programmatically.
 """
 
-__version__ = "2.2.2"
+__version__ = "2.2.4"
 
 from .wrapper import FormWrapper, PdfWrapper
 

PyPDFForm/watermark.py

@@ -10,7 +10,7 @@ This module handles:
 """
 
 from io import BytesIO
-from typing import List
+from typing import List, Union
 
 from pypdf import PdfReader, PdfWriter
 from pypdf.generic import ArrayObject, NameObject
@@ -335,20 +335,28 @@ def merge_watermarks_with_pdf(
 
 
 def copy_watermark_widgets(
-    pdf: bytes, watermarks: List[bytes], keys: List[str]
+    pdf: bytes,
+    watermarks: Union[List[bytes], bytes],
+    keys: Union[List[str], None],
+    page_num: Union[int, None],
 ) -> bytes:
-    """
-    Copies annotation widgets (form fields) from watermark PDFs onto the corresponding pages of a base PDF,
-    including only those widgets whose key matches an entry in the provided keys list.
+    """Copies annotation widgets (form fields) from watermark PDFs onto the corresponding pages of a base PDF.
+
+    This function selectively copies annotation widgets (form fields) from watermark PDFs to a base PDF.
+    It allows specifying which widgets to copy based on their keys, and optionally restricts the operation
+    to a specific page number.
 
-    For each watermark in the provided list, any annotation widgets (such as form fields) are cloned
-    and appended to the annotations of the corresponding page in the base PDF, but only if their key
-    matches one of the specified keys.
+    The function can handle either a list of watermarks (one per page) or a single watermark PDF applied to all pages.
+    Widgets are only copied if their key is present in the provided keys list.
 
     Args:
         pdf: The original PDF document as bytes.
-        watermarks: List of watermark PDF data (as bytes), one per page. Empty or None entries are skipped.
+        watermarks: Either a list of watermark PDF data (as bytes, one per page) or a single watermark PDF as bytes.
+                   Empty or None entries are skipped.
         keys: List of widget keys (str). Only widgets whose key is in this list will be copied.
+              If None, all widgets will be copied.
+        page_num: Optional page number (0-based) to restrict widget copying to. If None, widgets are copied
+                  across all pages.
 
     Returns:
         bytes: The resulting PDF document with selected annotation widgets from watermarks copied onto their respective pages.
@@ -358,21 +366,34 @@ def copy_watermark_widgets(
     out = PdfWriter()
     out.append(pdf_file)
 
-    widgets_to_copy = {}
+    widgets_to_copy_watermarks = {}
+    widgets_to_copy_pdf = {}
+
+    widgets_to_copy = widgets_to_copy_watermarks
+    if isinstance(watermarks, bytes):
+        watermarks = [watermarks]
+        widgets_to_copy = widgets_to_copy_pdf
+
+    if page_num is not None:
+        widgets_to_copy = widgets_to_copy_watermarks
 
     for i, watermark in enumerate(watermarks):
         if not watermark:
             continue
 
-        widgets_to_copy[i] = []
+        widgets_to_copy_watermarks[i] = []
         watermark_file = PdfReader(stream_to_io(watermark))
-        for page in watermark_file.pages:
+        for j, page in enumerate(watermark_file.pages):
+            widgets_to_copy_pdf[j] = []
             for annot in page.get(Annots, []):  # noqa
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str
                 )
-                if key in keys:
-                    widgets_to_copy[i].append(annot.clone(out))
+                if (keys is None or key in keys) and (
+                    page_num is None or page_num == j
+                ):
+                    widgets_to_copy_watermarks[i].append(annot.clone(out))
+                    widgets_to_copy_pdf[j].append(annot.clone(out))
 
     for i, page in enumerate(out.pages):
         if i in widgets_to_copy:

PyPDFForm/wrapper.py

@@ -288,9 +288,10 @@ class PdfWrapper(FormWrapper):
 
         return [
             self.__class__(
-                each, **{param: getattr(self, param) for param, _ in self.USER_PARAMS}
+                copy_watermark_widgets(each, self.stream, None, i),
+                **{param: getattr(self, param) for param, _ in self.USER_PARAMS},
             )
-            for each in get_page_streams(self.stream)
+            for i, each in enumerate(get_page_streams(remove_all_widgets(self.read())))
         ]
 
     def change_version(self, version: str) -> PdfWrapper:
@@ -497,7 +498,7 @@ class PdfWrapper(FormWrapper):
         obj = _class(name=name, page_number=page_number, x=x, y=y, **kwargs)
         watermarks = obj.watermarks(self.read())
 
-        self.stream = copy_watermark_widgets(self.read(), watermarks, [name])
+        self.stream = copy_watermark_widgets(self.read(), watermarks, [name], None)
         if obj.non_acro_form_params:
             self.stream = handle_non_acro_form_params(
                 self.stream, name, obj.non_acro_form_params
@@ -586,7 +587,10 @@ class PdfWrapper(FormWrapper):
         """Draws static text onto the PDF document at specified coordinates.
 
         Adds non-interactive text that becomes part of the PDF content rather
-        than a form field. Useful for annotations, labels, signatures, etc.
+        than a form field. The text is drawn using a temporary Text widget and
+        merged via watermark operations, preserving existing form fields.
+
+        Supports multi-line text (using NEW_LINE_SYMBOL) and custom formatting.
 
         Args:
             text: The text content to draw (supports newlines with NEW_LINE_SYMBOL)
@@ -624,7 +628,11 @@ class PdfWrapper(FormWrapper):
             ],
         )
 
+        stream_with_widgets = self.read()
         self.stream = merge_watermarks_with_pdf(self.stream, watermarks)
+        self.stream = copy_watermark_widgets(
+            remove_all_widgets(self.stream), stream_with_widgets, None, None
+        )
 
         return self
 
@@ -640,10 +648,8 @@ class PdfWrapper(FormWrapper):
     ) -> PdfWrapper:
         """Draws an image onto the PDF document at specified coordinates.
 
-        Supports common image formats (JPEG, PNG) from various sources:
-        - Raw image bytes
-        - File path
-        - File-like object
+        The image is merged via watermark operations, preserving existing form fields.
+        Supports common formats (JPEG, PNG) from bytes, file paths, or file objects.
 
         Args:
             image: Image data as bytes, file path, or file object
@@ -664,7 +670,11 @@ class PdfWrapper(FormWrapper):
             self.stream, page_number, "image", [[image, x, y, width, height]]
         )
 
+        stream_with_widgets = self.read()
         self.stream = merge_watermarks_with_pdf(self.stream, watermarks)
+        self.stream = copy_watermark_widgets(
+            remove_all_widgets(self.stream), stream_with_widgets, None, None
+        )
 
         return self
 

{pypdfform-2.2.2.dist-info → pypdfform-2.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.2.2
+Version: 2.2.4
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT

{pypdfform-2.2.2.dist-info → pypdfform-2.2.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-PyPDFForm/__init__.py,sha256=HNulIew3N71YCiwiDKAcAlO6PzDIaF1VrqRgHbnFC6A,328
+PyPDFForm/__init__.py,sha256=O-6vjBgvz5Cs4XbRwRyzJxW8Qk81vE3itghTLrSUgkI,328
 PyPDFForm/adapter.py,sha256=_5fP5UR-NzjDDayJmBRO36DgbnbUzNbjZtHZtPvSM14,1909
 PyPDFForm/constants.py,sha256=r4lR-lQ8KjKRLMowjxIv6k3wBPOxvt9-JAMugZwQmZM,2285
 PyPDFForm/coordinate.py,sha256=AgVrBoUo6fLVTVdZrlVRf6tGwD-AX54ICMLfbvhYfRs,14879
@@ -8,8 +8,8 @@ PyPDFForm/image.py,sha256=aYk7BC-AHiqt73durGIQ3e6gE5Ggbdr8jmkCUaQdsk8,1627
 PyPDFForm/patterns.py,sha256=iChwqR-aZUKhEdnbQ8OEwnES2-NaMhBUy4dUrnuDPpA,9243
 PyPDFForm/template.py,sha256=v1ZM52xHCzO8Xm7EXinbTepm2G7MU7StUgCFtuUdcbI,18899
 PyPDFForm/utils.py,sha256=ubqTaItrs6pEYcza-12bxLUiFYe_sl-0SdeowD_BSG0,8444
-PyPDFForm/watermark.py,sha256=9ydcqy8wNrea_1BvywyUsbcD4TzxQuEAdo0izOZKYyU,11101
-PyPDFForm/wrapper.py,sha256=4owXTiSyvx2DSA2XGnssIjH-ygL2pznmRjpPOuWwaWw,24625
+PyPDFForm/watermark.py,sha256=w4m5wMOnVvDD693gbKrpZ1rvmjsgxrRaiSvDQfFCky0,12074
+PyPDFForm/wrapper.py,sha256=spClcCLAfjTrwMwn6lP4zEtEKQ_Pb-SBy_US9SmS_Xc,25263
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 PyPDFForm/middleware/base.py,sha256=d4z7M7pm80176cC4H85m3ZRWzAu_Fm1HkwQkmSSi-WE,2832
 PyPDFForm/middleware/checkbox.py,sha256=gRGhFySPoIpKBseoiOTS3WggoBBik12dXbZ-LJKzIwM,2611
@@ -27,8 +27,8 @@ PyPDFForm/widgets/image.py,sha256=6y8Ysmk49USr_qWOXD6KGL6cch516cUIlrxoj0pJy9Q,79
 PyPDFForm/widgets/radio.py,sha256=ipadJyHbgftDUvjGk15kapzgHPN3HjdF_iB_7amXR6o,2737
 PyPDFForm/widgets/signature.py,sha256=RII_fgjPRbM5_72ih4L6ohaWCBOyjgIoY6odkd15VY8,5107
 PyPDFForm/widgets/text.py,sha256=HP2cPEUAzK5QL3kDfMz7gQcC3svCpmYuyFItBjlrBpI,1233
-pypdfform-2.2.2.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-pypdfform-2.2.2.dist-info/METADATA,sha256=uConsIdDy3O6gtKYxjRAROunBPR5ghd4_gNAoedhQ3A,5605
-pypdfform-2.2.2.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-pypdfform-2.2.2.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-pypdfform-2.2.2.dist-info/RECORD,,
+pypdfform-2.2.4.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+pypdfform-2.2.4.dist-info/METADATA,sha256=40T0_d8c8w_xm84oLVUOTdl60vutnZgAMu_Y6KQrtug,5605
+pypdfform-2.2.4.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+pypdfform-2.2.4.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+pypdfform-2.2.4.dist-info/RECORD,,

{pypdfform-2.2.2.dist-info → pypdfform-2.2.4.dist-info}/WHEEL

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