PyPDFForm 2.3.3__tar.gz → 2.5.0__tar.gz

{pypdfform-2.3.3 → pypdfform-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.3.3
+Version: 2.5.0
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -10,7 +10,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -18,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/__init__.py

@@ -5,7 +5,7 @@ This package provides tools for filling PDF forms, drawing text and images,
 and manipulating PDF form elements programmatically.
 """
 
-__version__ = "2.3.3"
+__version__ = "2.5.0"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/filler.py

@@ -337,6 +337,7 @@ def enable_adobe_mode(reader: PdfReader, writer: PdfWriter, adobe_mode: bool) ->
 def simple_fill(
     template: bytes,
     widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
     flatten: bool = False,
     adobe_mode: bool = False,
 ) -> bytes:
@@ -350,6 +351,7 @@ def simple_fill(
     Args:
         template: Input PDF form as bytes
         widgets: Dictionary mapping field names to widget middleware
+        use_full_widget_name: If True, uses the full widget name as the key in the widgets dictionary
         flatten: If True, makes form fields read-only
         adobe_mode: If True, enables Adobe Acrobat compatibility
 
@@ -367,7 +369,7 @@ def simple_fill(
     for page in out.pages:
         for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
-            key = get_widget_key(annot.get_object(), False)
+            key = get_widget_key(annot.get_object(), use_full_widget_name)
 
             widget = widgets.get(key)
             if widget is None or widget.value is None:

pypdfform-2.5.0/PyPDFForm/hooks.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+"""Module containing hook functions for PDF form widget manipulation.
+
+This module provides functions to apply various transformations and modifications
+to PDF form widgets through a hook system. It allows dynamic modification of
+widget properties like font sizes and other attributes.
+"""
+
+import sys
+from io import BytesIO
+from typing import cast
+
+from pypdf import PdfReader, PdfWriter
+from pypdf.generic import (ArrayObject, DictionaryObject, FloatObject,
+                           NameObject, NumberObject, TextStringObject)
+
+from .constants import (COMB, DA, FONT_COLOR_IDENTIFIER, FONT_SIZE_IDENTIFIER,
+                        MULTILINE, Annots, Ff, Parent, Q, Rect)
+from .template import get_widget_key
+from .utils import stream_to_io
+
+
+def trigger_widget_hooks(
+    pdf: bytes,
+    widgets: dict,
+    use_full_widget_name: bool,
+) -> bytes:
+    """Apply all registered widget hooks to a PDF document.
+
+    Args:
+        pdf: The input PDF document as bytes
+        widgets: Dictionary mapping widget names to widget objects
+        use_full_widget_name: Whether to use full widget names including parent hierarchy
+
+    Returns:
+        The modified PDF document as bytes
+
+    Note:
+        This function processes all pages and annotations in the PDF, applying
+        any hooks registered in the widget objects.
+    """
+
+    pdf_file = PdfReader(stream_to_io(pdf))
+    output = PdfWriter()
+    output.append(pdf_file)
+
+    for page in output.pages:
+        for annot in page.get(Annots, []):
+            annot = cast(DictionaryObject, annot.get_object())
+            key = get_widget_key(annot.get_object(), use_full_widget_name)
+
+            widget = widgets.get(key)
+            if widget is None or not widget.hooks_to_trigger:
+                continue
+
+            for hook in widget.hooks_to_trigger:
+                getattr(sys.modules[__name__], hook[0])(annot, hook[1])
+
+    for widget in widgets.values():
+        widget.hooks_to_trigger = []
+
+    with BytesIO() as f:
+        output.write(f)
+        f.seek(0)
+        return f.read()
+
+
+def update_text_field_font_size(annot: DictionaryObject, val: float) -> None:
+    """Update the font size of a text field widget.
+
+    Args:
+        annot: The PDF annotation (widget) dictionary object
+        val: The new font size value to apply
+
+    Note:
+        Handles both direct font size specification and inherited font sizes
+        from parent objects. Modifies the DA (default appearance) string.
+    """
+
+    if Parent in annot and DA not in annot:
+        text_appearance = annot[Parent][DA]
+    else:
+        text_appearance = annot[DA]
+
+    text_appearance = text_appearance.split(" ")
+    font_size_index = 0
+    for i, value in enumerate(text_appearance):
+        if value.startswith(FONT_SIZE_IDENTIFIER):
+            font_size_index = i - 1
+            break
+
+    text_appearance[font_size_index] = str(val)
+    new_text_appearance = " ".join(text_appearance)
+
+    if Parent in annot and DA not in annot:
+        annot[NameObject(Parent)][NameObject(DA)] = TextStringObject(
+            new_text_appearance
+        )
+    else:
+        annot[NameObject(DA)] = TextStringObject(new_text_appearance)
+
+
+def update_text_field_font_color(annot: DictionaryObject, val: tuple) -> None:
+    """Update the font color of a text field widget.
+
+    Args:
+        annot: The PDF annotation (widget) dictionary object
+        val: Tuple containing RGB color values (e.g. (1, 0, 0) for red)
+
+    Note:
+        Handles both direct font color specification and inherited font colors
+        from parent objects. Modifies the DA (default appearance) string to
+        include the new color values after the font size identifier.
+    """
+
+    if Parent in annot and DA not in annot:
+        text_appearance = annot[Parent][DA]
+    else:
+        text_appearance = annot[DA]
+
+    text_appearance = text_appearance.split(" ")
+    font_size_identifier_index = 0
+    for i, value in enumerate(text_appearance):
+        if value == FONT_SIZE_IDENTIFIER:
+            font_size_identifier_index = i
+            break
+
+    new_text_appearance = (
+        text_appearance[:font_size_identifier_index]
+        + [FONT_SIZE_IDENTIFIER]
+        + [str(each) for each in val]
+    )
+    new_text_appearance = " ".join(new_text_appearance) + FONT_COLOR_IDENTIFIER
+
+    if Parent in annot and DA not in annot:
+        annot[NameObject(Parent)][NameObject(DA)] = TextStringObject(
+            new_text_appearance
+        )
+    else:
+        annot[NameObject(DA)] = TextStringObject(new_text_appearance)
+
+
+def update_text_field_alignment(annot: DictionaryObject, val: int) -> None:
+    """Update text alignment for text field annotations.
+
+    Modifies the alignment (Q) field of a text field annotation to set the
+    specified text alignment.
+
+    Args:
+        annot: PDF text field annotation dictionary to modify
+        val: Alignment value to set (typically 0=left, 1=center, 2=right)
+    """
+
+    annot[NameObject(Q)] = NumberObject(val)
+
+
+def update_text_field_multiline(annot: DictionaryObject, val: bool) -> None:
+    """Update multiline flag for text field annotations.
+
+    Modifies the field flags (Ff) of a text field annotation to set or
+    clear the multiline flag based on the input value.
+
+    Args:
+        annot: PDF text field annotation dictionary to modify
+        val: Whether to enable multiline (True) or disable (False)
+    """
+
+    if val:
+        annot[NameObject(Ff)] = NumberObject(int(annot[NameObject(Ff)]) | MULTILINE)
+
+
+def update_text_field_comb(annot: DictionaryObject, val: bool) -> None:
+    """Update comb formatting flag for text field annotations.
+
+    Modifies the field flags (Ff) of a text field annotation to set or
+    clear the comb flag which enables/disables comb formatting.
+
+    Args:
+        annot: PDF text field annotation dictionary to modify
+        val: Whether to enable comb formatting (True) or disable (False)
+    """
+
+    if val:
+        annot[NameObject(Ff)] = NumberObject(int(annot[NameObject(Ff)]) | COMB)
+
+
+def update_check_radio_size(annot: DictionaryObject, val: float) -> None:
+    """Update the size of a checkbox or radio button widget while maintaining center position.
+
+    Args:
+        annot: PDF annotation dictionary containing the widget to modify
+        val: New size value (width and height) for the widget
+
+    Note:
+        The widget will be resized symmetrically around its center point,
+        maintaining the same center position while changing its dimensions.
+    """
+
+    rect = annot[Rect]
+    center_x = (rect[0] + rect[2]) / 2
+    center_y = (rect[1] + rect[3]) / 2
+    new_rect = [
+        FloatObject(center_x - val / 2),
+        FloatObject(center_y - val / 2),
+        FloatObject(center_x + val / 2),
+        FloatObject(center_y + val / 2),
+    ]
+    annot[NameObject(Rect)] = ArrayObject(new_rect)
+
+
+# TODO: remove this and switch to hooks
+NON_ACRO_FORM_PARAM_TO_FUNC = {
+    ("TextWidget", "alignment"): update_text_field_alignment,
+    ("TextWidget", "multiline"): update_text_field_multiline,
+    ("TextWidget", "comb"): update_text_field_comb,
+}

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/middleware/base.py

@@ -26,6 +26,8 @@ class Widget:
     - Any widget-specific functionality
     """
 
+    SET_ATTR_TRIGGER_HOOK_MAP = {}
+
     def __init__(
         self,
         name: str,
@@ -48,6 +50,28 @@ class Widget:
         self.border_style = None
         self.dash_array = None
         self.render_widget = None
+        self.hooks_to_trigger = []
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """Sets an attribute on the widget with special handling for hook-triggering attributes.
+
+        For attributes listed in SET_ATTR_TRIGGER_HOOK_MAP, when set to non-None values,
+        adds a hook to hooks_to_trigger list with the mapped hook name and value.
+        All other attributes are set normally via the standard object.__setattr__.
+
+        Args:
+            name: Name of the attribute to set
+            value: Value to set the attribute to
+
+        Note:
+            The hook triggering only occurs when:
+            1. The attribute is in SET_ATTR_TRIGGER_HOOK_MAP
+            2. The value being set is not None
+        """
+
+        if name in self.SET_ATTR_TRIGGER_HOOK_MAP and value is not None:
+            self.hooks_to_trigger.append((self.SET_ATTR_TRIGGER_HOOK_MAP[name], value))
+        super().__setattr__(name, value)
 
     @property
     def name(self) -> str:

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/middleware/checkbox.py

@@ -25,6 +25,10 @@ class Checkbox(Widget):
     Inherits from Widget base class and extends it with checkbox-specific features.
     """
 
+    SET_ATTR_TRIGGER_HOOK_MAP = {
+        "size": "update_check_radio_size",
+    }
+
     BUTTON_STYLE_MAPPING = {
         "check": "4",
         "cross": "5",

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/middleware/text.py

@@ -27,6 +27,11 @@ class Text(Widget):
     Inherits from Widget base class and extends it with text-specific features.
     """
 
+    SET_ATTR_TRIGGER_HOOK_MAP = {
+        "font_size": "update_text_field_font_size",
+        "font_color": "update_text_field_font_color",
+    }
+
     def __init__(
         self,
         name: str,

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/patterns.py

@@ -19,9 +19,9 @@ from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
                            NumberObject, TextStringObject)
 
 from .constants import (AP, AS, BC, BG, BS, CA, DA, DV, FT,
-                        IMAGE_FIELD_IDENTIFIER, JS, MK, MULTILINE, READ_ONLY,
-                        TU, A, Btn, Ch, D, Ff, I, N, Off, Opt, Parent, Q, S,
-                        Sig, T, Tx, V, W, Yes)
+                        IMAGE_FIELD_IDENTIFIER, JS, MK, READ_ONLY, TU, A, Btn,
+                        Ch, D, Ff, I, N, Off, Opt, Parent, Q, S, Sig, T, Tx, V,
+                        W, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -273,38 +273,3 @@ def update_annotation_name(annot: DictionaryObject, val: str) -> None:
         annot[NameObject(Parent)][NameObject(T)] = TextStringObject(val)
     else:
         annot[NameObject(T)] = TextStringObject(val)
-
-
-def update_created_text_field_alignment(annot: DictionaryObject, val: int) -> None:
-    """Update text alignment for created text field annotations.
-
-    Modifies the alignment (Q) field of a text field annotation created
-    by the library to set the specified text alignment.
-
-    Args:
-        annot: PDF text field annotation dictionary to modify
-        val: Alignment value to set (typically 0=left, 1=center, 2=right)
-    """
-
-    annot[NameObject(Q)] = NumberObject(val)
-
-
-def update_created_text_field_multiline(annot: DictionaryObject, val: bool) -> None:
-    """Update multiline flag for created text field annotations.
-
-    Modifies the field flags (Ff) of a text field annotation created by
-    the library to set or clear the multiline flag based on the input value.
-
-    Args:
-        annot: PDF text field annotation dictionary to modify
-        val: Whether to enable multiline (True) or disable (False)
-    """
-
-    if val:
-        annot[NameObject(Ff)] = NumberObject(int(annot[NameObject(Ff)]) | MULTILINE)
-
-
-NON_ACRO_FORM_PARAM_TO_FUNC = {
-    ("TextWidget", "alignment"): update_created_text_field_alignment,
-    ("TextWidget", "multiline"): update_created_text_field_multiline,
-}

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/widgets/base.py

@@ -16,7 +16,7 @@ from reportlab.lib.colors import Color
 from reportlab.pdfgen.canvas import Canvas
 
 from ..constants import Annots
-from ..patterns import NON_ACRO_FORM_PARAM_TO_FUNC
+from ..hooks import NON_ACRO_FORM_PARAM_TO_FUNC
 from ..template import get_widget_key
 from ..utils import stream_to_io
 

{pypdfform-2.3.3 → pypdfform-2.5.0}/PyPDFForm/widgets/text.py

@@ -36,6 +36,6 @@ class TextWidget(Widget):
         ("max_length", "maxlen"),
     ]
     COLOR_PARAMS = ["font_color", "bg_color", "border_color"]
-    ALLOWED_NON_ACRO_FORM_PARAMS = ["alignment", "multiline"]
+    ALLOWED_NON_ACRO_FORM_PARAMS = ["alignment", "multiline", "comb"]
     NONE_DEFAULTS = ["max_length"]
     ACRO_FORM_FUNC = "textfield"