Merge pull request #1048 from chinapandaman/PPF-1047

PPF-1047: rename simple functions, move enable_adobe_mode to utils

Author: chinapandaman

PyPDFForm/filler.py

@@ -9,25 +9,23 @@
 Adobe-specific settings for improved rendering in Adobe Reader.
 """
 
-from functools import lru_cache
 from io import BytesIO
 from typing import Dict, Union, cast
 
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import BooleanObject, DictionaryObject, NameObject
+from pypdf.generic import DictionaryObject
 
-from .constants import WIDGET_TYPES, AcroForm, Annots, NeedAppearances, Root
+from .constants import WIDGET_TYPES, Annots
 from .image import get_draw_image_resolutions, get_image_dimensions
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
 from .middleware.radio import Radio
 from .middleware.signature import Signature
 from .middleware.text import Text
-from .patterns import (simple_flatten_generic, simple_flatten_radio,
-                       simple_update_checkbox_value,
-                       simple_update_dropdown_value, simple_update_radio_value,
-                       simple_update_text_value)
+from .patterns import (flatten_generic, flatten_radio, update_checkbox_value,
+                       update_dropdown_value, update_radio_value,
+                       update_text_value)
 from .template import get_widget_key
 from .utils import stream_to_io
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
@@ -101,42 +99,7 @@ def get_drawn_stream(to_draw: dict, stream: bytes, action: str) -> bytes:
     return merge_watermarks_with_pdf(stream, watermark_list)
 
 
-@lru_cache
-def enable_adobe_mode(pdf: bytes) -> bytes:
-    """Enables Adobe-specific settings in the PDF to ensure proper rendering of form fields.
-
-    This function modifies the PDF's AcroForm dictionary to include the `NeedAppearances` flag,
-    which forces Adobe Reader to generate appearance streams for form fields. This ensures that
-    the form fields are rendered correctly in Adobe Reader, especially when the form is filled
-    programmatically.
-
-    Args:
-        pdf (bytes): The PDF content as bytes.
-
-    Returns:
-        bytes: The modified PDF content with Adobe mode enabled.
-    """
-    reader = PdfReader(stream_to_io(pdf))
-    writer = PdfWriter()
-
-    # https://stackoverflow.com/questions/47288578/pdf-form-filled-with-pypdf2-does-not-show-in-print
-    if AcroForm in reader.trailer[Root]:
-        if NeedAppearances in reader.trailer[Root][AcroForm]:
-            return pdf
-    else:
-        reader.trailer[Root].update({NameObject(AcroForm): DictionaryObject()})
-    reader.trailer[Root][AcroForm].update(
-        {NameObject(NeedAppearances): BooleanObject(True)}
-    )
-    writer.append(reader)
-
-    with BytesIO() as f:
-        writer.write(f)
-        f.seek(0)
-        return f.read()
-
-
-def simple_fill(
+def fill(
     template: bytes,
     widgets: Dict[str, WIDGET_TYPES],
     use_full_widget_name: bool,
@@ -185,9 +148,9 @@ def simple_fill(
             # flatten all
             if flatten:
                 if isinstance(widget, Radio):
-                    simple_flatten_radio(annot)
+                    flatten_radio(annot)
                 else:
-                    simple_flatten_generic(annot)
+                    flatten_generic(annot)
             if widget.value is None:
                 continue
 
@@ -196,17 +159,17 @@ def simple_fill(
                     annot, widgets[key], images_to_draw[page_num + 1]
                 )
             elif type(widget) is Checkbox:
-                simple_update_checkbox_value(annot, widget.value)
+                update_checkbox_value(annot, widget.value)
             elif isinstance(widget, Radio):
                 if key not in radio_button_tracker:
                     radio_button_tracker[key] = 0
                 radio_button_tracker[key] += 1
                 if widget.value == radio_button_tracker[key] - 1:
-                    simple_update_radio_value(annot)
+                    update_radio_value(annot)
             elif isinstance(widget, Dropdown):
-                simple_update_dropdown_value(annot, widget)
+                update_dropdown_value(annot, widget)
             elif isinstance(widget, Text):
-                simple_update_text_value(annot, widget)
+                update_text_value(annot, widget)
 
     with BytesIO() as f:
         out.write(f)

PyPDFForm/patterns.py

@@ -96,7 +96,7 @@
 ]
 
 
-def simple_update_checkbox_value(annot: DictionaryObject, check: bool = False) -> None:
+def update_checkbox_value(annot: DictionaryObject, check: bool = False) -> None:
     """
     Updates the value of a checkbox annotation, setting it to checked or unchecked.
 
@@ -114,7 +114,7 @@ def simple_update_checkbox_value(annot: DictionaryObject, check: bool = False) -
             break
 
 
-def simple_update_radio_value(annot: DictionaryObject) -> None:
+def update_radio_value(annot: DictionaryObject) -> None:
     """
     Updates the value of a radio button annotation, selecting it.
 
@@ -134,7 +134,7 @@ def simple_update_radio_value(annot: DictionaryObject) -> None:
             break
 
 
-def simple_update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> None:
+def update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> None:
     """
     Updates the value of a dropdown annotation, selecting an option from the list.
 
@@ -157,7 +157,7 @@ def simple_update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> N
         annot[NameObject(I)] = ArrayObject([NumberObject(widget.value)])
 
 
-def simple_update_text_value(annot: DictionaryObject, widget: Text) -> None:
+def update_text_value(annot: DictionaryObject, widget: Text) -> None:
     """
     Updates the value of a text annotation, setting the text content.
 
@@ -176,7 +176,7 @@ def simple_update_text_value(annot: DictionaryObject, widget: Text) -> None:
         annot[NameObject(AP)] = TextStringObject(widget.value)
 
 
-def simple_flatten_radio(annot: DictionaryObject) -> None:
+def flatten_radio(annot: DictionaryObject) -> None:
     """
     Flattens a radio button annotation by setting the ReadOnly flag, making it non-editable.
 
@@ -192,7 +192,7 @@ def simple_flatten_radio(annot: DictionaryObject) -> None:
     )
 
 
-def simple_flatten_generic(annot: DictionaryObject) -> None:
+def flatten_generic(annot: DictionaryObject) -> None:
     """
     Flattens a generic annotation by setting the ReadOnly flag, making it non-editable.
 

PyPDFForm/utils.py

@@ -20,9 +20,9 @@
 from typing import Any, BinaryIO, List, Union
 
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import DictionaryObject
+from pypdf.generic import BooleanObject, DictionaryObject, NameObject
 
-from .constants import UNIQUE_SUFFIX_LENGTH
+from .constants import UNIQUE_SUFFIX_LENGTH, AcroForm, NeedAppearances, Root
 
 
 @lru_cache
@@ -49,6 +49,41 @@ def stream_to_io(stream: bytes) -> BinaryIO:
     return result
 
 
+@lru_cache
+def enable_adobe_mode(pdf: bytes) -> bytes:
+    """Enables Adobe-specific settings in the PDF to ensure proper rendering of form fields.
+
+    This function modifies the PDF's AcroForm dictionary to include the `NeedAppearances` flag,
+    which forces Adobe Reader to generate appearance streams for form fields. This ensures that
+    the form fields are rendered correctly in Adobe Reader, especially when the form is filled
+    programmatically.
+
+    Args:
+        pdf (bytes): The PDF content as bytes.
+
+    Returns:
+        bytes: The modified PDF content with Adobe mode enabled.
+    """
+    reader = PdfReader(stream_to_io(pdf))
+    writer = PdfWriter()
+
+    # https://stackoverflow.com/questions/47288578/pdf-form-filled-with-pypdf2-does-not-show-in-print
+    if AcroForm in reader.trailer[Root]:
+        if NeedAppearances in reader.trailer[Root][AcroForm]:
+            return pdf
+    else:
+        reader.trailer[Root].update({NameObject(AcroForm): DictionaryObject()})
+    reader.trailer[Root][AcroForm].update(
+        {NameObject(NeedAppearances): BooleanObject(True)}
+    )
+    writer.append(reader)
+
+    with BytesIO() as f:
+        writer.write(f)
+        f.seek(0)
+        return f.read()
+
+
 def remove_all_widgets(pdf: bytes) -> bytes:
     """
     Removes all widgets (form fields) from a PDF, effectively flattening the form.

PyPDFForm/wrapper.py

@@ -25,16 +25,16 @@
 from .constants import (DEFAULT_FONT, DEFAULT_FONT_COLOR, DEFAULT_FONT_SIZE,
                         VERSION_IDENTIFIER_PREFIX, VERSION_IDENTIFIERS)
 from .coordinate import generate_coordinate_grid
-from .filler import enable_adobe_mode, simple_fill
+from .filler import fill
 from .font import (get_all_available_fonts, register_font,
                    register_font_acroform)
 from .hooks import trigger_widget_hooks
 from .image import rotate_image
 from .middleware.signature import Signature
 from .middleware.text import Text
 from .template import build_widgets, update_widget_keys
-from .utils import (generate_unique_suffix, get_page_streams, merge_two_pdfs,
-                    remove_all_widgets)
+from .utils import (enable_adobe_mode, generate_unique_suffix,
+                    get_page_streams, merge_two_pdfs, remove_all_widgets)
 from .watermark import (copy_watermark_widgets, create_watermarks_and_draw,
                         merge_watermarks_with_pdf)
 from .widgets.checkbox import CheckBoxWidget
@@ -387,7 +387,7 @@ def fill(
             if key in self.widgets:
                 self.widgets[key].value = value
 
-        filled_stream, image_drawn_stream = simple_fill(
+        filled_stream, image_drawn_stream = fill(
             self.read(),
             self.widgets,
             use_full_widget_name=getattr(self, "use_full_widget_name"),