PyPDFForm 1.4.37__tar.gz → 1.5.1__tar.gz

{pypdfform-1.4.37 → pypdfform-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: PyPDFForm
-Version: 1.4.37
+Version: 1.5.1
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -24,6 +24,14 @@ Requires-Dist: cryptography
 Requires-Dist: pillow
 Requires-Dist: pypdf
 Requires-Dist: reportlab
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <p align="center"><img src="https://github.com/chinapandaman/PyPDFForm/raw/master/logo.png"></p>
 <p align="center">

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.4.37"
+__version__ = "1.5.1"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/constants.py

@@ -31,6 +31,7 @@ Annots = "/Annots"
 A = "/A"
 JS = "/JS"
 T = "/T"
+TU = "/TU"
 Rect = "/Rect"
 FT = "/FT"
 Parent = "/Parent"

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/middleware/base.py

@@ -16,7 +16,9 @@ class Widget:
 
         super().__init__()
         self._name = name
+        self.full_name = None
         self._value = value
+        self.desc = None
 
     @property
     def name(self) -> str:
@@ -40,7 +42,12 @@ class Widget:
     def schema_definition(self) -> dict:
         """Json schema definition of the widget."""
 
-        raise NotImplementedError
+        result = {}
+
+        if self.desc is not None:
+            result["description"] = self.desc
+
+        return result
 
     @property
     def sample_value(self) -> Any:

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/middleware/checkbox.py

@@ -31,7 +31,7 @@ class Checkbox(Widget):
     def schema_definition(self) -> dict:
         """Json schema definition of the checkbox."""
 
-        return {"type": "boolean"}
+        return {"type": "boolean", **super().schema_definition}
 
     @property
     def sample_value(self) -> Union[bool, int]:

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/middleware/dropdown.py

@@ -17,12 +17,17 @@ class Dropdown(Widget):
         super().__init__(name, value)
 
         self.choices = []
+        self.desc = None
 
     @property
     def schema_definition(self) -> dict:
         """Json schema definition of the dropdown."""
 
-        return {"type": "integer", "maximum": len(self.choices) - 1}
+        return {
+            "type": "integer",
+            "maximum": len(self.choices) - 1,
+            **super().schema_definition,
+        }
 
     @property
     def sample_value(self) -> int:

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/middleware/radio.py

@@ -22,7 +22,11 @@ class Radio(Checkbox):
     def schema_definition(self) -> dict:
         """Json schema definition of the radiobutton."""
 
-        return {"type": "integer", "maximum": self.number_of_options - 1}
+        return {
+            "maximum": self.number_of_options - 1,
+            **super().schema_definition,
+            "type": "integer",
+        }
 
     @property
     def sample_value(self) -> int:

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/middleware/text.py

@@ -53,7 +53,7 @@ class Text(Widget):
         if self.max_length is not None:
             result["maxLength"] = self.max_length
 
-        return result
+        return {**result, **super().schema_definition}
 
     @property
     def sample_value(self) -> str:

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/patterns.py

@@ -5,7 +5,7 @@ from pypdf.generic import (DictionaryObject, NameObject, NumberObject,
                            TextStringObject)
 
 from .constants import (AP, AS, CA, DA, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, MK,
-                        MULTILINE, READ_ONLY, A, Btn, Ch, Ff, N, Off, Opt,
+                        MULTILINE, READ_ONLY, TU, A, Btn, Ch, Ff, N, Off, Opt,
                         Parent, Q, Sig, T, Tx, V, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
@@ -68,6 +68,8 @@ WIDGET_KEY_PATTERNS = [
     {Parent: {T: True}},
 ]
 
+WIDGET_DESCRIPTION_PATTERNS = [{TU: True}, {Parent: {TU: True}}]
+
 DROPDOWN_CHOICE_PATTERNS = [
     {Opt: True},
     {Parent: {Opt: True}},

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/template.py

@@ -11,7 +11,7 @@ from pypdf.generic import DictionaryObject
 from reportlab.pdfbase.pdfmetrics import stringWidth
 
 from .constants import (COMB, DEFAULT_FONT_SIZE, MULTILINE, NEW_LINE_SYMBOL,
-                        WIDGET_TYPES, Annots, MaxLen, Rect)
+                        WIDGET_TYPES, Annots, MaxLen, Parent, Rect, T)
 from .font import (adjust_paragraph_font_size, adjust_text_field_font_size,
                    auto_detect_font, get_text_field_font_color,
                    get_text_field_font_size, text_field_font_size)
@@ -21,8 +21,8 @@ from .middleware.radio import Radio
 from .middleware.text import Text
 from .patterns import (BUTTON_STYLE_PATTERNS, DROPDOWN_CHOICE_PATTERNS,
                        TEXT_FIELD_FLAG_PATTERNS, WIDGET_ALIGNMENT_PATTERNS,
-                       WIDGET_KEY_PATTERNS, WIDGET_TYPE_PATTERNS,
-                       update_annotation_name)
+                       WIDGET_DESCRIPTION_PATTERNS, WIDGET_KEY_PATTERNS,
+                       WIDGET_TYPE_PATTERNS, update_annotation_name)
 from .utils import find_pattern_match, stream_to_io, traverse_pattern
 from .watermark import create_watermarks_and_draw
 
@@ -43,7 +43,9 @@ def set_character_x_paddings(
     return widgets
 
 
-def build_widgets(pdf_stream: bytes) -> Dict[str, WIDGET_TYPES]:
+def build_widgets(
+    pdf_stream: bytes, use_full_widget_name: bool
+) -> Dict[str, WIDGET_TYPES]:
     """Builds a widget dict given a PDF form stream."""
 
     results = {}
@@ -51,10 +53,10 @@ def build_widgets(pdf_stream: bytes) -> Dict[str, WIDGET_TYPES]:
     for widgets in get_widgets_by_page(pdf_stream).values():
         for widget in widgets:
             key = get_widget_key(widget)
-
             _widget = construct_widget(widget, key)
-
             if _widget is not None:
+                _widget.full_name = get_widget_full_key(widget)
+                _widget.desc = get_widget_description(widget)
                 if isinstance(_widget, Text):
                     _widget.max_length = get_text_field_max_length(widget)
                     if _widget.max_length is not None and is_text_field_comb(widget):
@@ -74,7 +76,8 @@ def build_widgets(pdf_stream: bytes) -> Dict[str, WIDGET_TYPES]:
                     continue
 
                 results[key] = _widget
-
+                if _widget.full_name is not None and use_full_widget_name:
+                    results[_widget.full_name] = results[key]
     return results
 
 
@@ -192,6 +195,24 @@ def get_widget_key(widget: dict) -> Union[str, list, None]:
     return result
 
 
+def get_widget_full_key(widget: dict) -> Union[str, None]:
+    """
+    Returns a PDF widget's full annotated key by prepending its
+    parent widget's key.
+    """
+
+    key = get_widget_key(widget)
+
+    if (
+        Parent in widget
+        and T in widget[Parent].get_object()
+        and widget[Parent][T] != key
+    ):
+        return f"{widget[Parent][T]}.{key}"
+
+    return None
+
+
 def get_widget_alignment(widget: dict) -> Union[str, list, None]:
     """Finds a PDF widget's alignment by pattern matching."""
 
@@ -225,6 +246,18 @@ def get_text_field_max_length(widget: dict) -> Union[int, None]:
     return int(widget[MaxLen]) or None if MaxLen in widget else None
 
 
+def get_widget_description(widget: dict) -> Union[str, None]:
+    """Returns the description of the widget if presented or None."""
+
+    result = None
+    for pattern in WIDGET_DESCRIPTION_PATTERNS:
+        value = traverse_pattern(pattern, widget)
+        if value:
+            result = str(value)
+            break
+    return result
+
+
 def check_field_flag_bit(widget: dict, bit: int) -> bool:
     """Checks if a bit is set in a widget's field flag."""
 
@@ -408,39 +441,41 @@ def get_paragraph_auto_wrap_length(widget_middleware: Text) -> int:
     return result
 
 
-def update_widget_key(
+def update_widget_keys(
     template: bytes,
     widgets: Dict[str, WIDGET_TYPES],
-    old_key: str,
-    new_key: str,
-    index: int,
+    old_keys: List[str],
+    new_keys: List[str],
+    indices: List[int],
 ) -> bytes:
-    """Updates the key of a widget."""
+    """Updates a list of keys of widgets."""
     # pylint: disable=R0801
 
     pdf = PdfReader(stream_to_io(template))
     out = PdfWriter()
     out.append(pdf)
 
-    tracker = -1
-
-    for page in out.pages:
-        for annot in page.get(Annots, []):  # noqa
-            annot = cast(DictionaryObject, annot.get_object())
-            key = get_widget_key(annot.get_object())
-
-            widget = widgets.get(key)
-            if widget is None:
-                continue
+    for i, old_key in enumerate(old_keys):
+        index = indices[i]
+        new_key = new_keys[i]
+        tracker = -1
+        for page in out.pages:
+            for annot in page.get(Annots, []):  # noqa
+                annot = cast(DictionaryObject, annot.get_object())
+                key = get_widget_key(annot.get_object())
+
+                widget = widgets.get(key)
+                if widget is None:
+                    continue
 
-            if old_key != key:
-                continue
+                if old_key != key:
+                    continue
 
-            tracker += 1
-            if not isinstance(widget, Radio) and tracker != index:
-                continue
+                tracker += 1
+                if not isinstance(widget, Radio) and tracker != index:
+                    continue
 
-            update_annotation_name(annot, new_key)
+                update_annotation_name(annot, new_key)
 
     with BytesIO() as f:
         out.write(f)

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm/wrapper.py

@@ -18,7 +18,7 @@ from .middleware.dropdown import Dropdown
 from .middleware.text import Text
 from .template import (build_widgets, dropdown_to_text,
                        set_character_x_paddings, update_text_field_attributes,
-                       update_widget_key, widget_rect_watermarks)
+                       update_widget_keys, widget_rect_watermarks)
 from .utils import (get_page_streams, merge_two_pdfs, preview_widget_to_draw,
                     remove_all_widgets)
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
@@ -52,7 +52,7 @@ class FormWrapper:
     ) -> FormWrapper:
         """Fills a PDF form."""
 
-        widgets = build_widgets(self.stream) if self.stream else {}
+        widgets = build_widgets(self.stream, False) if self.stream else {}
 
         for key, value in data.items():
             if key in widgets:
@@ -79,17 +79,39 @@ class PdfWrapper(FormWrapper):
         """Constructs all attributes for the object."""
 
         super().__init__(template)
-        self.widgets = build_widgets(self.stream) if self.stream else {}
+        self.widgets = {}
+        self._keys_to_update = []
 
         self.global_font = kwargs.get("global_font")
         self.global_font_size = kwargs.get("global_font_size")
         self.global_font_color = kwargs.get("global_font_color")
 
-        for each in self.widgets.values():
-            if isinstance(each, Text):
-                each.font = self.global_font
-                each.font_size = self.global_font_size
-                each.font_color = self.global_font_color
+        self.use_full_widget_name = kwargs.get("use_full_widget_name", False)
+
+        self._init_helper()
+
+    def _init_helper(self, key_to_refresh: str = None) -> None:
+        """Updates all attributes when the state of the PDF stream changes."""
+
+        refresh_not_needed = {}
+        new_widgets = (
+            build_widgets(self.read(), self.use_full_widget_name) if self.read() else {}
+        )
+        for k, v in self.widgets.items():
+            if k in new_widgets:
+                new_widgets[k] = v
+                refresh_not_needed[k] = True
+        self.widgets = new_widgets
+
+        for key, value in self.widgets.items():
+            if (key_to_refresh and key == key_to_refresh) or (
+                key_to_refresh is None
+                and isinstance(value, Text)
+                and not refresh_not_needed.get(key)
+            ):
+                value.font = self.global_font
+                value.font_size = self.global_font_size
+                value.font_color = self.global_font_color
 
     @property
     def sample_data(self) -> dict:
@@ -223,31 +245,48 @@ class PdfWrapper(FormWrapper):
                 self.stream, name, obj.non_acro_form_params
             )
 
-        new_widgets = build_widgets(self.read())
-        for k, v in self.widgets.items():
-            if k in new_widgets:
-                new_widgets[k] = v
-        self.widgets = new_widgets
+        key_to_refresh = ""
         if widget_type in ("text", "dropdown"):
-            self.widgets[name].font = self.global_font
-            self.widgets[name].font_size = self.global_font_size
-            self.widgets[name].font_color = self.global_font_color
+            key_to_refresh = name
+
+        self._init_helper(key_to_refresh)
 
         return self
 
     def update_widget_key(
-        self, old_key: str, new_key: str, index: int = 0
+        self, old_key: str, new_key: str, index: int = 0, defer: bool = False
     ) -> PdfWrapper:
         """Updates the key of an existed widget on a PDF form."""
 
-        self.__init__(
-            template=update_widget_key(
-                self.read(), self.widgets, old_key, new_key, index
-            ),
-            global_font=self.global_font,
-            global_font_size=self.global_font_size,
-            global_font_color=self.global_font_color,
+        if self.use_full_widget_name:
+            raise NotImplementedError
+
+        if defer:
+            self._keys_to_update.append((old_key, new_key, index))
+            return self
+
+        self.stream = update_widget_keys(
+            self.read(), self.widgets, [old_key], [new_key], [index]
+        )
+        self._init_helper()
+
+        return self
+
+    def commit_widget_key_updates(self) -> PdfWrapper:
+        """Commits all deferred widget key updates on a PDF form."""
+
+        if self.use_full_widget_name:
+            raise NotImplementedError
+
+        old_keys = [each[0] for each in self._keys_to_update]
+        new_keys = [each[1] for each in self._keys_to_update]
+        indices = [each[2] for each in self._keys_to_update]
+
+        self.stream = update_widget_keys(
+            self.read(), self.widgets, old_keys, new_keys, indices
         )
+        self._init_helper()
+        self._keys_to_update = []
 
         return self
 

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: PyPDFForm
-Version: 1.4.37
+Version: 1.5.1
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -24,6 +24,14 @@ Requires-Dist: cryptography
 Requires-Dist: pillow
 Requires-Dist: pypdf
 Requires-Dist: reportlab
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <p align="center"><img src="https://github.com/chinapandaman/PyPDFForm/raw/master/logo.png"></p>
 <p align="center">

{pypdfform-1.4.37 → pypdfform-1.5.1}/PyPDFForm.egg-info/SOURCES.txt

@@ -43,4 +43,5 @@ tests/test_functional_simple.py
 tests/test_paragraph.py
 tests/test_paragraph_simple.py
 tests/test_preview.py
-tests/test_signature.py
+tests/test_signature.py
+tests/test_use_full_widget_name.py

{pypdfform-1.4.37 → pypdfform-1.5.1}/tests/test_functional.py

@@ -10,11 +10,7 @@ from PyPDFForm.middleware.text import Text
 
 
 def test_base_schema_definition():
-    try:
-        assert Widget("foo").schema_definition
-        raise AssertionError
-    except NotImplementedError:
-        pass
+    assert Widget("foo").schema_definition == {}
 
 
 def test_fill(template_stream, pdf_samples, data_dict, request):
@@ -635,7 +631,7 @@ def test_update_radio_key(template_with_radiobutton_stream, pdf_samples, request
         obj.update_widget_key("radio_3", "RADIO")
 
         request.config.results["expected_path"] = expected_path
-        request.config.results["stream"] = obj.read()
+        request.config.results["stream"] = obj.preview
 
         expected = f.read()
 
@@ -653,7 +649,7 @@ def test_update_sejda_key(sejda_template, pdf_samples, request):
         obj.update_widget_key("buyer_signed_date", "BUYER_SIGNED_DATE")
 
         request.config.results["expected_path"] = expected_path
-        request.config.results["stream"] = obj.read()
+        request.config.results["stream"] = obj.preview
 
         expected = f.read()
 

pypdfform-1.5.1/tests/test_use_full_widget_name.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+import pytest
+
+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"]
+
+
+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"]
+
+
+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)
+
+    assert (
+        obj_1.fill({"Gain de 2 classes.0": True}).read()
+        == obj_2.fill({"0": True}).read()
+    )
+
+
+def test_update_widget_key(sample_template_with_full_key):
+    obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
+
+    with pytest.raises(NotImplementedError):
+        obj.update_widget_key("0", "foo")
+
+
+def test_commit_widget_key_updates(sample_template_with_full_key):
+    obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
+
+    with pytest.raises(NotImplementedError):
+        obj.commit_widget_key_updates()
+
+
+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"]
+    )