PyPDFForm 3.1.0__py3-none-any.whl → 3.1.2__py3-none-any.whl

PyPDFForm/__init__.py

@@ -20,7 +20,7 @@ The library supports various PDF form features, including:
 PyPDFForm aims to simplify PDF form manipulation, making it accessible to developers of all skill levels.
 """
 
-__version__ = "3.1.0"
+__version__ = "3.1.2"
 
 from .middleware.text import Text  # exposing for setting global font attrs
 from .wrapper import PdfWrapper

PyPDFForm/constants.py

@@ -105,3 +105,5 @@ IMAGE_FIELD_IDENTIFIER = "event.target.buttonImportIcon();"
 
 COORDINATE_GRID_FONT_SIZE_MARGIN_RATIO = DEFAULT_FONT_SIZE / 100
 UNIQUE_SUFFIX_LENGTH = 20
+
+SLASH = "/"

PyPDFForm/patterns.py

@@ -8,11 +8,13 @@ properties in the PDF's annotation dictionary. It also provides utility function
 for updating these widgets.
 """
 
+from typing import Union
+
 from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
                            NumberObject, TextStringObject)
 
-from .constants import (AP, AS, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, TU, A, Btn,
-                        Ch, I, N, Off, Opt, Parent, Sig, T, Tx, V, Yes)
+from .constants import (AP, AS, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, SLASH, TU,
+                        A, Btn, Ch, I, N, Off, Opt, Parent, Sig, T, Tx, V, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -42,7 +44,7 @@ WIDGET_TYPE_PATTERNS = [
         (
             {FT: Btn},
             {Parent: {FT: Btn}},
-            {AS: (Yes, Off)},
+            {AS: (Yes, Off, SLASH)},
         ),
         Radio,
     ),
@@ -76,7 +78,7 @@ WIDGET_TYPE_PATTERNS = [
     (
         (
             {Parent: {FT: Btn}},
-            {AS: (Yes, Off)},
+            {AS: (Yes, Off, SLASH)},
         ),
         Radio,
     ),
@@ -113,6 +115,23 @@ def update_checkbox_value(annot: DictionaryObject, check: bool = False) -> None:
             break
 
 
+def get_checkbox_value(annot: DictionaryObject) -> Union[bool, None]:
+    """
+    Retrieves the boolean value of a checkbox annotation.
+
+    This function checks the value (V) of the checkbox annotation. If the value
+    is not 'Off', it means the checkbox is checked, and True is returned.
+    Otherwise, if the value is 'Off' or not present, None is returned.
+
+    Args:
+        annot (DictionaryObject): The checkbox annotation dictionary.
+
+    Returns:
+        Union[bool, None]: True if the checkbox is checked, None otherwise.
+    """
+    return True if annot.get(V, Off) != Off else None
+
+
 def update_radio_value(annot: DictionaryObject) -> None:
     """
     Updates the value of a radio button annotation, selecting it.
@@ -133,6 +152,28 @@ def update_radio_value(annot: DictionaryObject) -> None:
             break
 
 
+def get_radio_value(annot: DictionaryObject) -> bool:
+    """
+    Retrieves the boolean value of a radio button annotation.
+
+    This function iterates through the appearance states (AP) of the radio button
+    annotation. If the value (V) of the parent dictionary matches any of these
+    appearance states, it means the radio button is selected, and True is returned.
+    Otherwise, False is returned.
+
+    Args:
+        annot (DictionaryObject): The radio button annotation dictionary.
+
+    Returns:
+        bool: True if the radio button is selected, False otherwise.
+    """
+    for each in annot.get(AP, {}).get(N, []):
+        if annot.get(Parent, {}).get(V) == each:
+            return True
+
+    return False
+
+
 def update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> None:
     """
     Updates the value of a dropdown annotation, selecting an option from the list.
@@ -157,6 +198,29 @@ def update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> None:
         annot[NameObject(I)] = ArrayObject([NumberObject(widget.value)])
 
 
+def get_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> None:
+    """
+    Retrieves the selected value of a dropdown annotation and updates the widget.
+
+    This function determines the current value of the dropdown, considering
+    whether it's a child annotation or a top-level one. It then iterates
+    through the widget's choices to find a match and sets the widget's
+    value to the index of the matched choice.
+
+    Args:
+        annot (DictionaryObject): The dropdown annotation dictionary.
+        widget (Dropdown): The Dropdown widget object to update with the retrieved value.
+    """
+    if Parent in annot and T not in annot:
+        to_compare = annot.get(Parent, {}).get(V)
+    else:
+        to_compare = annot.get(V)
+
+    for i, each in enumerate(widget.choices):
+        if each == to_compare:
+            widget.value = i or None  # set None when 0
+
+
 def update_text_value(annot: DictionaryObject, widget: Text) -> None:
     """
     Updates the value of a text annotation, setting the text content.
@@ -176,6 +240,24 @@ def update_text_value(annot: DictionaryObject, widget: Text) -> None:
         annot[NameObject(AP)] = TextStringObject(widget.value)
 
 
+def get_text_value(annot: DictionaryObject, widget: Text) -> None:
+    """
+    Retrieves the text value of a text annotation and updates the widget.
+
+    This function determines the current text value of the annotation, considering
+    whether it's a child annotation or a top-level one, and then sets the
+    widget's value accordingly.
+
+    Args:
+        annot (DictionaryObject): The text annotation dictionary.
+        widget (Text): The Text widget object to update with the retrieved value.
+    """
+    if Parent in annot and T not in annot:
+        widget.value = annot[Parent].get(V)
+    else:
+        widget.value = annot.get(V)
+
+
 def update_annotation_name(annot: DictionaryObject, val: str) -> None:
     """
     Updates the name of an annotation, setting the T (title) entry.

PyPDFForm/template.py

@@ -16,12 +16,14 @@ from pypdf import PdfReader, PdfWriter
 from pypdf.generic import DictionaryObject
 
 from .constants import WIDGET_TYPES, Annots, MaxLen, Parent, T
+from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.radio import Radio
 from .middleware.text import Text
 from .patterns import (DROPDOWN_CHOICE_PATTERNS, WIDGET_DESCRIPTION_PATTERNS,
                        WIDGET_KEY_PATTERNS, WIDGET_TYPE_PATTERNS,
-                       update_annotation_name)
+                       get_checkbox_value, get_dropdown_value, get_radio_value,
+                       get_text_value, update_annotation_name)
 from .utils import extract_widget_property, find_pattern_match, stream_to_io
 
 
@@ -61,11 +63,16 @@ def build_widgets(
                 if isinstance(_widget, Text):
                     # mostly for schema for now
                     _widget.max_length = get_text_field_max_length(widget)
+                    get_text_value(widget, _widget)
+
+                if type(_widget) is Checkbox:
+                    _widget.value = get_checkbox_value(widget)
 
                 if isinstance(_widget, Dropdown):
                     # actually used for filling value
                     # doesn't trigger hook
                     _widget.__dict__["choices"] = get_dropdown_choices(widget)
+                    get_dropdown_value(widget, _widget)
 
                 if isinstance(_widget, Radio):
                     if key not in results:
@@ -73,6 +80,9 @@ def build_widgets(
 
                     # for schema
                     results[key].number_of_options += 1
+
+                    if get_radio_value(widget):
+                        results[key].value = results[key].number_of_options - 1
                     continue
 
                 results[key] = _widget

PyPDFForm/utils.py

@@ -23,7 +23,7 @@ from typing import Any, BinaryIO, List, Union
 from pypdf import PdfReader, PdfWriter
 from pypdf.generic import ArrayObject, DictionaryObject, NameObject
 
-from .constants import UNIQUE_SUFFIX_LENGTH, XFA, AcroForm, Annots, Root
+from .constants import SLASH, UNIQUE_SUFFIX_LENGTH, XFA, AcroForm, Annots, Root
 
 
 @lru_cache
@@ -220,6 +220,8 @@ def find_pattern_match(pattern: dict, widget: Union[dict, DictionaryObject]) ->
             else:
                 if isinstance(pattern[key], tuple):
                     result = value in pattern[key]
+                    if not result and SLASH in pattern[key] and value.startswith(SLASH):
+                        result = True
                 else:
                     result = pattern[key] == value
         if result:

{pypdfform-3.1.0.dist-info → pypdfform-3.1.2.dist-info}/METADATA

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

{pypdfform-3.1.0.dist-info → pypdfform-3.1.2.dist-info}/RECORD

@@ -1,14 +1,14 @@
-PyPDFForm/__init__.py,sha256=R4BorFo4mdXpjdpfUiO6kvJpowukDOHSiRpfHBV2jYs,925
+PyPDFForm/__init__.py,sha256=6b0B0-Gyc70MQiyWMVmuvBagVeL07jurO3U1j3TQdNs,925
 PyPDFForm/adapter.py,sha256=8E_PZlXU1ALWez_pWF_U52cynzowK_NQFYzMJoH9VUk,2428
-PyPDFForm/constants.py,sha256=WQjBvYTryj5gxxeXECPgHplXXXmqHNeVbgmhvlLDCpA,2443
+PyPDFForm/constants.py,sha256=LW_YGzzirel8hxoqWylzo-eE1KvofKWG_p7SGd4ovpA,2456
 PyPDFForm/coordinate.py,sha256=VMVkqa-VAGJSGVvetZwOxeMzIgQtQdvtn_DI_qSecCE,3876
 PyPDFForm/filler.py,sha256=KwStL6YzrNBcDd919ig83MnAxopi8Vnz3QNJzN_CjNM,7272
 PyPDFForm/font.py,sha256=EZSAHnkzaBo96p9XJrQDMcEhjh5BZ8p7WwFC3SbKRMM,8828
 PyPDFForm/hooks.py,sha256=A8p67ubWvCvzRt346Q7BjOvbi4_NXBcynXmq6fJTadY,11679
 PyPDFForm/image.py,sha256=CAC69jEfSbWbyNJcjLhjWVSNJuFh7frMI70eaiFayHw,3823
-PyPDFForm/patterns.py,sha256=xuKAqGf07f3WFXwASnrmcS073pSEcR9lQMqLppjkQ2E,5829
-PyPDFForm/template.py,sha256=aGhwezcynmwCEck1SUNlQvgfupn-plV9mV2FF2RNn_M,9188
-PyPDFForm/utils.py,sha256=RX2mOP2uCIcN_JcTalCdYKhnYtyYc8dUIqg1wP_7MJA,10867
+PyPDFForm/patterns.py,sha256=RiQKqsOMrB9u4KWj5Kv6GUmcuGI77xMvdOcOcHy_9qE,8717
+PyPDFForm/template.py,sha256=lKkja_8Sx6vun1tOklSpdNT1pdelhfVl10kX-G4sLlA,9673
+PyPDFForm/utils.py,sha256=hLSVUG6qnE0iTMB-yPNQQIhmm3R69X7fcnbCTDvSUQs,11001
 PyPDFForm/watermark.py,sha256=9p1tjaIqicXngTNai_iOEkCoXRYnR66azB4s7wNsZUw,9349
 PyPDFForm/wrapper.py,sha256=Ysd1mkvE5OfDkjUI6mNFIt16-JUKwj2ifbp1MioWPUo,25257
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -28,8 +28,8 @@ PyPDFForm/widgets/image.py,sha256=aSD-3MEZFIRL7HYVuO6Os8irfSUOLHA_rHGkqcEIPPA,85
 PyPDFForm/widgets/radio.py,sha256=nWSQQp06kRISO7Q7FVFeB3PXYvMOSc0SMhRs1bHTxeQ,2261
 PyPDFForm/widgets/signature.py,sha256=EqIRIuKSQEg8LJZ_Mu859eEvs0dwO-mzkMNuhHG1Vsg,4034
 PyPDFForm/widgets/text.py,sha256=gtheE6_w0vQPRJJ9oj_l9FaMDEGnPtvVR6_axsrmxKI,1540
-pypdfform-3.1.0.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-pypdfform-3.1.0.dist-info/METADATA,sha256=-vHzFtOdPxAwCjPm98xvD424mC3Yc0KttyMir2HvPjE,4587
-pypdfform-3.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pypdfform-3.1.0.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-pypdfform-3.1.0.dist-info/RECORD,,
+pypdfform-3.1.2.dist-info/licenses/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+pypdfform-3.1.2.dist-info/METADATA,sha256=mDwVIYsMYDjn2mGkdAt0a6SVEwhxZqOzgh_cIVQc8RE,4587
+pypdfform-3.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pypdfform-3.1.2.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+pypdfform-3.1.2.dist-info/RECORD,,