PyPDFForm 2.2.5__tar.gz → 2.2.7__tar.gz

{pypdfform-2.2.5 → pypdfform-2.2.7}/PKG-INFO

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

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

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm/constants.py

@@ -50,6 +50,7 @@ Ff = "/Ff"
 Tx = "/Tx"
 V = "/V"
 AP = "/AP"
+I = "/I"  # noqa: E741
 N = "/N"
 Sig = "/Sig"
 DA = "/DA"
@@ -75,6 +76,7 @@ Off = "/Off"
 # For Adobe Acrobat
 AcroForm = "/AcroForm"
 Root = "/Root"
+Fields = "/Fields"
 NeedAppearances = "/NeedAppearances"
 
 # Field flag bits

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm/filler.py

@@ -16,10 +16,11 @@ from io import BytesIO
 from typing import Dict, Tuple, Union, cast
 
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import BooleanObject, DictionaryObject, NameObject
+from pypdf.generic import (ArrayObject, BooleanObject, DictionaryObject,
+                           IndirectObject, NameObject)
 
 from .constants import (BUTTON_STYLES, DEFAULT_RADIO_STYLE, WIDGET_TYPES,
-                        AcroForm, Annots, NeedAppearances, Root, U)
+                        AcroForm, Annots, Fields, NeedAppearances, Root, U)
 from .coordinate import (get_draw_border_coordinates,
                          get_draw_checkbox_radio_coordinates,
                          get_draw_image_coordinates_resolutions,
@@ -37,7 +38,7 @@ from .patterns import (WIDGET_KEY_PATTERNS, simple_flatten_generic,
                        simple_flatten_radio, simple_update_checkbox_value,
                        simple_update_dropdown_value, simple_update_radio_value,
                        simple_update_text_value)
-from .template import get_widgets_by_page
+from .template import get_widget_full_key, get_widgets_by_page
 from .utils import (checkbox_radio_to_draw, extract_widget_property,
                     stream_to_io)
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
@@ -219,6 +220,7 @@ def get_drawn_stream(to_draw: dict, stream: bytes, action: str) -> bytes:
 def fill(
     template_stream: bytes,
     widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
 ) -> bytes:
     """Fills a PDF form using watermark technique for complex rendering.
 
@@ -230,6 +232,7 @@ def fill(
     Args:
         template_stream: Input PDF form as bytes
         widgets: Dictionary mapping field names to widget middleware
+        use_full_widget_name: If True, uses the full widget name as the key in the widgets dictionary
 
     Returns:
         bytes: Filled PDF form as bytes
@@ -252,6 +255,8 @@ def fill(
         line_borders_to_draw[page] = []
         for widget_dict in widget_dicts:
             key = extract_widget_property(widget_dict, WIDGET_KEY_PATTERNS, None, str)
+            if use_full_widget_name:
+                key = get_widget_full_key(widget_dict)
             text_needs_to_be_drawn = False
             to_draw = x = y = None
 
@@ -305,19 +310,34 @@ def fill(
     return result
 
 
-def enable_adobe_mode(pdf: PdfReader, adobe_mode: bool) -> None:
-    """Configures PDF for Adobe Acrobat compatibility.
+def enable_adobe_mode(reader: PdfReader, writer: PdfWriter, adobe_mode: bool) -> None:
+    """Configures the PDF for Adobe Acrobat compatibility by setting the NeedAppearances flag
+    and ensuring the AcroForm structure is properly initialized.
 
     Args:
-        pdf: PdfReader instance of the PDF
-        adobe_mode: If True, sets NeedAppearances flag for Acrobat
+        reader: PdfReader instance of the PDF
+        writer: PdfWriter instance to configure
+        adobe_mode: If True, enables Adobe Acrobat compatibility mode
     """
 
-    if adobe_mode and AcroForm in pdf.trailer[Root]:
-        pdf.trailer[Root][AcroForm].update(
+    if not adobe_mode:
+        return
+
+    # https://stackoverflow.com/questions/47288578/pdf-form-filled-with-pypdf2-does-not-show-in-print
+    if AcroForm in reader.trailer[Root]:
+        reader.trailer[Root][AcroForm].update(
             {NameObject(NeedAppearances): BooleanObject(True)}
         )
 
+    if AcroForm not in writer.root_object:
+        writer.root_object.update(
+            {NameObject(AcroForm): IndirectObject(len(writer.root_object), 0, writer)}
+        )
+    writer.root_object[AcroForm][NameObject(NeedAppearances)] = BooleanObject(  # noqa
+        True
+    )
+    writer.root_object[AcroForm][NameObject(Fields)] = ArrayObject()  # noqa
+
 
 def simple_fill(
     template: bytes,
@@ -343,8 +363,8 @@ def simple_fill(
     """
 
     pdf = PdfReader(stream_to_io(template))
-    enable_adobe_mode(pdf, adobe_mode)
     out = PdfWriter()
+    enable_adobe_mode(pdf, out, adobe_mode)
     out.append(pdf)
 
     radio_button_tracker = {}

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm/patterns.py

@@ -15,13 +15,13 @@ The module also contains utility functions for common PDF form operations
 like updating field values and flattening form fields.
 """
 
-from pypdf.generic import (DictionaryObject, NameObject, NumberObject,
-                           TextStringObject)
+from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
+                           NumberObject, TextStringObject)
 
 from .constants import (AP, AS, BC, BG, BS, CA, DA, DV, FT,
                         IMAGE_FIELD_IDENTIFIER, JS, MK, MULTILINE, READ_ONLY,
-                        TU, A, Btn, Ch, D, Ff, N, Off, Opt, Parent, Q, S, Sig,
-                        T, Tx, V, W, Yes)
+                        TU, A, Btn, Ch, D, Ff, I, N, Off, Opt, Parent, Q, S,
+                        Sig, T, Tx, V, W, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -160,13 +160,17 @@ def simple_update_radio_value(annot: DictionaryObject) -> None:
     """Update radio button annotation values to selected state.
 
     Modifies the appearance state (AS) of a radio button annotation and updates
-    the parent's value (V) to reflect the selected state. Uses the annotation's
-    appearance dictionary (AP/N) to determine valid states.
+    the parent's value (V) to reflect the selected state. Removes 'Opt' entry
+    from parent dictionary if present. Uses the annotation's appearance
+    dictionary (AP/N) to determine valid states.
 
     Args:
         annot: PDF radio button annotation dictionary to modify
     """
 
+    if Opt in annot[Parent]:
+        del annot[Parent][Opt]  # noqa
+
     for each in annot[AP][N]:  # noqa
         if str(each) != Off:
             annot[NameObject(AS)] = NameObject(each)
@@ -177,9 +181,9 @@ def simple_update_radio_value(annot: DictionaryObject) -> None:
 def simple_update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> None:
     """Update dropdown annotation values based on widget selection.
 
-    Modifies the value (V) and appearance (AP) of a dropdown annotation to
-    reflect the currently selected choice from the widget. Handles both
-    standalone dropdowns and those with parent annotations.
+    Modifies the value (V), appearance (AP), and index (I) of a dropdown
+    annotation to reflect the currently selected choice from the widget.
+    Handles both standalone dropdowns and those with parent annotations.
 
     Args:
         annot: PDF dropdown annotation dictionary to modify
@@ -194,6 +198,7 @@ def simple_update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> N
     else:
         annot[NameObject(V)] = TextStringObject(widget.choices[widget.value])
         annot[NameObject(AP)] = TextStringObject(widget.choices[widget.value])
+        annot[NameObject(I)] = ArrayObject([NumberObject(widget.value)])
 
 
 def simple_update_text_value(annot: DictionaryObject, widget: Text) -> None:

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm/template.py

@@ -246,15 +246,14 @@ def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     return result
 
 
-def get_widget_full_key(widget: dict) -> Union[str, None]:
+def get_widget_full_key(widget: dict) -> str:
     """Constructs a widget's full hierarchical key including parent names.
 
     Args:
         widget: PDF widget dictionary
 
     Returns:
-        Union[str, None]: Full key in format "parent.child" if parent exists,
-            otherwise None
+        str: Full key in format "parent.child" if parent exists, otherwise the widget's key
     """
 
     key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
@@ -264,9 +263,9 @@ def get_widget_full_key(widget: dict) -> Union[str, None]:
         and T in widget[Parent].get_object()
         and widget[Parent].get_object()[T] != key
     ):
-        return f"{widget[Parent].get_object()[T]}.{key}"
+        key = f"{get_widget_full_key(widget[Parent].get_object())}.{key}"
 
-    return None
+    return key
 
 
 def construct_widget(widget: dict, key: str) -> Union[WIDGET_TYPES, None]:

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm/utils.py

@@ -104,10 +104,13 @@ def checkbox_radio_to_draw(
     return new_widget
 
 
-def preview_widget_to_draw(widget: WIDGET_TYPES, with_preview_text: bool) -> Text:
+def preview_widget_to_draw(
+    widget_name: str, widget: WIDGET_TYPES, with_preview_text: bool
+) -> Text:
     """Creates preview version of a widget showing field name/location.
 
     Args:
+        widget_name: Name of the widget to generate preview for
         widget: Widget to generate preview for
         with_preview_text: Whether to include field name in preview
 
@@ -117,7 +120,7 @@ def preview_widget_to_draw(widget: WIDGET_TYPES, with_preview_text: bool) -> Tex
 
     new_widget = Text(
         name=widget.name,
-        value="{" + f" {widget.name} " + "}" if with_preview_text else None,
+        value="{" + f" {widget_name} " + "}" if with_preview_text else None,
     )
     new_widget.font = DEFAULT_FONT
     new_widget.font_size = DEFAULT_FONT_SIZE

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm/wrapper.py

@@ -362,9 +362,10 @@ class PdfWrapper(FormWrapper):
             fill(
                 self.stream,
                 {
-                    key: preview_widget_to_draw(value, True)
+                    key: preview_widget_to_draw(key, value, True)
                     for key, value in self.widgets.items()
                 },
+                getattr(self, "use_full_widget_name"),
             )
         )
 
@@ -391,9 +392,10 @@ class PdfWrapper(FormWrapper):
                 fill(
                     self.stream,
                     {
-                        key: preview_widget_to_draw(value, False)
+                        key: preview_widget_to_draw(key, value, False)
                         for key, value in self.widgets.items()
                     },
+                    getattr(self, "use_full_widget_name"),
                 )
             ),
             color,
@@ -434,7 +436,9 @@ class PdfWrapper(FormWrapper):
         if self.read():
             self.widgets = set_character_x_paddings(self.stream, self.widgets)
 
-        self.stream = remove_all_widgets(fill(self.stream, self.widgets))
+        self.stream = remove_all_widgets(
+            fill(self.stream, self.widgets, getattr(self, "use_full_widget_name"))
+        )
 
         return self
 

{pypdfform-2.2.5 → pypdfform-2.2.7}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-2.2.5 → pypdfform-2.2.7}/tests/test_adobe_mode.py

@@ -2,12 +2,12 @@
 
 import os
 
-from PyPDFForm import FormWrapper
+from PyPDFForm import FormWrapper, PdfWrapper
 
 
-def test_dropdown_one(sample_template_with_dropdown, pdf_samples, request):
+def test_dropdown_two(sample_template_with_dropdown, pdf_samples, request):
     expected_path = os.path.join(
-        pdf_samples, "adobe_mode", "dropdown", "dropdown_one.pdf"
+        pdf_samples, "adobe_mode", "dropdown", "dropdown_two.pdf"
     )
     with open(expected_path, "rb+") as f:
         obj = FormWrapper(sample_template_with_dropdown).fill(
@@ -19,7 +19,7 @@ def test_dropdown_one(sample_template_with_dropdown, pdf_samples, request):
                 "check_2": True,
                 "check_3": True,
                 "radio_1": 1,
-                "dropdown_1": 0,
+                "dropdown_1": 1,
             },
             adobe_mode=True,
         )
@@ -95,3 +95,64 @@ def test_issue_613(pdf_samples, request):
 
         assert len(obj.read()) == len(expected)
         assert obj.stream == expected
+
+
+def test_sample_template_libary(pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "adobe_mode", "test_sample_template_libary.pdf"
+    )
+    template = (
+        PdfWrapper(os.path.join(pdf_samples, "dummy.pdf"))
+        .create_widget(
+            widget_type="text",
+            name="new_text_field_widget",
+            page_number=1,
+            x=60,
+            y=710,
+        )
+        .create_widget(
+            widget_type="checkbox",
+            name="new_checkbox_widget",
+            page_number=1,
+            x=100,
+            y=600,
+        )
+        .create_widget(
+            widget_type="radio",
+            name="new_radio_group",
+            page_number=1,
+            x=[50, 100, 150],
+            y=[50, 100, 150],
+        )
+        .create_widget(
+            widget_type="dropdown",
+            name="new_dropdown_widget",
+            page_number=1,
+            x=300,
+            y=710,
+            options=[
+                "foo",
+                "bar",
+                "foobar",
+            ],
+        )
+    )
+
+    with open(expected_path, "rb+") as f:
+        obj = FormWrapper(template.read()).fill(
+            {
+                "new_text_field_widget": "test text",
+                "new_checkbox_widget": True,
+                "new_radio_group": 1,
+                "new_dropdown_widget": 2,
+            },
+            adobe_mode=True,
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.stream == expected

{pypdfform-2.2.5 → pypdfform-2.2.7}/tests/test_dropdown_simple.py

@@ -75,7 +75,7 @@ def test_dropdown_two(sample_template_with_dropdown, pdf_samples, request):
 
 def test_dropdown_two_flatten(sample_template_with_dropdown, pdf_samples, request):
     expected_path = os.path.join(
-        pdf_samples, "simple", "dropdown", "dropdown_two_simple.pdf"
+        pdf_samples, "simple", "dropdown", "dropdown_two_flatten.pdf"
     )
     with open(expected_path, "rb+") as f:
         obj = FormWrapper(sample_template_with_dropdown).fill(