PyPDFForm 1.5.0__tar.gz → 1.5.1__tar.gz

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: PyPDFForm
-Version: 1.5.0
+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.5.0 → pypdfform-1.5.1}/PyPDFForm/__init__.py

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

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

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

{pypdfform-1.5.0 → 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)
@@ -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 = {}
@@ -53,6 +55,7 @@ def build_widgets(pdf_stream: bytes) -> Dict[str, WIDGET_TYPES]:
             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)
@@ -73,6 +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
 
 
@@ -190,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."""
 

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

@@ -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:
@@ -86,13 +86,17 @@ class PdfWrapper(FormWrapper):
         self.global_font_size = kwargs.get("global_font_size")
         self.global_font_color = kwargs.get("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()) if self.read() else {}
+        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
@@ -254,6 +258,9 @@ class PdfWrapper(FormWrapper):
     ) -> PdfWrapper:
         """Updates the key of an existed widget on a PDF form."""
 
+        if self.use_full_widget_name:
+            raise NotImplementedError
+
         if defer:
             self._keys_to_update.append((old_key, new_key, index))
             return self
@@ -268,6 +275,9 @@ class PdfWrapper(FormWrapper):
     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]

{pypdfform-1.5.0 → 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.5.0
+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.5.0 → 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.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"]
+    )