PyPDFForm 3.0.1__tar.gz → 3.1.0__tar.gz

{pypdfform-3.0.1 → pypdfform-3.1.0}/PKG-INFO

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

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/__init__.py

@@ -20,7 +20,7 @@ The library supports various PDF form features, including:
 PyPDFForm aims to simplify PDF form manipulation, making it accessible to developers of all skill levels.
 """
 
-__version__ = "3.0.1"
+__version__ = "3.1.0"
 
 from .middleware.text import Text  # exposing for setting global font attrs
 from .wrapper import PdfWrapper

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/filler.py

@@ -15,6 +15,7 @@ from pypdf import PdfReader, PdfWriter
 from pypdf.generic import DictionaryObject
 
 from .constants import WIDGET_TYPES, Annots
+from .hooks import flatten_generic, flatten_radio
 from .image import get_draw_image_resolutions, get_image_dimensions
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
@@ -22,9 +23,8 @@ from .middleware.image import Image
 from .middleware.radio import Radio
 from .middleware.signature import Signature
 from .middleware.text import Text
-from .patterns import (flatten_generic, flatten_radio, update_checkbox_value,
-                       update_dropdown_value, update_radio_value,
-                       update_text_value)
+from .patterns import (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
@@ -145,7 +145,9 @@ def fill(
 
             # flatten all
             if flatten:
-                (flatten_radio if isinstance(widget, Radio) else flatten_generic)(annot)
+                (flatten_radio if isinstance(widget, Radio) else flatten_generic)(
+                    annot, True
+                )
             if widget.value is None:
                 continue
 

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/hooks.py

@@ -4,7 +4,8 @@ This module defines widget hooks that allow for dynamic modification of PDF form
 
 It provides functions to trigger these hooks, enabling changes to text field properties
 like font, font size, color, alignment, and multiline settings, as well as the size
-of checkbox and radio button widgets. These hooks are triggered during the PDF form
+of checkbox and radio button widgets. It also provides functions for flattening
+generic and radio button widgets. These hooks are triggered during the PDF form
 filling process, allowing for customization of the form's appearance and behavior.
 """
 
@@ -17,7 +18,7 @@ from pypdf.generic import (ArrayObject, DictionaryObject, FloatObject,
                            NameObject, NumberObject, TextStringObject)
 
 from .constants import (COMB, DA, FONT_COLOR_IDENTIFIER, FONT_SIZE_IDENTIFIER,
-                        MULTILINE, Annots, Ff, Opt, Parent, Q, Rect)
+                        MULTILINE, READ_ONLY, Annots, Ff, Opt, Parent, Q, Rect)
 from .template import get_widget_key
 from .utils import stream_to_io
 
@@ -249,8 +250,78 @@ def update_dropdown_choices(annot: DictionaryObject, val: list) -> None:
 
     Args:
         annot (DictionaryObject): The annotation dictionary for the dropdown field.
-        val (list): A list of strings representing the new choices for the dropdown.
+        val (list): A list of strings or tuples representing the new choices for the dropdown.
     """
     annot[NameObject(Opt)] = ArrayObject(
-        [ArrayObject([TextStringObject(each), TextStringObject(each)]) for each in val]
+        [
+            (
+                ArrayObject([TextStringObject(each[1]), TextStringObject(each[0])])
+                if isinstance(each, tuple)
+                else ArrayObject([TextStringObject(each), TextStringObject(each)])
+            )
+            for each in val
+        ]
     )
+
+
+def flatten_radio(annot: DictionaryObject, val: bool) -> None:
+    """
+    Flattens a radio button annotation by setting or unsetting the ReadOnly flag,
+    making it non-editable or editable based on the `val` parameter.
+
+    This function modifies the Ff (flags) entry in the radio button's annotation
+    dictionary or its parent dictionary if `Parent` exists in `annot`, to set or
+    unset the ReadOnly flag, preventing or allowing the user from changing the
+    selected option.
+
+    Args:
+        annot (DictionaryObject): The radio button annotation dictionary.
+        val (bool): True to flatten (make read-only), False to unflatten (make editable).
+    """
+    if Parent in annot:
+        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+            (
+                int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) | READ_ONLY
+                if val
+                else int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) & ~READ_ONLY
+            )
+        )
+    else:
+        annot[NameObject(Ff)] = NumberObject(
+            (
+                int(annot.get(NameObject(Ff), 0)) | READ_ONLY
+                if val
+                else int(annot.get(NameObject(Ff), 0)) & ~READ_ONLY
+            )
+        )
+
+
+def flatten_generic(annot: DictionaryObject, val: bool) -> None:
+    """
+    Flattens a generic annotation by setting or unsetting the ReadOnly flag,
+    making it non-editable or editable based on the `val` parameter.
+
+    This function modifies the Ff (flags) entry in the annotation dictionary to
+    set or unset the ReadOnly flag, preventing or allowing the user from
+    interacting with the form field.
+
+    Args:
+        annot (DictionaryObject): The annotation dictionary.
+        val (bool): True to flatten (make read-only), False to unflatten (make editable).
+    """
+    if Parent in annot and Ff not in annot:
+        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+            (
+                int(annot.get(NameObject(Ff), 0)) | READ_ONLY
+                if val
+                else int(annot.get(NameObject(Ff), 0)) & ~READ_ONLY
+            )
+        )
+    else:
+        annot[NameObject(Ff)] = NumberObject(
+            (
+                int(annot.get(NameObject(Ff), 0)) | READ_ONLY
+                if val
+                else int(annot.get(NameObject(Ff), 0)) & ~READ_ONLY
+            )
+        )

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/middleware/base.py

@@ -21,7 +21,9 @@ class Widget:
     as name, value, and schema definition.
     """
 
-    SET_ATTR_TRIGGER_HOOK_MAP = {}
+    SET_ATTR_TRIGGER_HOOK_MAP = {
+        "readonly": "flatten_generic",
+    }
 
     def __init__(
         self,
@@ -39,6 +41,7 @@ class Widget:
         self._name = name
         self._value = value
         self.desc = None
+        self.readonly = None
         self.hooks_to_trigger = []
 
     def __setattr__(self, name: str, value: Any) -> None:

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/middleware/checkbox.py

@@ -20,10 +20,6 @@ class Checkbox(Widget):
     implements the schema_definition and sample_value properties.
     """
 
-    SET_ATTR_TRIGGER_HOOK_MAP = {
-        "size": "update_check_radio_size",
-    }
-
     def __init__(
         self,
         name: str,
@@ -39,6 +35,11 @@ class Checkbox(Widget):
         Attributes:
             size (int): The size of the checkbox. Defaults to None.
         """
+        self.SET_ATTR_TRIGGER_HOOK_MAP.update(
+            {
+                "size": "update_check_radio_size",
+            }
+        )
         super().__init__(name, value)
 
         self.size = None

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/middleware/dropdown.py

@@ -26,11 +26,6 @@ class Dropdown(Widget):
         sample_value: Returns a sample value for the dropdown.
     """
 
-    SET_ATTR_TRIGGER_HOOK_MAP = {
-        "font": "update_text_field_font",
-        "choices": "update_dropdown_choices",
-    }
-
     def __init__(
         self,
         name: str,
@@ -47,6 +42,12 @@ class Dropdown(Widget):
             font (str): The font of the dropdown field.
             choices (List[str]): The list of choices for the dropdown.
         """
+        self.SET_ATTR_TRIGGER_HOOK_MAP.update(
+            {
+                "font": "update_text_field_font",
+                "choices": "update_dropdown_choices",
+            }
+        )
         super().__init__(name, value)
 
         self.font = None

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/middleware/radio.py

@@ -34,6 +34,11 @@ class Radio(Checkbox):
         Attributes:
             number_of_options (int): The number of options for the radio button.
         """
+        self.SET_ATTR_TRIGGER_HOOK_MAP.update(
+            {
+                "readonly": "flatten_radio",
+            }
+        )
         super().__init__(name, value)
 
         self.number_of_options = 0

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/middleware/text.py

@@ -22,15 +22,6 @@ class Text(Widget):
     font_size, font_color, comb, alignment, and multiline.
     """
 
-    SET_ATTR_TRIGGER_HOOK_MAP = {
-        "font": "update_text_field_font",
-        "font_size": "update_text_field_font_size",
-        "font_color": "update_text_field_font_color",
-        "comb": "update_text_field_comb",
-        "alignment": "update_text_field_alignment",
-        "multiline": "update_text_field_multiline",
-    }
-
     def __init__(
         self,
         name: str,
@@ -52,6 +43,16 @@ class Text(Widget):
             multiline (bool): Whether the text field is multiline. Defaults to None.
             max_length (int): The maximum length of the text field. Defaults to None.
         """
+        self.SET_ATTR_TRIGGER_HOOK_MAP.update(
+            {
+                "font": "update_text_field_font",
+                "font_size": "update_text_field_font_size",
+                "font_color": "update_text_field_font_color",
+                "comb": "update_text_field_comb",
+                "alignment": "update_text_field_alignment",
+                "multiline": "update_text_field_multiline",
+            }
+        )
         super().__init__(name, value)
 
         self.font = None

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm/patterns.py

@@ -5,15 +5,14 @@ This module defines patterns and utility functions for interacting with PDF form
 It includes patterns for identifying different types of widgets (e.g., text fields,
 checkboxes, radio buttons, dropdowns, images, and signatures) based on their
 properties in the PDF's annotation dictionary. It also provides utility functions
-for updating and flattening these widgets.
+for updating these widgets.
 """
 
 from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
                            NumberObject, TextStringObject)
 
-from .constants import (AP, AS, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, READ_ONLY,
-                        TU, A, Btn, Ch, Ff, I, N, Off, Opt, Parent, Sig, T, Tx,
-                        V, Yes)
+from .constants import (AP, AS, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, TU, A, Btn,
+                        Ch, I, N, Off, Opt, Parent, Sig, T, Tx, V, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -177,42 +176,6 @@ def update_text_value(annot: DictionaryObject, widget: Text) -> None:
         annot[NameObject(AP)] = TextStringObject(widget.value)
 
 
-def flatten_radio(annot: DictionaryObject) -> None:
-    """
-    Flattens a radio button annotation by setting the ReadOnly flag, making it non-editable.
-
-    This function modifies the Ff (flags) entry in the radio button's parent
-    dictionary to set the ReadOnly flag, preventing the user from changing the
-    selected option.
-
-    Args:
-        annot (DictionaryObject): The radio button annotation dictionary.
-    """
-    annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
-        int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) | READ_ONLY
-    )
-
-
-def flatten_generic(annot: DictionaryObject) -> None:
-    """
-    Flattens a generic annotation by setting the ReadOnly flag, making it non-editable.
-
-    This function modifies the Ff (flags) entry in the annotation dictionary to
-    set the ReadOnly flag, preventing the user from interacting with the form field.
-
-    Args:
-        annot (DictionaryObject): The annotation dictionary.
-    """
-    if Parent in annot and Ff not in annot:
-        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
-            int(annot.get(NameObject(Ff), 0)) | READ_ONLY
-        )
-    else:
-        annot[NameObject(Ff)] = NumberObject(
-            int(annot.get(NameObject(Ff), 0)) | READ_ONLY
-        )
-
-
 def update_annotation_name(annot: DictionaryObject, val: str) -> None:
     """
     Updates the name of an annotation, setting the T (title) entry.

{pypdfform-3.0.1 → pypdfform-3.1.0}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-3.0.1 → pypdfform-3.1.0}/tests/test_create_widget.py

@@ -832,6 +832,34 @@ def test_create_dropdown(template_stream, pdf_samples, sample_font_stream, reque
         assert obj.read() == expected
 
 
+def test_create_dropdown_with_export_values(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "widget", "test_create_dropdown_with_export_values.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).create_widget(
+            widget_type="dropdown",
+            name="new_dropdown_widget",
+            page_number=1,
+            x=57,
+            y=700,
+            options=[
+                ("foo", "foo_export"),
+                ("bar", "bar_export"),
+                ("foobar", "foobar_export"),
+            ],
+        )
+        assert obj.schema["properties"]["new_dropdown_widget"]["type"] == "integer"
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
 def test_fill_cmyk_color(pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "widget", "test_fill_cmyk_color.pdf")
     with open(expected_path, "rb+") as f:

{pypdfform-3.0.1 → pypdfform-3.1.0}/tests/test_dropdown.py

@@ -290,6 +290,33 @@ def test_dropdown_alignment_flatten(dropdown_alignment, pdf_samples, request):
             assert obj.read() == expected
 
 
+def test_dropdown_alignment_flatten_then_unflatten(
+    dropdown_alignment, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples, "dropdown", "test_dropdown_alignment_flatten_then_unflatten.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(dropdown_alignment).fill(
+            {
+                "dropdown_left": 0,
+                "dropdown_center": 1,
+                "dropdown_right": 2,
+            },
+            flatten=True,
+        )
+        obj.widgets["dropdown_center"].readonly = False
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        if os.name != "nt":
+            assert len(obj.read()) == len(expected)
+            assert obj.read() == expected
+
+
 def test_dropdown_alignment_sejda(dropdown_alignment_sejda, pdf_samples, request):
     expected_path = os.path.join(
         pdf_samples, "dropdown", "test_dropdown_alignment_sejda.pdf"
@@ -343,6 +370,37 @@ def test_dropdown_alignment_sejda_flatten(
         assert obj.read() == expected
 
 
+def test_dropdown_alignment_sejda_flatten_then_unflatten(
+    dropdown_alignment_sejda, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples,
+        "dropdown",
+        "test_dropdown_alignment_sejda_flatten_then_unflatten.pdf",
+    )
+    with open(
+        expected_path,
+        "rb+",
+    ) as f:
+        obj = PdfWrapper(dropdown_alignment_sejda).fill(
+            {
+                "dropdown_left": 0,
+                "dropdown_center": 1,
+                "dropdown_right": 2,
+            },
+            flatten=True,
+        )
+        obj.widgets["dropdown_center"].readonly = False
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
 def test_change_dropdown_choices(sample_template_with_dropdown, pdf_samples, request):
     expected_path = os.path.join(
         pdf_samples, "dropdown", "test_change_dropdown_choices.pdf"
@@ -358,3 +416,25 @@ def test_change_dropdown_choices(sample_template_with_dropdown, pdf_samples, req
 
         assert len(obj.read()) == len(expected)
         assert obj.read() == expected
+
+
+def test_change_dropdown_choices_with_export_values(
+    sample_template_with_dropdown, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples, "dropdown", "test_change_dropdown_choices_with_export_values.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(sample_template_with_dropdown, adobe_mode=True)
+        obj.widgets["dropdown_1"].choices = [
+            ("apple", "apple_export"),
+            ("banana", "banana_export"),
+        ]
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected

{pypdfform-3.0.1 → pypdfform-3.1.0}/tests/test_functional.py

@@ -55,6 +55,24 @@ def test_fill_flatten(template_stream, pdf_samples, data_dict, request):
         assert obj.read() == expected
 
 
+def test_fill_flatten_then_unflatten(template_stream, pdf_samples, data_dict, request):
+    expected_path = os.path.join(pdf_samples, "test_fill_flatten_then_unflatten.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).fill(data_dict, flatten=True)
+        obj.widgets["test_2"].readonly = False
+        obj.widgets["check_3"].readonly = False
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+        assert len(obj.read()) == len(obj.read())
+        assert obj.read() == obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
 def test_register_bad_fonts():
     assert not PdfWrapper().register_font("foo", b"foo").read()
     assert not PdfWrapper().register_font("foo", "foo").read()
@@ -324,6 +342,35 @@ def test_fill_radiobutton_flatten(
         assert obj.read() == expected
 
 
+def test_fill_radiobutton_flatten_then_unflatten(
+    template_with_radiobutton_stream, pdf_samples, request
+):
+    expected_path = os.path.join(
+        pdf_samples, "test_fill_radiobutton_flatten_then_unflatten.pdf"
+    )
+    with open(
+        expected_path,
+        "rb+",
+    ) as f:
+        obj = PdfWrapper(template_with_radiobutton_stream).fill(
+            {
+                "radio_1": 0,
+                "radio_2": 1,
+                "radio_3": 2,
+            },
+            flatten=True,
+        )
+        obj.widgets["radio_2"].readonly = False
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
 def test_fill_sejda(sejda_template, pdf_samples, sejda_data, request):
     expected_path = os.path.join(pdf_samples, "test_fill_sejda.pdf")
     with open(
@@ -361,6 +408,33 @@ def test_fill_sejda_flatten(sejda_template, pdf_samples, sejda_data, request):
         assert obj.read() == expected
 
 
+def test_fill_sejda_flatten_then_unflatten(
+    sejda_template, pdf_samples, sejda_data, request
+):
+    expected_path = os.path.join(
+        pdf_samples, "test_fill_sejda_flatten_then_unflatten.pdf"
+    )
+    with open(
+        expected_path,
+        "rb+",
+    ) as f:
+        obj = PdfWrapper(sejda_template).fill(
+            sejda_data,
+            flatten=True,
+        )
+        obj.widgets["buyer_name"].readonly = False
+        obj.widgets["at_future_date"].readonly = False
+        obj.widgets["purchase_option"].readonly = False
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected
+
+
 def test_draw_text_on_one_page(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "test_draw_text_on_one_page.pdf")
     with open(expected_path, "rb+") as f: