PyPDFForm 1.4.30__tar.gz → 1.4.32__tar.gz

{pypdfform-1.4.30 → pypdfform-1.4.32}/PKG-INFO

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

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/__init__.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.4.30"
+__version__ = "1.4.32"
 
 from .wrapper import FormWrapper, PdfWrapper
+
+__all__ = ["FormWrapper", "PdfWrapper"]

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/adapter.py

@@ -13,10 +13,10 @@ def readable(obj: Any) -> bool:
 
 def fp_or_f_obj_or_stream_to_stream(
     fp_or_f_obj_or_stream: Union[bytes, str, BinaryIO]
-) -> Union[bytes, None]:
+) -> bytes:
     """Converts a file path or a file object to a stream."""
 
-    result = None
+    result = b""
     if isinstance(fp_or_f_obj_or_stream, bytes):
         result = fp_or_f_obj_or_stream
 
@@ -25,8 +25,7 @@ def fp_or_f_obj_or_stream_to_stream(
 
     elif isinstance(fp_or_f_obj_or_stream, str):
         if not isfile(fp_or_f_obj_or_stream):
-            result = None
-
+            pass
         else:
             with open(fp_or_f_obj_or_stream, "rb+") as _file:
                 result = _file.read()

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/font.py

@@ -42,9 +42,9 @@ def extract_font_from_text_appearance(text_appearance: str) -> Union[str, None]:
     appearance string of a text field widget.
     """
 
-    text_appearance = text_appearance.split(" ")
+    text_appearances = text_appearance.split(" ")
 
-    for each in text_appearance:
+    for each in text_appearances:
         if each.startswith("/"):
             text_segments = findall("[A-Z][^A-Z]*", each.replace("/", ""))
 

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/middleware/base.py

@@ -14,6 +14,7 @@ class Widget:
     ) -> None:
         """Constructs basic attributes for the object."""
 
+        super().__init__()
         self._name = name
         self.value = value
 

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/middleware/checkbox.py

@@ -34,7 +34,7 @@ class Checkbox(Widget):
         return {"type": "boolean"}
 
     @property
-    def sample_value(self) -> bool:
+    def sample_value(self) -> Union[bool, int]:
         """Sample value of the checkbox."""
 
         return True

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/middleware/dropdown.py

@@ -16,7 +16,7 @@ class Dropdown(Widget):
 
         super().__init__(name, value)
 
-        self.choices = None
+        self.choices = []
 
     @property
     def schema_definition(self) -> dict:

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/middleware/text.py

@@ -22,7 +22,7 @@ class Text(Widget):
         self.text_wrap_length = None
         self.max_length = None
         self.comb = None
-        self.character_paddings = None
+        self.character_paddings = []
         self.text_lines = None
         self.text_line_x_coordinates = None
         self.preview = False

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/patterns.py

@@ -158,3 +158,12 @@ 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)
+
+
+NON_ACRO_FORM_PARAM_TO_FUNC = {"alignment": update_created_text_field_alignment}

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/template.py

@@ -118,7 +118,7 @@ def update_text_field_attributes(
 ) -> None:
     """Auto updates text fields' attributes."""
 
-    for _, _widgets in get_widgets_by_page(template_stream).items():
+    for _widgets in get_widgets_by_page(template_stream).values():
         for _widget in _widgets:
             key = get_widget_key(_widget)
 
@@ -155,11 +155,11 @@ def update_text_field_attributes(
 def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     """Iterates through a PDF and returns all widgets found grouped by page."""
 
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
 
     result = {}
 
-    for i, page in enumerate(pdf.pages):
+    for i, page in enumerate(pdf_file.pages):
         widgets = page.annotations
         result[i + 1] = []
         if widgets:
@@ -177,7 +177,7 @@ def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     return result
 
 
-def get_widget_key(widget: dict) -> Union[str, None]:
+def get_widget_key(widget: dict) -> Union[str, list, None]:
     """Finds a PDF widget's annotated key by pattern matching."""
 
     result = None
@@ -189,7 +189,7 @@ def get_widget_key(widget: dict) -> Union[str, None]:
     return result
 
 
-def get_widget_alignment(widget: dict) -> Union[str, None]:
+def get_widget_alignment(widget: dict) -> Union[str, list, None]:
     """Finds a PDF widget's alignment by pattern matching."""
 
     result = None
@@ -249,7 +249,7 @@ def is_text_multiline(widget: dict) -> bool:
     return check_field_flag_bit(widget, MULTILINE)
 
 
-def get_dropdown_choices(widget: dict) -> Union[Tuple[str], None]:
+def get_dropdown_choices(widget: dict) -> Union[Tuple[str, ...], None]:
     """Returns string options of a dropdown field."""
 
     result = None

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/utils.py

@@ -62,10 +62,10 @@ def preview_widget_to_draw(widget: WIDGET_TYPES) -> Text:
 def remove_all_widgets(pdf: bytes) -> bytes:
     """Removes all widgets from a PDF form."""
 
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
     result_stream = BytesIO()
     writer = PdfWriter()
-    for page in pdf.pages:
+    for page in pdf_file.pages:
         if page.annotations:
             page.annotations.clear()
         writer.add_page(page)
@@ -78,10 +78,10 @@ def remove_all_widgets(pdf: bytes) -> bytes:
 def get_page_streams(pdf: bytes) -> List[bytes]:
     """Returns a list of streams where each is a page of the input PDF."""
 
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
     result = []
 
-    for page in pdf.pages:
+    for page in pdf_file.pages:
         writer = PdfWriter()
         writer.add_page(page)
         with BytesIO() as f:
@@ -96,13 +96,13 @@ def merge_two_pdfs(pdf: bytes, other: bytes) -> bytes:
     """Merges two PDFs into one PDF."""
 
     output = PdfWriter()
-    pdf = PdfReader(stream_to_io(pdf))
-    other = PdfReader(stream_to_io(other))
+    pdf_file = PdfReader(stream_to_io(pdf))
+    other_file = PdfReader(stream_to_io(other))
     result = BytesIO()
 
-    for page in pdf.pages:
+    for page in pdf_file.pages:
         output.add_page(page)
-    for page in other.pages:
+    for page in other_file.pages:
         output.add_page(page)
 
     output.write(result)

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm/watermark.py

@@ -165,12 +165,9 @@ def create_watermarks_and_draw(
     watermark = buff.read()
     buff.close()
 
-    results = []
-
-    for i in range(len(pdf_file.pages)):
-        results.append(watermark if i == page_number - 1 else b"")
-
-    return results
+    return [
+        watermark if i == page_number - 1 else b"" for i in range(len(pdf_file.pages))
+    ]
 
 
 def merge_watermarks_with_pdf(
@@ -180,10 +177,10 @@ def merge_watermarks_with_pdf(
     """Merges watermarks with PDF."""
 
     result = BytesIO()
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
     output = PdfWriter()
 
-    for i, page in enumerate(pdf.pages):
+    for i, page in enumerate(pdf_file.pages):
         if watermarks[i]:
             watermark = PdfReader(stream_to_io(watermarks[i]))
             if watermark.pages:

{pypdfform-1.4.30 → pypdfform-1.4.32}/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 = ""
 
@@ -29,12 +34,14 @@ class Widget:
     ) -> None:
         """Sets acro form parameters."""
 
+        super().__init__()
         self.page_number = page_number
         self.acro_form_params = {
             "name": name,
             "x": x,
             "y": y,
         }
+        self.non_acro_form_params = []
 
         for each in self.USER_PARAMS:
             user_input, param = each
@@ -50,6 +57,10 @@ 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((each, kwargs.get(each)))
+
     def watermarks(self, stream: bytes) -> List[bytes]:
         """Returns a list of watermarks after creating the widget."""
 
@@ -71,8 +82,30 @@ class Widget:
         canvas.save()
         watermark.seek(0)
 
-        result = []
-        for i in range(page_count):
-            result.append(watermark.read() if i == self.page_number - 1 else b"")
+        return [
+            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])
 
-        return result
+    with BytesIO() as f:
+        out.write(f)
+        f.seek(0)
+        return f.read()

{pypdfform-1.4.30 → pypdfform-1.4.32}/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"]
     NONE_DEFAULTS = ["max_length"]
     ACRO_FORM_FUNC = "textfield"

{pypdfform-1.4.30 → pypdfform-1.4.32}/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
@@ -36,6 +37,7 @@ class FormWrapper:
     ) -> None:
         """Constructs all attributes for the object."""
 
+        super().__init__()
         self.stream = fp_or_f_obj_or_stream_to_stream(template)
 
     def read(self) -> bytes:
@@ -212,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:
@@ -292,15 +298,13 @@ class PdfWrapper(FormWrapper):
     def schema(self) -> dict:
         """Generates a json schema for the PDF form template."""
 
-        result = {
+        return {
             "type": "object",
             "properties": {
                 key: value.schema_definition for key, value in self.widgets.items()
             },
         }
 
-        return result
-
     @classmethod
     def register_font(
         cls, font_name: str, ttf_file: Union[bytes, str, BinaryIO]

{pypdfform-1.4.30 → pypdfform-1.4.32}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-1.4.30 → pypdfform-1.4.32}/setup.py

@@ -6,7 +6,9 @@ import re
 import setuptools
 
 with open("PyPDFForm/__init__.py", encoding="utf8") as f:
-    version = re.search(r'__version__ = "(.*?)"', f.read()).group(1)
+    version = re.search(r'__version__ = "(.*?)"', f.read())
+    if version:
+        version = version.group(1)
 
 with open("README.md", mode="r", encoding="utf-8") as fh:
     long_description = fh.read()

{pypdfform-1.4.30 → pypdfform-1.4.32}/tests/test_create_widget.py

@@ -198,6 +198,50 @@ def test_create_text_default(template_stream, pdf_samples, request):
         assert obj.stream == expected
 
 
+def test_create_text_align_center(template_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "widget", "create_text_align_center.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).create_widget(
+            "text",
+            "foo",
+            1,
+            100,
+            100,
+            alignment=1,
+        )
+        assert obj.schema["properties"]["foo"]["type"] == "string"
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
+def test_create_text_align_right(template_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "widget", "create_text_align_right.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).create_widget(
+            "text",
+            "foo",
+            1,
+            100,
+            100,
+            alignment=2,
+        )
+        assert obj.schema["properties"]["foo"]["type"] == "string"
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.stream) == len(expected)
+        assert obj.stream == expected
+
+
 def test_create_text_default_filled(template_stream, pdf_samples, request):
     expected_path = os.path.join(
         pdf_samples, "widget", "create_text_default_filled.pdf"

{pypdfform-1.4.30 → pypdfform-1.4.32}/tests/test_functional.py

@@ -12,7 +12,7 @@ from PyPDFForm.middleware.text import Text
 def test_base_schema_definition():
     try:
         assert Widget("foo").schema_definition
-        assert False
+        raise AssertionError
     except NotImplementedError:
         pass
 
@@ -34,7 +34,7 @@ def test_fill(template_stream, pdf_samples, data_dict, request):
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
 
-        for _, widgets in template.get_widgets_by_page(obj.read()).items():
+        for widgets in template.get_widgets_by_page(obj.read()).values():
             assert not widgets
 
 
@@ -375,7 +375,7 @@ def test_schema(sample_template_with_comb_text_field):
     data["LastName"] = "XXXXXXXX"
     try:
         validate(instance=data, schema=schema)
-        assert False
+        raise AssertionError
     except ValidationError:
         pass
 
@@ -386,7 +386,7 @@ def test_schema(sample_template_with_comb_text_field):
     data["Gender"] = 2
     try:
         validate(instance=data, schema=schema)
-        assert False
+        raise AssertionError
     except ValidationError:
         pass
 
@@ -396,12 +396,12 @@ def test_sample_data(sejda_template_complex):
     try:
         validate(instance=obj.sample_data, schema=obj.schema)
     except ValidationError:
-        assert False
+        raise AssertionError from ValidationError
 
     widget = Widget("foo")
     try:
         widget.sample_value()
-        assert False
+        raise AssertionError
     except NotImplementedError:
         pass
 
@@ -429,7 +429,7 @@ def test_fill_right_aligned(
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
 
-        for _, widgets in template.get_widgets_by_page(obj.read()).items():
+        for widgets in template.get_widgets_by_page(obj.read()).values():
             assert not widgets