PyPDFForm 2.2.3__tar.gz → 2.2.4__tar.gz

{pypdfform-2.2.3 → pypdfform-2.2.4}/PKG-INFO

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

{pypdfform-2.2.3 → pypdfform-2.2.4}/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.3"
+__version__ = "2.2.4"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.2.3 → pypdfform-2.2.4}/PyPDFForm/watermark.py

@@ -335,22 +335,28 @@ def merge_watermarks_with_pdf(
 
 
 def copy_watermark_widgets(
-    pdf: bytes, watermarks: Union[List[bytes], bytes], keys: Union[List[str], None]
+    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.
 
-    For each watermark in the provided list (or single watermark PDF if bytes input is provided),
-    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.
+    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.
+
+    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: Either a list of watermark PDF data (as bytes, one per page) or a single watermark PDF.
+        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.
@@ -368,6 +374,9 @@ def copy_watermark_widgets(
         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
@@ -380,7 +389,9 @@ def copy_watermark_widgets(
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str
                 )
-                if keys is None or key in keys:
+                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))
 

{pypdfform-2.2.3 → pypdfform-2.2.4}/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
@@ -630,7 +631,7 @@ 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
+            remove_all_widgets(self.stream), stream_with_widgets, None, None
         )
 
         return self
@@ -672,7 +673,7 @@ 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
+            remove_all_widgets(self.stream), stream_with_widgets, None, None
         )
 
         return self

{pypdfform-2.2.3 → pypdfform-2.2.4}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-2.2.3 → pypdfform-2.2.4}/tests/test_functional.py

@@ -629,6 +629,56 @@ def test_pages(template_stream, pdf_samples, request):
         assert obj.pages[0].read() == f.read()
 
 
+def test_sejda_pages_1(sejda_template, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "pages", "test_sejda_pages_1.pdf")
+    obj = PdfWrapper(sejda_template)
+
+    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()
+
+
+def test_sejda_pages_2(sejda_template, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "pages", "test_sejda_pages_2.pdf")
+    obj = PdfWrapper(sejda_template)
+
+    with open(expected_path, "rb+") as f:
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.pages[1].read()
+        assert obj.pages[1].read() == f.read()
+
+
+def test_radio_pages_1(template_with_radiobutton_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "pages", "test_radio_pages_1.pdf")
+    obj = PdfWrapper(template_with_radiobutton_stream)
+
+    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()
+
+
+def test_radio_pages_2(template_with_radiobutton_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "pages", "test_radio_pages_2.pdf")
+    obj = PdfWrapper(template_with_radiobutton_stream)
+
+    with open(expected_path, "rb+") as f:
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.pages[1].read()
+        assert obj.pages[1].read() == f.read()
+
+
+def test_radio_pages_3(template_with_radiobutton_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "pages", "test_radio_pages_3.pdf")
+    obj = PdfWrapper(template_with_radiobutton_stream)
+
+    with open(expected_path, "rb+") as f:
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.pages[2].read()
+        assert obj.pages[2].read() == f.read()
+
+
 def test_pages_inherit_attributes(template_stream):
     obj = PdfWrapper(
         template_stream,