PyPDFForm 1.4.31__py3-none-any.whl → 1.4.33__py3-none-any.whl

PyPDFForm/__init__.py

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

PyPDFForm/image.py

@@ -42,7 +42,7 @@ def any_image_to_jpg(image_stream: bytes) -> bytes:
         return image_stream
 
     rgb_image = Image.new("RGB", image.size, (255, 255, 255))
-    rgb_image.paste(image, mask=image.split()[3])
+    rgb_image.paste(image, mask=image.split()[3] if len(image.split()) == 4 else None)
 
     with BytesIO() as _file:
         rgb_image.save(_file, format="JPEG")

PyPDFForm/patterns.py

@@ -5,8 +5,8 @@ from pypdf.generic import (DictionaryObject, NameObject, NumberObject,
                            TextStringObject)
 
 from .constants import (AP, AS, CA, DA, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, MK,
-                        READ_ONLY, A, Btn, Ch, Ff, N, Off, Opt, Parent, Q, Sig,
-                        T, Tx, V, Yes)
+                        MULTILINE, READ_ONLY, A, Btn, Ch, Ff, N, Off, Opt,
+                        Parent, Q, Sig, T, Tx, V, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -158,3 +158,24 @@ def simple_flatten_generic(annot: DictionaryObject) -> None:
         annot[NameObject(Ff)] = NumberObject(
             int(annot.get(NameObject(Ff), 0)) | READ_ONLY  # noqa
         )
+
+
+def update_created_text_field_alignment(annot: DictionaryObject, val: int) -> None:
+    """Patterns to update text alignment for text annotations created by the library."""
+
+    annot[NameObject(Q)] = NumberObject(val)
+
+
+def update_created_text_field_multiline(annot: DictionaryObject, val: bool) -> None:
+    """Patterns to update to multiline for text annotations created by the library."""
+
+    if val:
+        annot[NameObject(Ff)] = NumberObject(
+            int(annot[NameObject(Ff)]) | MULTILINE  # noqa
+        )
+
+
+NON_ACRO_FORM_PARAM_TO_FUNC = {
+    ("TextWidget", "alignment"): update_created_text_field_alignment,
+    ("TextWidget", "multiline"): update_created_text_field_multiline,
+}

PyPDFForm/widgets/base.py

@@ -2,12 +2,16 @@
 """Contains base class for all widgets to create."""
 
 from io import BytesIO
-from typing import List
+from typing import List, cast
 
-from pypdf import PdfReader
+from pypdf import PdfReader, PdfWriter
+from pypdf.generic import DictionaryObject
 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 ..template import get_widget_key
 from ..utils import stream_to_io
 
 
@@ -16,6 +20,7 @@ class Widget:
 
     USER_PARAMS = []
     COLOR_PARAMS = []
+    ALLOWED_NON_ACRO_FORM_PARAMS = []
     NONE_DEFAULTS = []
     ACRO_FORM_FUNC = ""
 
@@ -36,6 +41,7 @@ class Widget:
             "x": x,
             "y": y,
         }
+        self.non_acro_form_params = []
 
         for each in self.USER_PARAMS:
             user_input, param = each
@@ -51,6 +57,12 @@ class Widget:
             elif user_input in self.NONE_DEFAULTS:
                 self.acro_form_params[param] = None
 
+        for each in self.ALLOWED_NON_ACRO_FORM_PARAMS:
+            if each in kwargs:
+                self.non_acro_form_params.append(
+                    ((type(self).__name__, each), kwargs.get(each))
+                )
+
     def watermarks(self, stream: bytes) -> List[bytes]:
         """Returns a list of watermarks after creating the widget."""
 
@@ -76,3 +88,26 @@ class Widget:
             watermark.read() if i == self.page_number - 1 else b""
             for i in range(page_count)
         ]
+
+
+def handle_non_acro_form_params(pdf: bytes, key: str, params: list) -> bytes:
+    """Handles non acro form parameters when creating a widget."""
+
+    pdf_file = PdfReader(stream_to_io(pdf))
+    out = PdfWriter()
+    out.append(pdf_file)
+
+    for page in out.pages:
+        for annot in page.get(Annots, []):  # noqa
+            annot = cast(DictionaryObject, annot.get_object())
+            _key = get_widget_key(annot.get_object())
+
+            if _key == key:
+                for param in params:
+                    if param[0] in NON_ACRO_FORM_PARAM_TO_FUNC:
+                        NON_ACRO_FORM_PARAM_TO_FUNC[param[0]](annot, param[1])
+
+    with BytesIO() as f:
+        out.write(f)
+        f.seek(0)
+        return f.read()

PyPDFForm/widgets/text.py

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

PyPDFForm/wrapper.py

@@ -22,6 +22,7 @@ from .template import (build_widgets, dropdown_to_text,
 from .utils import (get_page_streams, merge_two_pdfs, preview_widget_to_draw,
                     remove_all_widgets)
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
+from .widgets.base import handle_non_acro_form_params
 from .widgets.checkbox import CheckBoxWidget
 from .widgets.dropdown import DropdownWidget
 from .widgets.text import TextWidget
@@ -213,11 +214,15 @@ class PdfWrapper(FormWrapper):
         if _class is None:
             return self
 
-        watermarks = _class(
-            name=name, page_number=page_number, x=x, y=y, **kwargs
-        ).watermarks(self.read())
+        obj = _class(name=name, page_number=page_number, x=x, y=y, **kwargs)
+        watermarks = obj.watermarks(self.read())
 
         self.stream = merge_watermarks_with_pdf(self.read(), watermarks)
+        if obj.non_acro_form_params:
+            self.stream = handle_non_acro_form_params(
+                self.stream, name, obj.non_acro_form_params
+            )
+
         new_widgets = build_widgets(self.read())
         for k, v in self.widgets.items():
             if k in new_widgets:

{PyPDFForm-1.4.31.dist-info → PyPDFForm-1.4.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.31
+Version: 1.4.33
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li

{PyPDFForm-1.4.31.dist-info → PyPDFForm-1.4.33.dist-info}/RECORD

@@ -1,15 +1,15 @@
-PyPDFForm/__init__.py,sha256=pRovsD1TN9FVIkHD1qURZWnJ9SMefn8yY8jivZI5Tzs,179
+PyPDFForm/__init__.py,sha256=nGB4hFyhtEP1Yax2cCeP4M9Pj6qTiF2ENvyTcwe_MTA,179
 PyPDFForm/adapter.py,sha256=WFP-r8FLeKa-D9mFO9AphOcuXgyeAI1Ak0d-YsqxsK4,861
 PyPDFForm/constants.py,sha256=FMsdOvnYpchEfki3gf_Y2Wj1SThUxMzsPbOx12_S1GA,1738
 PyPDFForm/coordinate.py,sha256=V_ZZQ1pXtVPAyfMJCX7fKoEimK7XwX6bU3VQ0nKOhQA,7314
 PyPDFForm/filler.py,sha256=pgMA7EC8axKUganmbk7X1uDdsb4OQQFoiI85td3pOO4,7486
 PyPDFForm/font.py,sha256=TbFLY4G72d7cQ3VG2g4HaYKROzQPQUmh6-8ynN6hzXY,5713
-PyPDFForm/image.py,sha256=0GV8PFgY5oLJFHmhPD1fG-_5SBEO7jVLLtxCc_Uodfo,1143
-PyPDFForm/patterns.py,sha256=p33mDZKxQN2h8GgVnZGXNolWPzofky1llIpstjnL3eI,4318
+PyPDFForm/image.py,sha256=sjXPg9fjenNFj12a321xHX6JvuJs6PJRGLzpSNw5mVU,1180
+PyPDFForm/patterns.py,sha256=9DFI-2cVZxzJKWmWBjK-dRSeAMNQr7ovHmw1YevrkiQ,5028
 PyPDFForm/template.py,sha256=a9rDzhHHfnYFo8cDnHnRE9UriUykXvrsyFKVGq9DYd0,13166
 PyPDFForm/utils.py,sha256=9omR-oT3OdZqioxpiGqA9_P0GSFC6mg4Y1xrLvWOzkk,4309
 PyPDFForm/watermark.py,sha256=L4LfzjjyJ6TDq9ad2dbtQYheBOic1_oZ7smhFFekNog,4725
-PyPDFForm/wrapper.py,sha256=Rrb7PhbAWEWOwOX3Z5m-TEfTZfCnEY4AsWg7ashPe7c,9498
+PyPDFForm/wrapper.py,sha256=EC5ugli6Nj1q0un8je3f5xtRIfIxDSf9YrG50QipTPk,9715
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 PyPDFForm/middleware/base.py,sha256=p-3XsZJ6d7ai2JFLF7LisMWi9yzM3pN7CsFECxtEoI0,751
 PyPDFForm/middleware/checkbox.py,sha256=3-9CMhhtyO9U6lLXDciW-59ng8uS4m6_clPB02mzV9c,1317
@@ -19,12 +19,12 @@ PyPDFForm/middleware/radio.py,sha256=ehaJoehEzZqxDVb5A6fJkYludeBmtV2Z5GZUPPfUWng
 PyPDFForm/middleware/signature.py,sha256=m7tNvGZ7fQ0yuVKzSlLbNQ2IILo1GDnjzMDzMnYCKVM,1104
 PyPDFForm/middleware/text.py,sha256=LNY_9Y2tq3uQEneKoL4vgrJtFTva0KSYzuuzDb5METM,1055
 PyPDFForm/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-PyPDFForm/widgets/base.py,sha256=mb8pKLu9d80pr-175T8f0FI1kWo2IOJ5am2_zRQKUl0,2075
+PyPDFForm/widgets/base.py,sha256=Re251Gxk22hvPE-jIlM3UMalcVGfP_nVJK3WAPYne78,3288
 PyPDFForm/widgets/checkbox.py,sha256=MGB6NGI-XMBz4j2erykgYOCd1pswvthuQ6UFowQOd4o,503
 PyPDFForm/widgets/dropdown.py,sha256=2_R5xcLUWAL0G4raVgWWtE7TJdiWJITay-Gtl8YI2QI,705
-PyPDFForm/widgets/text.py,sha256=x8EglZLYoI9osN9wORLRYoR7lebrpj-wx38QiRH7H1A,629
-PyPDFForm-1.4.31.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-PyPDFForm-1.4.31.dist-info/METADATA,sha256=gnvLbIDdwFs1FaYpgGx2rgjTMEA1KeFHngG72BH-CtU,4151
-PyPDFForm-1.4.31.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-PyPDFForm-1.4.31.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-PyPDFForm-1.4.31.dist-info/RECORD,,
+PyPDFForm/widgets/text.py,sha256=sCB8CQAjh30QOGr8FTIDSk3X6dXSHJztOz6YkKEBDss,691
+PyPDFForm-1.4.33.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+PyPDFForm-1.4.33.dist-info/METADATA,sha256=AfmRvobo1vnrBt5wic57TLhpDxoXlz3MOvNQws7vGKQ,4151
+PyPDFForm-1.4.33.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+PyPDFForm-1.4.33.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+PyPDFForm-1.4.33.dist-info/RECORD,,

{PyPDFForm-1.4.31.dist-info → PyPDFForm-1.4.33.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any