PyPDFForm 3.3.0__tar.gz → 3.3.1__tar.gz

{pypdfform-3.3.0 → pypdfform-3.3.1}/PKG-INFO

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

{pypdfform-3.3.0 → pypdfform-3.3.1}/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.3.0"
+__version__ = "3.3.1"
 
 from .middleware.text import Text  # exposing for setting global font attrs
 from .wrapper import PdfWrapper

{pypdfform-3.3.0 → pypdfform-3.3.1}/PyPDFForm/constants.py

@@ -99,6 +99,10 @@ REQUIRED = 1 << 1
 MULTILINE = 1 << 12
 COMB = 1 << 24
 
+# reportlab acroform func
+fieldFlags = "fieldFlags"
+required = "required"
+
 FONT_SIZE_IDENTIFIER = "Tf"
 FONT_COLOR_IDENTIFIER = " rg"
 DEFAULT_FONT = "Helvetica"

{pypdfform-3.3.0 → pypdfform-3.3.1}/PyPDFForm/hooks.py

@@ -359,19 +359,20 @@ def update_field_required(annot: DictionaryObject, val: bool) -> None:
         annot (DictionaryObject): The annotation dictionary for the form field.
         val (bool): True to set the field as required, False to make it optional.
     """
-    if Parent in annot and Ff not in annot:
-        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
-            (
-                int(annot.get(NameObject(Ff), 0)) | REQUIRED
-                if val
-                else int(annot.get(NameObject(Ff), 0)) & ~REQUIRED
-            )
-        )
-    else:
-        annot[NameObject(Ff)] = NumberObject(
-            (
-                int(annot.get(NameObject(Ff), 0)) | REQUIRED
-                if val
-                else int(annot.get(NameObject(Ff), 0)) & ~REQUIRED
-            )
+    # TODO: add a test case when supporting edit required
+    # if Parent in annot and Ff not in annot:
+    #     annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+    #         (
+    #             int(annot.get(NameObject(Ff), 0)) | REQUIRED
+    #             if val
+    #             else int(annot.get(NameObject(Ff), 0)) & ~REQUIRED
+    #         )
+    #     )
+    # else:
+    annot[NameObject(Ff)] = NumberObject(
+        (
+            int(annot.get(NameObject(Ff), 0)) | REQUIRED
+            if val
+            else int(annot.get(NameObject(Ff), 0)) & ~REQUIRED
         )
+    )

{pypdfform-3.3.0 → pypdfform-3.3.1}/PyPDFForm/widgets/base.py

@@ -10,6 +10,7 @@ for rendering the widget on a PDF page.
 # TODO: In `watermarks`, `PdfReader(stream_to_io(stream))` is called, which re-parses the PDF for each widget. If multiple widgets are being processed, consider passing the `PdfReader` object directly to avoid redundant parsing.
 # TODO: In `watermarks`, the list comprehension `[watermark.read() if i == self.page_number - 1 else b"" for i in range(page_count)]` creates a new `BytesIO` object and reads from it for each widget. If many widgets are created, this could be optimized by creating the `BytesIO` object once and passing it around, or by directly returning the watermark bytes and its page number.
 
+from inspect import signature
 from io import BytesIO
 from typing import List, Union
 
@@ -17,6 +18,7 @@ from pypdf import PdfReader
 from reportlab.lib.colors import Color
 from reportlab.pdfgen.canvas import Canvas
 
+from ..constants import fieldFlags, required
 from ..utils import stream_to_io
 
 
@@ -95,6 +97,39 @@ class Widget:
             if each in kwargs:
                 self.hook_params.append((each, kwargs.get(each)))
 
+    def _required_handler(self, canvas: Canvas) -> None:
+        """
+        Handles the 'Required' flag for the widget's AcroForm field.
+
+        This method inspects the default flags of the AcroForm function associated
+        with the widget and modifies them based on the widget's 'required' parameter.
+        If the widget is marked as required, the 'required' flag is added to the
+        AcroForm field flags; otherwise, it is removed. This ensures the PDF form
+        field's required status is correctly reflected.
+
+        Args:
+            canvas (Canvas): The ReportLab canvas object used for PDF operations.
+        """
+        default_flags = signature(
+            getattr(canvas.acroForm, self.ACRO_FORM_FUNC)
+        ).parameters.get(fieldFlags)
+        default_flags = (
+            default_flags.default.split(" ")
+            if default_flags and default_flags.default
+            else []
+        )
+
+        if self.acro_form_params.get(required):
+            default_flags.append(required)
+        else:
+            if required in default_flags:
+                default_flags.remove(required)
+
+        default_flags = " ".join(list(set(default_flags)))
+        self.acro_form_params[fieldFlags] = default_flags
+        if required in self.acro_form_params:
+            del self.acro_form_params[required]
+
     def canvas_operations(self, canvas: Canvas) -> None:
         """
         Performs canvas operations for the widget.
@@ -141,6 +176,7 @@ class Widget:
             ),
         )
 
+        self._required_handler(canvas)
         self.canvas_operations(canvas)
 
         canvas.showPage()

{pypdfform-3.3.0 → pypdfform-3.3.1}/PyPDFForm/widgets/checkbox.py

@@ -25,6 +25,7 @@ class CheckBoxWidget(Widget):
     """
 
     USER_PARAMS = [
+        ("required", "required"),
         ("tooltip", "tooltip"),
         ("button_style", "buttonStyle"),
         ("tick_color", "textColor"),
@@ -33,5 +34,5 @@ class CheckBoxWidget(Widget):
         ("border_width", "borderWidth"),
     ]
     COLOR_PARAMS = ["tick_color", "bg_color", "border_color"]
-    ALLOWED_HOOK_PARAMS = ["required", "size"]
+    ALLOWED_HOOK_PARAMS = ["size"]
     ACRO_FORM_FUNC = "checkbox"

{pypdfform-3.3.0 → pypdfform-3.3.1}/PyPDFForm/widgets/text.py

@@ -27,6 +27,7 @@ class TextWidget(Widget):
     """
 
     USER_PARAMS = [
+        ("required", "required"),
         ("tooltip", "tooltip"),
         ("width", "width"),
         ("height", "height"),
@@ -38,6 +39,6 @@ class TextWidget(Widget):
         ("max_length", "maxlen"),
     ]
     COLOR_PARAMS = ["font_color", "bg_color", "border_color"]
-    ALLOWED_HOOK_PARAMS = ["required", "alignment", "multiline", "comb", "font"]
+    ALLOWED_HOOK_PARAMS = ["alignment", "multiline", "comb", "font"]
     NONE_DEFAULTS = ["max_length"]
     ACRO_FORM_FUNC = "textfield"

{pypdfform-3.3.0 → pypdfform-3.3.1}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-3.3.0 → pypdfform-3.3.1}/pyproject.toml

@@ -106,7 +106,7 @@ select = [
     "YTT",
     "W",
 ]
-ignore = ["B009", "E501", "N999", "Q000", "TC006"]
+ignore = ["B009", "E501", "N999", "Q000", "TC006", "N816"]
 
 [tool.pyright]
 typeCheckingMode = "basic"