PyPDFForm 2.2.2__tar.gz → 2.2.4__tar.gz

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

@@ -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 → 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.2"
+__version__ = "2.2.4"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.2.2 → pypdfform-2.2.4}/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-2.2.2 → 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
@@ -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 → pypdfform-2.2.4}/PyPDFForm.egg-info/PKG-INFO

@@ -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 → pypdfform-2.2.4}/tests/test_functional.py

@@ -34,6 +34,25 @@ def test_fill(template_stream, pdf_samples, data_dict, request):
             assert not widgets
 
 
+def test_fill_not_render_widgets(template_stream, pdf_samples, data_dict, request):
+    expected_path = os.path.join(pdf_samples, "test_fill_not_render_widgets.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream, render_widgets=False).fill(
+            data_dict,
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        assert len(obj.read()) == len(obj.stream)
+        assert obj.read() == obj.stream
+
+        expected = f.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
 def test_register_bad_fonts():
     assert not PdfWrapper.register_font("foo", b"foo")
     assert not PdfWrapper.register_font("foo", "foo")
@@ -218,6 +237,52 @@ def test_draw_text_on_one_page(template_stream, pdf_samples, request):
         assert obj.stream == expected
 
 
+def test_draw_text_on_radio_template(
+    template_with_radiobutton_stream, pdf_samples, request
+):
+    expected_path = os.path.join(pdf_samples, "test_draw_text_on_radio_template.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_with_radiobutton_stream).draw_text(
+            "drawn_text",
+            1,
+            300,
+            225,
+            font=constants.DEFAULT_FONT,
+            font_size=20,
+            font_color=(1, 0, 0),
+        )
+
+        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_draw_text_on_sejda_template(sejda_template, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "test_draw_text_on_sejda_template.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(sejda_template).draw_text(
+            "drawn_text",
+            1,
+            300,
+            225,
+            font=constants.DEFAULT_FONT,
+            font_size=20,
+            font_color=(1, 0, 0),
+        )
+
+        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_draw_text_new_line_symbol(template_stream, pdf_samples, request):
     expected_path = os.path.join(
         pdf_samples, "sample_pdf_with_drawn_text_new_line_symbol.pdf"
@@ -261,6 +326,54 @@ def test_draw_image_on_one_page(template_stream, image_samples, pdf_samples, req
             assert obj.stream == expected
 
 
+def test_draw_image_on_radio_template(
+    template_with_radiobutton_stream, image_samples, pdf_samples, request
+):
+    expected_path = os.path.join(pdf_samples, "test_draw_image_on_radio_template.pdf")
+    with open(expected_path, "rb+") as f:
+        with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as _f:
+            obj = PdfWrapper(template_with_radiobutton_stream).draw_image(
+                _f,
+                2,
+                100,
+                100,
+                400,
+                225,
+            )
+
+        expected = f.read()
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
+def test_draw_image_on_sejda_template(
+    sejda_template, image_samples, pdf_samples, request
+):
+    expected_path = os.path.join(pdf_samples, "test_draw_image_on_sejda_template.pdf")
+    with open(expected_path, "rb+") as f:
+        with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as _f:
+            obj = PdfWrapper(sejda_template).draw_image(
+                _f,
+                2,
+                100,
+                100,
+                400,
+                225,
+            )
+
+        expected = f.read()
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
 def test_draw_png_image_on_one_page(
     template_stream, image_samples, pdf_samples, request
 ):
@@ -516,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,

{pypdfform-2.2.2 → pypdfform-2.2.4}/tests/test_paragraph.py

@@ -139,6 +139,102 @@ def test_fill_sejda_complex(sejda_template_complex, pdf_samples, request):
         assert obj.stream == expected
 
 
+def test_fill_sejda_complex_not_render_widgets(
+    sejda_template_complex, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples, "paragraph", "test_fill_sejda_complex_not_render_widgets.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(sejda_template_complex, render_widgets=False).fill(
+            {
+                "checkbox": True,
+                "radio": 0,
+                "dropdown_font_auto_left": 0,
+                "dropdown_font_auto_center": 1,
+                "dropdown_font_auto_right": 2,
+                "dropdown_font_ten_left": 0,
+                "dropdown_font_ten_center": 1,
+                "dropdown_font_ten_right": 2,
+                "paragraph_font_auto_left": "paragraph_font_auto_left",
+                "paragraph_font_auto_center": "paragraph_font_auto_center",
+                "paragraph_font_auto_right": "paragraph_font_auto_right",
+                "paragraph_font_ten_left": "paragraph_font_ten_left",
+                "paragraph_font_ten_center": "paragraph_font_ten_center",
+                "paragraph_font_ten_right": "paragraph_font_ten_right",
+                "text__font_auto_left": "test text",
+                "text_font_auto_center": "test text",
+                "text_font_auto_right": "test text",
+                "text_font_ten_left": "text_font_ten_left",
+                "text_font_ten_center": "text_font_ten_center",
+                "text_font_ten_right": "text_font_ten_right",
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+        assert len(obj.read()) == len(obj.stream)
+        assert obj.read() == obj.stream
+
+        expected = f.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
+def test_fill_sejda_complex_not_render_some_widgets(
+    sejda_template_complex, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples, "paragraph", "test_fill_sejda_complex_not_render_some_widgets.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(sejda_template_complex)
+
+        obj.widgets["radio"].render_widget = False
+        obj.widgets["dropdown_font_auto_center"].render_widget = False
+        obj.widgets["dropdown_font_ten_center"].render_widget = False
+        obj.widgets["paragraph_font_auto_center"].render_widget = False
+        obj.widgets["paragraph_font_ten_center"].render_widget = False
+        obj.widgets["text_font_auto_center"].render_widget = False
+        obj.widgets["text_font_ten_center"].render_widget = False
+
+        obj.fill(
+            {
+                "checkbox": True,
+                "radio": 0,
+                "dropdown_font_auto_left": 0,
+                "dropdown_font_auto_center": 1,
+                "dropdown_font_auto_right": 2,
+                "dropdown_font_ten_left": 0,
+                "dropdown_font_ten_center": 1,
+                "dropdown_font_ten_right": 2,
+                "paragraph_font_auto_left": "paragraph_font_auto_left",
+                "paragraph_font_auto_center": "paragraph_font_auto_center",
+                "paragraph_font_auto_right": "paragraph_font_auto_right",
+                "paragraph_font_ten_left": "paragraph_font_ten_left",
+                "paragraph_font_ten_center": "paragraph_font_ten_center",
+                "paragraph_font_ten_right": "paragraph_font_ten_right",
+                "text__font_auto_left": "test text",
+                "text_font_auto_center": "test text",
+                "text_font_auto_right": "test text",
+                "text_font_ten_left": "text_font_ten_left",
+                "text_font_ten_center": "text_font_ten_center",
+                "text_font_ten_right": "text_font_ten_right",
+            }
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+        assert len(obj.read()) == len(obj.stream)
+        assert obj.read() == obj.stream
+
+        expected = f.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
 def test_sejda_complex_paragraph_multiple_line_alignment(
     sejda_template_complex, pdf_samples, request
 ):