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

PyPDFForm/filler.py

@@ -337,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:
@@ -350,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
 
@@ -367,7 +369,7 @@ def simple_fill(
     for page in out.pages:
         for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
-            key = get_widget_key(annot.get_object(), False)
+            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/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),
         )

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.3.3
+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.3.dist-info → pypdfform-2.4.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
-PyPDFForm/__init__.py,sha256=CIeFI9ZbT-rwWJRuFoM1sf-_594uyi0_dZQZR9f8b2Y,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=zyI_dBATc6ldZlJnQHhryj221CwWdkyVtlcrIYPhXvQ,13967
+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=N_Pj3SaSKs3sqIuIdtgHPXvxIHLnHeR2M9IwRCWWKoQ,20043
 PyPDFForm/utils.py,sha256=QxJSG96FHGch863UdBPT8DdTKN9gVzQzA2ezifTm7z4,8575
 PyPDFForm/watermark.py,sha256=yvtZKcdPAPprBVEWcFZEnZMJcTwVpQ6u72m0jqYHxx8,12357
-PyPDFForm/wrapper.py,sha256=hBgSkHq0VjzY5VDdT_XHmHt6yr2LPq6hXqBy-LcJCdc,25674
+PyPDFForm/wrapper.py,sha256=jiuO-GBqAlQgWfXgPZB4dWpF7_t4UpdMokn9XBDGdEI,26582
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 PyPDFForm/middleware/base.py,sha256=Ex--sUtQqpjFYWi3oAMqjuay_HYToHFMwRtdgWusckI,2802
 PyPDFForm/middleware/checkbox.py,sha256=gRGhFySPoIpKBseoiOTS3WggoBBik12dXbZ-LJKzIwM,2611
@@ -27,8 +27,8 @@ PyPDFForm/widgets/image.py,sha256=6y8Ysmk49USr_qWOXD6KGL6cch516cUIlrxoj0pJy9Q,79
 PyPDFForm/widgets/radio.py,sha256=ipadJyHbgftDUvjGk15kapzgHPN3HjdF_iB_7amXR6o,2737
 PyPDFForm/widgets/signature.py,sha256=FdXzja3RTuyU9iyA5Y1yPb4Gsfe4rYlM4gcwekIuwog,4997
 PyPDFForm/widgets/text.py,sha256=HP2cPEUAzK5QL3kDfMz7gQcC3svCpmYuyFItBjlrBpI,1233
-pypdfform-2.3.3.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-pypdfform-2.3.3.dist-info/METADATA,sha256=Xvokh3kh7VxfWjHqELYDLiEGPZdPAGeNk7PS0ePk7BQ,4738
-pypdfform-2.3.3.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-pypdfform-2.3.3.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-pypdfform-2.3.3.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.3.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