Merge pull request #780 from chinapandaman/PPF-779

PPF-779: support description for radio button

Author: chinapandaman

PyPDFForm/middleware/radio.py

@@ -22,7 +22,8 @@ def __init__(
     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/patterns.py

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

PyPDFForm/template.py

@@ -11,7 +11,7 @@
 from reportlab.pdfbase.pdfmetrics import stringWidth
 
 from .constants import (COMB, DEFAULT_FONT_SIZE, MULTILINE, NEW_LINE_SYMBOL,
-                        TU, WIDGET_TYPES, Annots, MaxLen, Rect)
+                        WIDGET_TYPES, Annots, MaxLen, Rect)
 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,7 +21,7 @@
 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,
+                       WIDGET_KEY_PATTERNS, WIDGET_TYPE_PATTERNS, WIDGET_DESCRIPTION_PATTERNS,
                        update_annotation_name)
 from .utils import find_pattern_match, stream_to_io, traverse_pattern
 from .watermark import create_watermarks_and_draw
@@ -226,7 +226,13 @@ def get_text_field_max_length(widget: dict) -> Union[int, None]:
 def get_widget_description(widget: dict) -> Union[str, None]:
     """Returns the description of the widget if presented or None."""
 
-    return widget.get(TU)
+    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:

tests/scenario/test_issues.py

@@ -4,6 +4,9 @@
 import os
 
 from PyPDFForm import PdfWrapper
+from PyPDFForm.middleware.radio import Radio
+from PyPDFForm.template import get_widgets_by_page, get_widget_key
+from PyPDFForm.constants import Parent, TU
 
 
 def test_pdf_form_with_pages_without_widgets(issue_pdf_directory, request):
@@ -305,13 +308,29 @@ def test_get_desc_in_schema(issue_pdf_directory):
 
     assert (
         obj.schema["properties"]["P1_checkbox4[0]"]["description"]
-        == "Part 1. Information About You. Your Full Name. 4. Has your name legally changed since the issuance of your Permanent Resident Card? Select Yes. (Proceed to Item Numbers 5. A. through 5. C.)."
-    )  # noqa
+        == "Part 1. Information About You. Your Full Name. 4. Has your name legally changed since the issuance of your Permanent Resident Card? Select Yes. (Proceed to Item Numbers 5. A. through 5. C.)." # noqa
+    )
     assert (
         obj.schema["properties"]["P1_checkbox4[1]"]["description"]
-        == "Part 1. Information About You. Your Full Name. 4. Has your name legally changed since the issuance of your Permanent Resident Card? Select No (Proceed to Item Numbers 6. A. through 6. I.)."
-    )  # noqa
+        == "Part 1. Information About You. Your Full Name. 4. Has your name legally changed since the issuance of your Permanent Resident Card? Select No (Proceed to Item Numbers 6. A. through 6. I.)."   # noqa
+    )
     assert (
         obj.schema["properties"]["P1_checkbox4[2]"]["description"]
-        == "Part 1. Information About You. Your Full Name. 4. Has your name legally changed since the issuance of your Permanent Resident Card? Select Not Applicable - I never received my previous card. (Proceed to Item Numbers 6. A. through 6. I.)."
-    )  # noqa
+        == "Part 1. Information About You. Your Full Name. 4. Has your name legally changed since the issuance of your Permanent Resident Card? Select Not Applicable - I never received my previous card. (Proceed to Item Numbers 6. A. through 6. I.)."  # noqa
+    )
+
+
+def test_get_desc_in_schema_radio(issue_pdf_directory):
+    obj = PdfWrapper(os.path.join(issue_pdf_directory, "PPF-620.pdf"))
+
+    keys_to_check = []
+    for key, value in obj.widgets.items():
+        if isinstance(value, Radio) and value.desc is not None:
+            keys_to_check.append(key)
+
+    for widgets in get_widgets_by_page(obj.read()).values():
+        for widget in widgets:
+            key = get_widget_key(widget)
+
+            if key in keys_to_check:
+                assert widget[Parent][TU] == obj.schema["properties"][key]["description"]