PyPDFForm 2.3.1__tar.gz → 2.3.3__tar.gz

{pypdfform-2.3.1 → pypdfform-2.3.3}/PKG-INFO

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

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

{pypdfform-2.3.1 → pypdfform-2.3.3}/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
 
@@ -370,9 +367,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(), False)
 
             widget = widgets.get(key)
             if widget is None or widget.value is None:

{pypdfform-2.3.1 → pypdfform-2.3.3}/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-2.3.1 → pypdfform-2.3.3}/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-2.3.1 → pypdfform-2.3.3}/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-2.3.1 → pypdfform-2.3.3}/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-2.3.1 → pypdfform-2.3.3}/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-2.3.1 → pypdfform-2.3.3}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-2.3.1 → pypdfform-2.3.3}/tests/test_use_full_widget_name.py

@@ -8,18 +8,18 @@ from PyPDFForm import PdfWrapper
 def test_init(sample_template_with_full_key):
     obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
     assert "Gain de 2 classes.0" in obj.widgets
-    assert obj.widgets["Gain de 2 classes.0"] is obj.widgets["0"]
+    assert "0" not in obj.widgets
 
 
 def test_sample_data(sample_template_with_full_key):
     obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
     assert "Gain de 2 classes.0" in obj.sample_data
-    assert obj.sample_data["Gain de 2 classes.0"] == obj.sample_data["0"]
+    assert "0" not in obj.sample_data
 
 
 def test_fill(sample_template_with_full_key):
     obj_1 = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
-    obj_2 = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
+    obj_2 = PdfWrapper(sample_template_with_full_key)
 
     assert (
         obj_1.fill({"Gain de 2 classes.0": True}).read()
@@ -44,6 +44,4 @@ def test_commit_widget_key_updates(sample_template_with_full_key):
 def test_schema(sample_template_with_full_key):
     obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
     assert "Gain de 2 classes.0" in obj.schema["properties"]
-    assert (
-        obj.schema["properties"]["Gain de 2 classes.0"] == obj.schema["properties"]["0"]
-    )
+    assert "0" not in obj.schema