PyPDFForm 2.3.2__py3-none-any.whl → 2.4.0__py3-none-any.whl

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.3.2"
+__version__ = "2.4.0"
 
 from .wrapper import FormWrapper, PdfWrapper
 

PyPDFForm/filler.py

@@ -34,13 +34,12 @@ from .middleware.image import Image
 from .middleware.radio import Radio
 from .middleware.signature import Signature
 from .middleware.text import Text
-from .patterns import (WIDGET_KEY_PATTERNS, simple_flatten_generic,
-                       simple_flatten_radio, simple_update_checkbox_value,
+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 .template import get_widget_full_key, get_widgets_by_page
-from .utils import (checkbox_radio_to_draw, extract_widget_property,
-                    stream_to_io)
+from .template import get_widget_key, get_widgets_by_page
+from .utils import checkbox_radio_to_draw, stream_to_io
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
 
 
@@ -254,9 +253,7 @@ def fill(
         ellipse_borders_to_draw[page] = []
         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)
+            key = get_widget_key(widget_dict, use_full_widget_name)
             text_needs_to_be_drawn = False
             to_draw = x = y = None
 
@@ -340,6 +337,7 @@ def enable_adobe_mode(reader: PdfReader, writer: PdfWriter, adobe_mode: bool) ->
 def simple_fill(
     template: bytes,
     widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
     flatten: bool = False,
     adobe_mode: bool = False,
 ) -> bytes:
@@ -353,6 +351,7 @@ def simple_fill(
     Args:
         template: 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
         flatten: If True, makes form fields read-only
         adobe_mode: If True, enables Adobe Acrobat compatibility
 
@@ -370,9 +369,7 @@ def simple_fill(
     for page in out.pages:
         for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
-            key = extract_widget_property(
-                annot.get_object(), WIDGET_KEY_PATTERNS, None, str
-            )
+            key = get_widget_key(annot.get_object(), use_full_widget_name)
 
             widget = widgets.get(key)
             if widget is None or widget.value is None:

PyPDFForm/middleware/base.py

@@ -40,7 +40,6 @@ class Widget:
 
         super().__init__()
         self._name = name
-        self.full_name = None
         self._value = value
         self.desc = None
         self.border_color = None

PyPDFForm/template.py

@@ -60,9 +60,7 @@ def set_character_x_paddings(
 
     for _widgets in get_widgets_by_page(pdf_stream).values():
         for widget in _widgets:
-            key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
-            if use_full_widget_name:
-                key = get_widget_full_key(widget)
+            key = get_widget_key(widget, use_full_widget_name)
             _widget = widgets[key]
 
             if isinstance(_widget, Text) and _widget.comb is True:
@@ -91,11 +89,9 @@ def build_widgets(
 
     for widgets in get_widgets_by_page(pdf_stream).values():
         for widget in widgets:
-            key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
+            key = get_widget_key(widget, use_full_widget_name)
             _widget = construct_widget(widget, key)
             if _widget is not None:
-                if use_full_widget_name:
-                    _widget.full_name = get_widget_full_key(widget)
 
                 _widget.render_widget = render_widgets
                 _widget.desc = extract_widget_property(
@@ -141,8 +137,7 @@ def build_widgets(
                     continue
 
                 results[key] = _widget
-                if _widget.full_name is not None and use_full_widget_name:
-                    results[_widget.full_name] = results[key]
+
     return results
 
 
@@ -201,9 +196,7 @@ def update_text_field_attributes(
 
     for _widgets in get_widgets_by_page(template_stream).values():
         for _widget in _widgets:
-            key = extract_widget_property(_widget, WIDGET_KEY_PATTERNS, None, str)
-            if use_full_widget_name:
-                key = get_widget_full_key(_widget)
+            key = get_widget_key(_widget, use_full_widget_name)
 
             if isinstance(widgets[key], Text):
                 should_adjust_font_size = False
@@ -267,24 +260,32 @@ def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     return result
 
 
-def get_widget_full_key(widget: dict) -> str:
-    """Constructs a widget's full hierarchical key including parent names.
+def get_widget_key(widget: dict, use_full_widget_name: bool) -> str:
+    """Constructs a widget's key, optionally including parent names based on `use_full_widget_name`.
+
+    This function recursively builds the full key by appending parent names if `use_full_widget_name` is True.
+    If `use_full_widget_name` is False, it returns the widget's key directly.
 
     Args:
-        widget: PDF widget dictionary
+        widget (dict): PDF widget dictionary.
+        use_full_widget_name (bool): Whether to include parent widget names in the key.
 
     Returns:
-        str: Full key in format "parent.child" if parent exists, otherwise the widget's key
+        str: Full key in format "parent.child" if parent exists and `use_full_widget_name` is True, otherwise the widget's key.
     """
 
     key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
+    if not use_full_widget_name:
+        return key
 
     if (
         Parent in widget
         and T in widget[Parent].get_object()
         and widget[Parent].get_object()[T] != key
     ):
-        key = f"{get_widget_full_key(widget[Parent].get_object())}.{key}"
+        key = (
+            f"{get_widget_key(widget[Parent].get_object(), use_full_widget_name)}.{key}"
+        )
 
     return key
 
@@ -592,9 +593,7 @@ def update_widget_keys(
         for page in out.pages:
             for annot in page.get(Annots, []):
                 annot = cast(DictionaryObject, annot.get_object())
-                key = extract_widget_property(
-                    annot.get_object(), WIDGET_KEY_PATTERNS, None, str
-                )
+                key = get_widget_key(annot.get_object(), False)
 
                 widget = widgets.get(key)
                 if widget is None:

PyPDFForm/watermark.py

@@ -18,8 +18,8 @@ from reportlab.lib.utils import ImageReader
 from reportlab.pdfgen.canvas import Canvas
 
 from .constants import Annots
-from .patterns import WIDGET_KEY_PATTERNS
-from .utils import extract_widget_property, stream_to_io
+from .template import get_widget_key
+from .utils import stream_to_io
 
 
 def draw_text(canvas: Canvas, **kwargs) -> None:
@@ -381,9 +381,7 @@ def copy_watermark_widgets(
         for j, page in enumerate(watermark_file.pages):
             widgets_to_copy_pdf[j] = []
             for annot in page.get(Annots, []):
-                key = extract_widget_property(
-                    annot.get_object(), WIDGET_KEY_PATTERNS, None, str
-                )
+                key = get_widget_key(annot.get_object(), False)
                 if (keys is None or key in keys) and (
                     page_num is None or page_num == j
                 ):

PyPDFForm/widgets/base.py

@@ -16,8 +16,9 @@ from reportlab.lib.colors import Color
 from reportlab.pdfgen.canvas import Canvas
 
 from ..constants import Annots
-from ..patterns import NON_ACRO_FORM_PARAM_TO_FUNC, WIDGET_KEY_PATTERNS
-from ..utils import extract_widget_property, stream_to_io
+from ..patterns import NON_ACRO_FORM_PARAM_TO_FUNC
+from ..template import get_widget_key
+from ..utils import stream_to_io
 
 
 class Widget:
@@ -156,9 +157,7 @@ def handle_non_acro_form_params(pdf: bytes, key: str, params: list) -> bytes:
     for page in out.pages:
         for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
-            _key = extract_widget_property(
-                annot.get_object(), WIDGET_KEY_PATTERNS, None, str
-            )
+            _key = get_widget_key(annot.get_object(), False)
 
             if _key == key:
                 for param in params:

PyPDFForm/widgets/signature.py

@@ -14,8 +14,8 @@ from pypdf.generic import (ArrayObject, FloatObject, NameObject,
                            TextStringObject)
 
 from ..constants import Annots, Rect, T
-from ..patterns import WIDGET_KEY_PATTERNS
-from ..utils import extract_widget_property, stream_to_io
+from ..template import get_widget_key
+from ..utils import stream_to_io
 from .bedrock import BEDROCK_PDF
 
 
@@ -107,9 +107,7 @@ class SignatureWidget:
 
         for page in out.pages:
             for annot in page.get(Annots, []):
-                key = extract_widget_property(
-                    annot.get_object(), WIDGET_KEY_PATTERNS, None, str
-                )
+                key = get_widget_key(annot.get_object(), False)
 
                 if key != self.BEDROCK_WIDGET_TO_COPY:
                     continue

PyPDFForm/wrapper.py

@@ -62,16 +62,21 @@ class FormWrapper:
     def __init__(
         self,
         template: Union[bytes, str, BinaryIO] = b"",
+        **kwargs,
     ) -> None:
         """Initializes the base form wrapper with a PDF template.
 
         Args:
             template: PDF form as bytes, file path, or file object. Defaults to
                 empty bytes if not provided.
+            **kwargs: Additional options:
+                use_full_widget_name: If True, uses complete widget names including
+                    field hierarchy (default: False)
 
         Initializes:
             - Internal PDF stream from the template
             - Basic form filling capabilities
+            - Widget naming configuration from kwargs
 
         Note:
             This base class is designed to be extended by PdfWrapper which adds
@@ -80,6 +85,7 @@ class FormWrapper:
 
         super().__init__()
         self.stream = fp_or_f_obj_or_stream_to_stream(template)
+        self.use_full_widget_name = kwargs.get("use_full_widget_name", False)
 
     def read(self) -> bytes:
         """Returns the raw bytes of the PDF form data.
@@ -102,20 +108,34 @@ class FormWrapper:
         """Fills form fields in the PDF with provided values.
 
         Takes a dictionary of field names to values and updates the corresponding
-        form fields in the PDF. Only fields that exist in the template PDF will
-        be filled - unknown field names are silently ignored.
+        form fields in the PDF. Supports these value types:
+            - Strings for text fields
+            - Booleans for checkboxes (True=checked, False=unchecked)
+            - Integers for numeric fields and dropdown selections
+
+        Only fields that exist in the template PDF will be filled - unknown field
+        names are silently ignored.
 
         Args:
-            data: Dictionary mapping field names to values (str, bool or int)
+            data: Dictionary mapping field names to values. Supported types:
+                str: For text fields
+                bool: For checkboxes (True=checked)
+                int: For numeric fields and dropdown selections
             **kwargs: Additional options:
-                flatten: If True, makes form fields read-only after filling
-                adobe_mode: If True, uses Adobe-compatible filling logic
+                flatten (bool): If True, makes form fields read-only after filling
+                    (default: False)
+                adobe_mode (bool): If True, uses Adobe-compatible filling logic
+                    (default: False)
 
         Returns:
             FormWrapper: Returns self to allow method chaining
         """
 
-        widgets = build_widgets(self.stream, False, False) if self.stream else {}
+        widgets = (
+            build_widgets(self.stream, self.use_full_widget_name, False)
+            if self.stream
+            else {}
+        )
 
         for key, value in data.items():
             if key in widgets:
@@ -124,6 +144,7 @@ class FormWrapper:
         self.stream = simple_fill(
             self.read(),
             widgets,
+            use_full_widget_name=self.use_full_widget_name,
             flatten=kwargs.get("flatten", False),
             adobe_mode=kwargs.get("adobe_mode", False),
         )
@@ -249,13 +270,7 @@ class PdfWrapper(FormWrapper):
             dict: Field names mapped to their sample values
         """
 
-        result = {}
-        for key, value in self.widgets.items():
-            if getattr(self, "use_full_widget_name") and key != value.full_name:
-                continue
-            result[key] = value.sample_value
-
-        return result
+        return {key: value.sample_value for key, value in self.widgets.items()}
 
     @property
     def version(self) -> Union[str, None]:
@@ -712,13 +727,12 @@ class PdfWrapper(FormWrapper):
             dict: A JSON Schema dictionary following Draft 7 format
         """
 
-        result = {}
-        for key, value in self.widgets.items():
-            if getattr(self, "use_full_widget_name") and key != value.full_name:
-                continue
-            result[key] = value.schema_definition
-
-        return {"type": "object", "properties": result}
+        return {
+            "type": "object",
+            "properties": {
+                key: value.schema_definition for key, value in self.widgets.items()
+            },
+        }
 
     @classmethod
     def register_font(

{pypdfform-2.3.2.dist-info → pypdfform-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.3.2
+Version: 2.4.0
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -10,7 +10,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -18,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography

{pypdfform-2.3.2.dist-info → pypdfform-2.4.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
-PyPDFForm/__init__.py,sha256=-8q8goejLmKZqbaQz1MzZVHcxV6d5qFgHpq0OPXHirw,328
+PyPDFForm/__init__.py,sha256=TrLXIaBX68LQ3KQc6d_tR2c7UnzA3uXZ90KmNZuoiYM,328
 PyPDFForm/adapter.py,sha256=_5fP5UR-NzjDDayJmBRO36DgbnbUzNbjZtHZtPvSM14,1909
 PyPDFForm/constants.py,sha256=3ed0j11cWd9Uo4s-XvZwwJojPSz8aqdmZgaEishWjqE,2342
 PyPDFForm/coordinate.py,sha256=gQI7z-GsdCO33Qny5kXLBs6Y2TW5KO_mJ2in64fvXcg,16412
-PyPDFForm/filler.py,sha256=HrvgRrAjai9TFOr-bQBH9dlwmEGQsNZgKpOEFfDsXtg,14215
+PyPDFForm/filler.py,sha256=oCXDzz8paw8-MIQLiTTv5goYlfCfz_EcczCj8K4JB3g,14116
 PyPDFForm/font.py,sha256=eRbDyQFhXUkHzyZvCtru9Ypg_ukfbBAnSM5xNzPb5ss,7280
 PyPDFForm/image.py,sha256=aYk7BC-AHiqt73durGIQ3e6gE5Ggbdr8jmkCUaQdsk8,1627
 PyPDFForm/patterns.py,sha256=VH7cgAFHLKEUIfE1yIlifIJ9mc0Eb2Kqo-krk34HGOY,9316
-PyPDFForm/template.py,sha256=geZUB8a_otsHa5Q7dO0JH9md1WFodE7Dl_alBhqiU18,20128
+PyPDFForm/template.py,sha256=N_Pj3SaSKs3sqIuIdtgHPXvxIHLnHeR2M9IwRCWWKoQ,20043
 PyPDFForm/utils.py,sha256=QxJSG96FHGch863UdBPT8DdTKN9gVzQzA2ezifTm7z4,8575
-PyPDFForm/watermark.py,sha256=Zmx4orMrQRMoOWGYo4bvVhxptMXFnCM4RshagTp8LFY,12459
-PyPDFForm/wrapper.py,sha256=UxgjdBWgoqALUkCmFUDVJKqIL3uud3ChG_gcieRdGkc,25933
+PyPDFForm/watermark.py,sha256=yvtZKcdPAPprBVEWcFZEnZMJcTwVpQ6u72m0jqYHxx8,12357
+PyPDFForm/wrapper.py,sha256=jiuO-GBqAlQgWfXgPZB4dWpF7_t4UpdMokn9XBDGdEI,26582
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-PyPDFForm/middleware/base.py,sha256=d4z7M7pm80176cC4H85m3ZRWzAu_Fm1HkwQkmSSi-WE,2832
+PyPDFForm/middleware/base.py,sha256=Ex--sUtQqpjFYWi3oAMqjuay_HYToHFMwRtdgWusckI,2802
 PyPDFForm/middleware/checkbox.py,sha256=gRGhFySPoIpKBseoiOTS3WggoBBik12dXbZ-LJKzIwM,2611
 PyPDFForm/middleware/dropdown.py,sha256=McuZl8Pc2IYPkEHRmM1OcEsh9njekySqjqVxRmQKmWU,1773
 PyPDFForm/middleware/image.py,sha256=HlPUsIktj-NryIkwwdZlilvrd6sZYifs9IuDgTHp7uQ,950
@@ -19,16 +19,16 @@ PyPDFForm/middleware/radio.py,sha256=M4yqHYzHj0jvOGbjYdqeYnNAlYhTF-h47qxqrjXDOoU
 PyPDFForm/middleware/signature.py,sha256=0gexCQwHCEOrjrgvUXeJJCGo2plfSEbXlykPJJCqpfA,2380
 PyPDFForm/middleware/text.py,sha256=eAxeVwboPPlnDT4aaOi7UpQ_xPmnlzkIbUOtRm1VMd0,2944
 PyPDFForm/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-PyPDFForm/widgets/base.py,sha256=cVJzGuZTWE7sWTKlEV4Keh8AGglpQ-i379hEiSHvU18,5402
+PyPDFForm/widgets/base.py,sha256=nzRmZFRXjc4fKySMwVQs6YzPxnhnxcgFWnMUvOySWz4,5330
 PyPDFForm/widgets/bedrock.py,sha256=j6beU04kaQzpAIFZHI5VJLaDT5RVAAa6LzkU1luJpN8,137660
 PyPDFForm/widgets/checkbox.py,sha256=_1I5yh1211RgRUyWzd3NNYpI9JchqJNSJWaZAhl2uOo,1248
 PyPDFForm/widgets/dropdown.py,sha256=zszIT5MI6ggBRUEn7oGBKK0pKmDC9LQw3RnqaKG8ocQ,1764
 PyPDFForm/widgets/image.py,sha256=6y8Ysmk49USr_qWOXD6KGL6cch516cUIlrxoj0pJy9Q,797
 PyPDFForm/widgets/radio.py,sha256=ipadJyHbgftDUvjGk15kapzgHPN3HjdF_iB_7amXR6o,2737
-PyPDFForm/widgets/signature.py,sha256=8z1sOOgcvhQtLXZ5TeTd59oVtkNGTrgQtZRfuaOWR8w,5099
+PyPDFForm/widgets/signature.py,sha256=FdXzja3RTuyU9iyA5Y1yPb4Gsfe4rYlM4gcwekIuwog,4997
 PyPDFForm/widgets/text.py,sha256=HP2cPEUAzK5QL3kDfMz7gQcC3svCpmYuyFItBjlrBpI,1233
-pypdfform-2.3.2.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-pypdfform-2.3.2.dist-info/METADATA,sha256=IiQplBGHDSThpZI9ZqOokbyVxbd9zq1Za_JDksfSNzI,4738
-pypdfform-2.3.2.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-pypdfform-2.3.2.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-pypdfform-2.3.2.dist-info/RECORD,,
+pypdfform-2.4.0.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+pypdfform-2.4.0.dist-info/METADATA,sha256=6g0a3hKc0j1JYVkG7kEVK0iBdZc6bKMVyf2LSEt6VgA,4688
+pypdfform-2.4.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+pypdfform-2.4.0.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+pypdfform-2.4.0.dist-info/RECORD,,

{pypdfform-2.3.2.dist-info → pypdfform-2.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.4.0)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any