PyPDFForm 2.2.4__tar.gz → 2.2.5__tar.gz

{pypdfform-2.2.4 → pypdfform-2.2.5}/PKG-INFO

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

{pypdfform-2.2.4 → pypdfform-2.2.5}/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.2.4"
+__version__ = "2.2.5"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/constants.py

@@ -32,7 +32,7 @@ VERSION_IDENTIFIERS = [
     b"%PDF-1.7",
     b"%PDF-2.0",
 ]
-VERSION_IDENTIFIER_PREFIX = b"%PDF-"
+VERSION_IDENTIFIER_PREFIX = "%PDF-".encode("utf-8")
 
 WIDGET_TYPES = Union[Text, Checkbox, Radio, Dropdown, Signature, Image]
 

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/coordinate.py

@@ -28,25 +28,51 @@ from .utils import extract_widget_property, handle_color, stream_to_io
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
 
 
-def get_draw_border_coordinates(widget: dict, shape: str) -> List[float]:
-    """Calculates coordinates for drawing widget borders.
+def get_draw_border_coordinates(widget: dict, shape: str) -> dict:
+    """Calculates coordinates for drawing widget borders in PDF coordinate space.
 
     Args:
-        widget: PDF form widget dictionary containing Rect coordinates
-        shape: Type of border to draw ("rectangle", "ellipse" or "line")
+        widget: PDF form widget dictionary containing Rect coordinates (in PDF points)
+        shape: Type of border to draw:
+            - "rect": Standard rectangular border
+            - "ellipse": Circular/oval border
+            - "line": Straight line border
 
     Returns:
-        List[float]: Coordinates in format [x1, y1, x2, y2] for the border
-            For ellipses: [center_x, center_y, radius_x, radius_y]
-            For lines: [x1, y1, x2, y2] endpoints
+        dict: Coordinate dictionary with different keys depending on shape:
+            - For "rect":
+                {
+                    "x": bottom-left x,
+                    "y": bottom-left y,
+                    "width": total width,
+                    "height": total height
+                }
+            - For "ellipse":
+                {
+                    "x1": left bound,
+                    "y1": bottom bound,
+                    "x2": right bound,
+                    "y2": top bound
+                }
+            - For "line":
+                {
+                    "src_x": start x,
+                    "src_y": start y,
+                    "dest_x": end x,
+                    "dest_y": end y
+                }
+
+    Note:
+        All coordinates are in PDF points (1/72 inch) with origin (0,0) at bottom-left.
+        For ellipses, the bounds form a square that would contain the ellipse.
     """
 
-    result = [
-        float(widget[Rect][0]),
-        float(widget[Rect][1]),
-        abs(float(widget[Rect][0]) - float(widget[Rect][2])),
-        abs(float(widget[Rect][1]) - float(widget[Rect][3])),
-    ]
+    result = {
+        "x": float(widget[Rect][0]),
+        "y": float(widget[Rect][1]),
+        "width": abs(float(widget[Rect][0]) - float(widget[Rect][2])),
+        "height": abs(float(widget[Rect][1]) - float(widget[Rect][3])),
+    }
 
     if shape == "ellipse":
         width = abs(float(widget[Rect][0]) - float(widget[Rect][2]))
@@ -57,19 +83,19 @@ def get_draw_border_coordinates(widget: dict, shape: str) -> List[float]:
 
         less = min(width, height)
 
-        result = [
-            width_mid - less / 2,
-            height_mid - less / 2,
-            width_mid + less / 2,
-            height_mid + less / 2,
-        ]
+        result = {
+            "x1": width_mid - less / 2,
+            "y1": height_mid - less / 2,
+            "x2": width_mid + less / 2,
+            "y2": height_mid + less / 2,
+        }
     elif shape == "line":
-        result = [
-            float(widget[Rect][0]),
-            float(widget[Rect][1]),
-            float(widget[Rect][2]),
-            float(widget[Rect][1]),
-        ]
+        result = {
+            "src_x": float(widget[Rect][0]),
+            "src_y": float(widget[Rect][1]),
+            "dest_x": float(widget[Rect][2]),
+            "dest_y": float(widget[Rect][1]),
+        }
 
     return result
 
@@ -397,14 +423,32 @@ def generate_coordinate_grid(
         current = margin
         while current < width:
             lines_by_page[i + 1].append(
-                [current, 0, current, height, handle_color([r, g, b]), None, 1, None]
+                {
+                    "src_x": current,
+                    "src_y": 0,
+                    "dest_x": current,
+                    "dest_y": height,
+                    "border_color": handle_color([r, g, b]),
+                    "background_color": None,
+                    "border_width": 1,
+                    "dash_array": None,
+                }
             )
             current += margin
 
         current = margin
         while current < height:
             lines_by_page[i + 1].append(
-                [0, current, width, current, handle_color([r, g, b]), None, 1, None]
+                {
+                    "src_x": 0,
+                    "src_y": current,
+                    "dest_x": width,
+                    "dest_y": current,
+                    "border_color": handle_color([r, g, b]),
+                    "background_color": None,
+                    "border_width": 1,
+                    "dash_array": None,
+                }
             )
             current += margin
 
@@ -419,11 +463,11 @@ def generate_coordinate_grid(
                 text.font_size = font_size
                 text.font_color = color
                 texts_by_page[i + 1].append(
-                    [
-                        text,
-                        x - stringWidth(value, DEFAULT_FONT, font_size),
-                        y - font_size,
-                    ]
+                    {
+                        "widget": text,
+                        "x": x - stringWidth(value, DEFAULT_FONT, font_size),
+                        "y": y - font_size,
+                    }
                 )
                 y += margin
             x += margin

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/filler.py

@@ -104,13 +104,13 @@ def signature_image_handler(
             widget, middleware.preserve_aspect_ratio, image_width, image_height
         )
         images_to_draw.append(
-            [
-                stream,
-                x,
-                y,
-                width,
-                height,
-            ]
+            {
+                "stream": stream,
+                "x": x,
+                "y": y,
+                "width": width,
+                "height": height,
+            }
         )
 
     return any_image_to_draw
@@ -172,19 +172,24 @@ def border_handler(
         shape = "rect"
 
     list_to_append.append(
-        get_draw_border_coordinates(widget, shape)
-        + [
-            middleware.border_color,
-            middleware.background_color,
-            middleware.border_width,
-            middleware.dash_array,
-        ]
+        {
+            **get_draw_border_coordinates(widget, shape),
+            "border_color": middleware.border_color,
+            "background_color": middleware.background_color,
+            "border_width": middleware.border_width,
+            "dash_array": middleware.dash_array,
+        }
     )
 
     if shape == "line":
         rect_borders_to_draw.append(
-            get_draw_border_coordinates(widget, "rect")
-            + [None, middleware.background_color, 0, None]
+            {
+                **get_draw_border_coordinates(widget, "rect"),
+                "border_color": None,
+                "background_color": middleware.background_color,
+                "border_width": 0,
+                "dash_array": None,
+            }
         )
 
 
@@ -281,11 +286,11 @@ def fill(
                 ]
             ):
                 texts_to_draw[page].append(
-                    [
-                        to_draw,
-                        x,
-                        y,
-                    ]
+                    {
+                        "widget": to_draw,
+                        "x": x,
+                        "y": y,
+                    }
                 )
 
     result = template_stream

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/utils.py

@@ -11,6 +11,7 @@ This module contains general-purpose utilities used throughout PyPDFForm:
 """
 
 from collections.abc import Callable
+from functools import lru_cache
 from io import BytesIO
 from secrets import choice
 from string import ascii_letters, digits, punctuation
@@ -29,6 +30,7 @@ from .middleware.radio import Radio
 from .middleware.text import Text
 
 
+@lru_cache
 def stream_to_io(stream: bytes) -> BinaryIO:
     """Converts a byte stream to a seekable binary IO object.
 

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/watermark.py

@@ -22,7 +22,7 @@ from .patterns import WIDGET_KEY_PATTERNS
 from .utils import extract_widget_property, stream_to_io
 
 
-def draw_text(*args) -> None:
+def draw_text(canvas: Canvas, **kwargs) -> None:
     """Draws text onto a watermark canvas with proper formatting.
 
     Handles:
@@ -32,16 +32,16 @@ def draw_text(*args) -> None:
     - Text alignment
 
     Args:
-        args[0]: Canvas object to draw on
-        args[1]: Text widget with content and properties
-        args[2]: X coordinate for drawing
-        args[3]: Y coordinate for drawing
+        canvas: Canvas object to draw on
+        **kwargs: Additional arguments including:
+            widget: Text widget with content and properties
+            x: X coordinate for drawing
+            y: Y coordinate for drawing
     """
 
-    canvas = args[0]
-    widget = args[1]
-    coordinate_x = args[2]
-    coordinate_y = args[3]
+    widget = kwargs["widget"]
+    coordinate_x = kwargs["x"]
+    coordinate_y = kwargs["y"]
 
     text_to_draw = widget.value
 
@@ -96,106 +96,105 @@ def draw_text(*args) -> None:
         canvas.restoreState()
 
 
-def draw_rect(*args) -> None:
+def draw_rect(canvas: Canvas, **kwargs) -> None:
     """Draws a rectangle onto a watermark canvas.
 
     Args:
-        args[0]: Canvas object to draw on
-        args[1]: X coordinate of bottom-left corner
-        args[2]: Y coordinate of bottom-left corner
-        args[3]: Width of rectangle
-        args[4]: Height of rectangle
-        args[5]: Border color
-        args[6]: Background color
-        args[7]: Border width
-        args[8]: Dash pattern for border
+        canvas: Canvas object to draw on
+        **kwargs: Additional arguments including:
+            x: X coordinate of bottom-left corner
+            y: Y coordinate of bottom-left corner
+            width: Width of rectangle
+            height: Height of rectangle
+            border_color: Border color
+            background_color: Background color
+            border_width: Border width
+            dash_array: Dash pattern for border
     """
 
-    canvas = args[0]
-    x = args[1]
-    y = args[2]
-    width = args[3]
-    height = args[4]
+    x = kwargs["x"]
+    y = kwargs["y"]
+    width = kwargs["width"]
+    height = kwargs["height"]
 
     canvas.saveState()
-    stroke, fill = set_border_and_background_styles(*args)
+    stroke, fill = set_border_and_background_styles(canvas, **kwargs)
     canvas.rect(x, y, width, height, stroke=stroke, fill=fill)
     canvas.restoreState()
 
 
-def draw_ellipse(*args) -> None:
+def draw_ellipse(canvas: Canvas, **kwargs) -> None:
     """Draws an ellipse onto a watermark canvas.
 
     Args:
-        args[0]: Canvas object to draw on
-        args[1]: X coordinate of first bounding point
-        args[2]: Y coordinate of first bounding point
-        args[3]: X coordinate of second bounding point
-        args[4]: Y coordinate of second bounding point
-        args[5]: Border color
-        args[6]: Background color
-        args[7]: Border width
-        args[8]: Dash pattern for border
+        canvas: Canvas object to draw on
+        **kwargs: Additional arguments including:
+            x1: X coordinate of first bounding point
+            y1: Y coordinate of first bounding point
+            x2: X coordinate of second bounding point
+            y2: Y coordinate of second bounding point
+            border_color: Border color
+            background_color: Background color
+            border_width: Border width
+            dash_array: Dash pattern for border
     """
 
-    canvas = args[0]
-    x1 = args[1]
-    y1 = args[2]
-    x2 = args[3]
-    y2 = args[4]
+    x1 = kwargs["x1"]
+    y1 = kwargs["y1"]
+    x2 = kwargs["x2"]
+    y2 = kwargs["y2"]
 
     canvas.saveState()
-    stroke, fill = set_border_and_background_styles(*args)
+    stroke, fill = set_border_and_background_styles(canvas, **kwargs)
     canvas.ellipse(x1, y1, x2, y2, stroke=stroke, fill=fill)
     canvas.restoreState()
 
 
-def draw_line(*args) -> None:
+def draw_line(canvas: Canvas, **kwargs) -> None:
     """Draws a line onto a watermark canvas.
 
     Args:
-        args[0]: Canvas object to draw on
-        args[1]: X coordinate of start point
-        args[2]: Y coordinate of start point
-        args[3]: X coordinate of end point
-        args[4]: Y coordinate of end point
-        args[5]: Line color
-        args[6]: Unused (kept for consistency)
-        args[7]: Line width
-        args[8]: Dash pattern for line
+        canvas: Canvas object to draw on
+        **kwargs: Additional arguments including:
+            src_x: X coordinate of start point
+            src_y: Y coordinate of start point
+            dest_x: X coordinate of end point
+            dest_y: Y coordinate of end point
+            border_color: Line color
+            border_width: Line width
+            dash_array: Dash pattern for line
     """
 
-    canvas = args[0]
-    src_x = args[1]
-    src_y = args[2]
-    dest_x = args[3]
-    dest_y = args[4]
+    src_x = kwargs["src_x"]
+    src_y = kwargs["src_y"]
+    dest_x = kwargs["dest_x"]
+    dest_y = kwargs["dest_y"]
 
     canvas.saveState()
-    set_border_and_background_styles(*args)
+    set_border_and_background_styles(canvas, **kwargs)
     canvas.line(src_x, src_y, dest_x, dest_y)
     canvas.restoreState()
 
 
-def set_border_and_background_styles(*args) -> tuple:
+def set_border_and_background_styles(canvas: Canvas, **kwargs) -> tuple:
     """Configures stroke and fill styles for drawing operations.
 
     Args:
-        args[0]: Canvas object to configure
-        args[5]: Border color
-        args[6]: Background color
-        args[7]: Border width
-        args[8]: Dash pattern for border
+        canvas: Canvas object to configure
+        **kwargs: Additional arguments including:
+            border_color: Border color
+            background_color: Background color
+            border_width: Border width
+            dash_array: Dash pattern for border
 
     Returns:
         tuple: (stroke_flag, fill_flag) indicating which styles were set
     """
 
-    canvas = args[0]
-    border_color = args[5]
-    background_color = args[6]
-    border_width = args[7]
-    dash_array = args[8]
+    border_color = kwargs["border_color"]
+    background_color = kwargs["background_color"]
+    border_width = kwargs["border_width"]
+    dash_array = kwargs["dash_array"]
 
     stroke = 0
     fill = 0
@@ -213,24 +212,24 @@ def set_border_and_background_styles(*args) -> tuple:
     return stroke, fill
 
 
-def draw_image(*args) -> None:
+def draw_image(canvas: Canvas, **kwargs) -> None:
     """Draws an image onto a watermark canvas.
 
     Args:
-        args[0]: Canvas object to draw on
-        args[1]: Image data as bytes
-        args[2]: X coordinate for drawing
-        args[3]: Y coordinate for drawing
-        args[4]: Width of drawn image
-        args[5]: Height of drawn image
+        canvas: Canvas object to draw on
+        **kwargs: Additional arguments including:
+            stream: Image data as bytes
+            x: X coordinate for drawing
+            y: Y coordinate for drawing
+            width: Width of drawn image
+            height: Height of drawn image
     """
 
-    canvas = args[0]
-    image_stream = args[1]
-    coordinate_x = args[2]
-    coordinate_y = args[3]
-    width = args[4]
-    height = args[5]
+    image_stream = kwargs["stream"]
+    coordinate_x = kwargs["x"]
+    coordinate_y = kwargs["y"]
+    width = kwargs["width"]
+    height = kwargs["height"]
 
     image_buff = BytesIO()
     image_buff.write(image_stream)
@@ -252,7 +251,7 @@ def create_watermarks_and_draw(
     pdf: bytes,
     page_number: int,
     action_type: str,
-    actions: List[list],
+    actions: List[dict],
 ) -> List[bytes]:
     """Creates watermarks for each page with specified drawing operations.
 
@@ -277,21 +276,17 @@ def create_watermarks_and_draw(
         ),
     )
 
-    if action_type == "image":
-        for each in actions:
-            draw_image(*([canvas, *each]))
-    elif action_type == "text":
-        for each in actions:
-            draw_text(*([canvas, *each]))
-    elif action_type == "line":
-        for each in actions:
-            draw_line(*([canvas, *each]))
-    elif action_type == "rect":
-        for each in actions:
-            draw_rect(*([canvas, *each]))
-    elif action_type == "ellipse":
+    action_type_to_func = {
+        "image": draw_image,
+        "text": draw_text,
+        "line": draw_line,
+        "rect": draw_rect,
+        "ellipse": draw_ellipse,
+    }
+
+    if action_type_to_func.get(action_type):
         for each in actions:
-            draw_ellipse(*([canvas, *each]))
+            action_type_to_func[action_type](canvas, **each)
 
     canvas.save()
     buff.seek(0)

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/widgets/base.py

@@ -83,7 +83,7 @@ class Widget:
                     )
                 self.acro_form_params[param] = value
             elif user_input in self.NONE_DEFAULTS:
-                self.acro_form_params[param] = None
+                self.acro_form_params[param] = None  # noqa
 
         for each in self.ALLOWED_NON_ACRO_FORM_PARAMS:
             if each in kwargs:

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/widgets/signature.py

@@ -101,7 +101,7 @@ class SignatureWidget:
 
         input_pdf = PdfReader(stream_to_io(stream))
         page_count = len(input_pdf.pages)
-        pdf = PdfReader(stream_to_io(BEDROCK_PDF))
+        pdf = PdfReader(stream_to_io(BEDROCK_PDF))  # noqa
         out = PdfWriter()
         out.append(pdf)
 

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm/wrapper.py

@@ -620,11 +620,11 @@ class PdfWrapper(FormWrapper):
             page_number,
             "text",
             [
-                [
-                    new_widget,
-                    x,
-                    y,
-                ]
+                {
+                    "widget": new_widget,
+                    "x": x,
+                    "y": y,
+                }
             ],
         )
 
@@ -667,7 +667,10 @@ class PdfWrapper(FormWrapper):
         image = fp_or_f_obj_or_stream_to_stream(image)
         image = rotate_image(image, rotation)
         watermarks = create_watermarks_and_draw(
-            self.stream, page_number, "image", [[image, x, y, width, height]]
+            self.stream,
+            page_number,
+            "image",
+            [{"stream": image, "x": x, "y": y, "width": width, "height": height}],
         )
 
         stream_with_widgets = self.read()

{pypdfform-2.2.4 → pypdfform-2.2.5}/PyPDFForm.egg-info/PKG-INFO

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