PyPDFForm 1.5.0__tar.gz → 1.5.2__tar.gz

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

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

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

{pypdfform-1.5.0 → pypdfform-1.5.2}/PyPDFForm/adapter.py

@@ -12,7 +12,7 @@ def readable(obj: Any) -> bool:
 
 
 def fp_or_f_obj_or_stream_to_stream(
-    fp_or_f_obj_or_stream: Union[bytes, str, BinaryIO]
+    fp_or_f_obj_or_stream: Union[bytes, str, BinaryIO],
 ) -> bytes:
     """Converts a file path or a file object to a stream."""
 

{pypdfform-1.5.0 → pypdfform-1.5.2}/PyPDFForm/constants.py

@@ -76,11 +76,11 @@ NEW_LINE_SYMBOL = "\n"
 IMAGE_FIELD_IDENTIFIER = "event.target.buttonImportIcon();"
 
 DEFAULT_CHECKBOX_STYLE = "\u2713"
-DEFAULT_RADIO_STYLE = "\u25CF"
+DEFAULT_RADIO_STYLE = "\u25cf"
 BUTTON_STYLES = {
     "4": "\u2713",  # check
-    "5": "\u00D7",  # cross
-    "l": "\u25CF",  # circle
+    "5": "\u00d7",  # cross
+    "l": "\u25cf",  # circle
 }
 
 COORDINATE_GRID_FONT_SIZE_MARGIN_RATIO = DEFAULT_FONT_SIZE / 100

{pypdfform-1.5.0 → pypdfform-1.5.2}/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.2}/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.2}/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:
@@ -71,6 +71,13 @@ class FormWrapper:
 class PdfWrapper(FormWrapper):
     """A class to represent a PDF form."""
 
+    USER_PARAMS = [
+        "global_font",
+        "global_font_size",
+        "global_font_color",
+        "use_full_widget_name",
+    ]
+
     def __init__(
         self,
         template: Union[bytes, str, BinaryIO] = b"",
@@ -82,9 +89,8 @@ class PdfWrapper(FormWrapper):
         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.USER_PARAMS:
+            setattr(self, each, kwargs.get(each))
 
         self._init_helper()
 
@@ -92,7 +98,11 @@ class PdfWrapper(FormWrapper):
         """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(), getattr(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
@@ -105,9 +115,9 @@ class PdfWrapper(FormWrapper):
                 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
+                value.font = getattr(self, "global_font")
+                value.font_size = getattr(self, "global_font_size")
+                value.font_color = getattr(self, "global_font_color")
 
     @property
     def sample_data(self) -> dict:
@@ -129,7 +139,12 @@ class PdfWrapper(FormWrapper):
     def pages(self) -> List[PdfWrapper]:
         """Returns a list of pdf wrapper objects where each is a page of the PDF form."""
 
-        return [self.__class__(each) for each in get_page_streams(self.stream)]
+        return [
+            self.__class__(
+                each, **{param: getattr(self, param) for param in self.USER_PARAMS}
+            )
+            for each in get_page_streams(self.stream)
+        ]
 
     def change_version(self, version: str) -> PdfWrapper:
         """Changes the version of the PDF."""
@@ -254,6 +269,9 @@ class PdfWrapper(FormWrapper):
     ) -> PdfWrapper:
         """Updates the key of an existed widget on a PDF form."""
 
+        if getattr(self, "use_full_widget_name"):
+            raise NotImplementedError
+
         if defer:
             self._keys_to_update.append((old_key, new_key, index))
             return self
@@ -268,6 +286,9 @@ class PdfWrapper(FormWrapper):
     def commit_widget_key_updates(self) -> PdfWrapper:
         """Commits all deferred widget key updates on a PDF form."""
 
+        if getattr(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.2}/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.2
 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.2}/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.0 → pypdfform-1.5.2}/tests/test_functional.py

@@ -516,6 +516,22 @@ def test_pages(template_stream, pdf_samples, request):
         assert obj.pages[0].read() == f.read()
 
 
+def test_pages_inherit_attributes(template_stream):
+    obj = PdfWrapper(
+        template_stream,
+        global_font="Courier",
+        global_font_size=20,
+        global_font_color=(1, 0, 0),
+        use_full_widget_name=True,
+    )
+
+    for page in obj.pages:
+        assert getattr(page, "global_font") == "Courier"
+        assert getattr(page, "global_font_size") == 20
+        assert getattr(page, "global_font_color") == (1, 0, 0)
+        assert getattr(page, "use_full_widget_name")
+
+
 def test_generate_coordinate_grid(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "test_generate_coordinate_grid.pdf")
     with open(expected_path, "rb+") as f:

pypdfform-1.5.2/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"]
+    )