PyPDFForm 3.5.4__tar.gz → 3.5.5__tar.gz

{pypdfform-3.5.4 → pypdfform-3.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 3.5.4
+Version: 3.5.5
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -49,7 +49,7 @@ Dynamic: license-file
     <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
     <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
-    <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
+    <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?color=blue"></a>
 </p>
 
 ## Introduction

{pypdfform-3.5.4 → pypdfform-3.5.5}/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.5.4"
+__version__ = "3.5.5"
 
 from .middleware.text import Text  # exposing for setting global font attrs
 from .widgets import Fields

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 3.5.4
+Version: 3.5.5
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -49,7 +49,7 @@ Dynamic: license-file
     <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
     <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
-    <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
+    <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?color=blue"></a>
 </p>
 
 ## Introduction

{pypdfform-3.5.4 → pypdfform-3.5.5}/README.md

@@ -8,7 +8,7 @@
     <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
     <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
-    <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
+    <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?color=blue"></a>
 </p>
 
 ## Introduction

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/base.py

@@ -25,35 +25,6 @@ from ..constants import fieldFlags, required
 from ..utils import stream_to_io
 
 
-@dataclass
-class Field:
-    """
-    Base dataclass for all PDF form fields.
-
-    This class defines the common properties that all types of form fields
-    (e.g., text fields, checkboxes, radio buttons) share. Specific field types
-    will extend this class to add their unique attributes.
-
-    Attributes:
-        name (str): The name of the form field. This is used to identify the
-            field within the PDF document.
-        page_number (int): The 1-based page number on which the field is located.
-        x (float): The x-coordinate of the field's position on the page.
-        y (float): The y-coordinate of the field's position on the page.
-        required (Optional[bool]): Indicates whether the field is required to be
-            filled by the user. Defaults to None, meaning not explicitly set.
-        tooltip (Optional[str]): A tooltip message that appears when the user
-            hovers over the field. Defaults to None.
-    """
-
-    name: str
-    page_number: int
-    x: float
-    y: float
-    required: Optional[bool] = None
-    tooltip: Optional[str] = None
-
-
 class Widget:
     """
     Base class for all widgets in PyPDFForm.
@@ -219,3 +190,32 @@ class Widget:
             watermark.read() if i == self.page_number - 1 else b""
             for i in range(page_count)
         ]
+
+
+@dataclass
+class Field:
+    """
+    Base dataclass for all PDF form fields.
+
+    This class defines the common properties that all types of form fields
+    (e.g., text fields, checkboxes, radio buttons) share. Specific field types
+    will extend this class to add their unique attributes.
+
+    Attributes:
+        name (str): The name of the form field. This is used to identify the
+            field within the PDF document.
+        page_number (int): The 1-based page number on which the field is located.
+        x (float): The x-coordinate of the field's position on the page.
+        y (float): The y-coordinate of the field's position on the page.
+        required (Optional[bool]): Indicates whether the field is required to be
+            filled by the user. Defaults to None, meaning not explicitly set.
+        tooltip (Optional[str]): A tooltip message that appears when the user
+            hovers over the field. Defaults to None.
+    """
+
+    name: str
+    page_number: int
+    x: float
+    y: float
+    required: Optional[bool] = None
+    tooltip: Optional[str] = None

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/checkbox.py

@@ -16,35 +16,6 @@ from typing import Optional, Tuple
 from .base import Field, Widget
 
 
-@dataclass
-class CheckBoxField(Field):
-    """
-    Represents a checkbox field in a PDF document.
-
-    This dataclass extends the `Field` base class and defines the specific
-    attributes that can be configured for a checkbox field.
-
-    Attributes:
-        _field_type (str): The type of the field, fixed as "checkbox".
-        size (Optional[float]): The size of the checkbox.
-        button_style (Optional[str]): The visual style of the checkbox button
-            (e.g., "check", "circle", "cross").
-        tick_color (Optional[Tuple[float, ...]]): The color of the checkmark or tick.
-        bg_color (Optional[Tuple[float, ...]]): The background color of the checkbox.
-        border_color (Optional[Tuple[float, ...]]): The color of the checkbox's border.
-        border_width (Optional[float]): The width of the checkbox's border.
-    """
-
-    _field_type: str = "checkbox"
-
-    size: Optional[float] = None
-    button_style: Optional[str] = None
-    tick_color: Optional[Tuple[float, ...]] = None
-    bg_color: Optional[Tuple[float, ...]] = None
-    border_color: Optional[Tuple[float, ...]] = None
-    border_width: Optional[float] = None
-
-
 class CheckBoxWidget(Widget):
     """
     Represents a checkbox widget in a PDF form.
@@ -74,3 +45,32 @@ class CheckBoxWidget(Widget):
     COLOR_PARAMS = ["tick_color", "bg_color", "border_color"]
     ALLOWED_HOOK_PARAMS = ["size"]
     ACRO_FORM_FUNC = "checkbox"
+
+
+@dataclass
+class CheckBoxField(Field):
+    """
+    Represents a checkbox field in a PDF document.
+
+    This dataclass extends the `Field` base class and defines the specific
+    attributes that can be configured for a checkbox field.
+
+    Attributes:
+        _field_type (str): The type of the field, fixed as "checkbox".
+        size (Optional[float]): The size of the checkbox.
+        button_style (Optional[str]): The visual style of the checkbox button
+            (e.g., "check", "circle", "cross").
+        tick_color (Optional[Tuple[float, ...]]): The color of the checkmark or tick.
+        bg_color (Optional[Tuple[float, ...]]): The background color of the checkbox.
+        border_color (Optional[Tuple[float, ...]]): The color of the checkbox's border.
+        border_width (Optional[float]): The width of the checkbox's border.
+    """
+
+    _field_type: str = "checkbox"
+
+    size: Optional[float] = None
+    button_style: Optional[str] = None
+    tick_color: Optional[Tuple[float, ...]] = None
+    bg_color: Optional[Tuple[float, ...]] = None
+    border_color: Optional[Tuple[float, ...]] = None
+    border_width: Optional[float] = None

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/dropdown.py

@@ -17,43 +17,6 @@ from .base import Field
 from .text import TextWidget
 
 
-@dataclass
-class DropdownField(Field):
-    """
-    Represents a dropdown field in a PDF document.
-
-    This dataclass extends the `Field` base class and defines the specific
-    attributes that can be configured for a dropdown selection field.
-
-    Attributes:
-        _field_type (str): The type of the field, fixed as "dropdown".
-        options (Optional[List[Union[str, Tuple[str, str]]]]): A list of options
-            available in the dropdown. Each option can be a string (display value)
-            or a tuple of strings (display value, export value).
-        width (Optional[float]): The width of the dropdown field.
-        height (Optional[float]): The height of the dropdown field.
-        font (Optional[str]): The font to use for the dropdown text.
-        font_size (Optional[float]): The font size for the dropdown text.
-        font_color (Optional[Tuple[float, ...]]): The color of the font as an RGB or RGBA tuple.
-        bg_color (Optional[Tuple[float, ...]]): The background color of the dropdown field.
-        border_color (Optional[Tuple[float, ...]]): The color of the dropdown's border.
-        border_width (Optional[float]): The width of the dropdown's border.
-    """
-
-    _field_type: str = "dropdown"
-
-    options: Optional[List[Union[str, Tuple[str, str]]]] = None
-    width: Optional[float] = None
-    height: Optional[float] = None
-    # pylint: disable=R0801
-    font: Optional[str] = None
-    font_size: Optional[float] = None
-    font_color: Optional[Tuple[float, ...]] = None
-    bg_color: Optional[Tuple[float, ...]] = None
-    border_color: Optional[Tuple[float, ...]] = None
-    border_width: Optional[float] = None
-
-
 class DropdownWidget(TextWidget):
     """
     Represents a dropdown widget in a PDF form.
@@ -94,3 +57,40 @@ class DropdownWidget(TextWidget):
         super().__init__(name, page_number, x, y, **kwargs)
         self.acro_form_params["wkind"] = "choice"
         self.acro_form_params["value"] = self.acro_form_params["options"][0]
+
+
+@dataclass
+class DropdownField(Field):
+    """
+    Represents a dropdown field in a PDF document.
+
+    This dataclass extends the `Field` base class and defines the specific
+    attributes that can be configured for a dropdown selection field.
+
+    Attributes:
+        _field_type (str): The type of the field, fixed as "dropdown".
+        options (Optional[List[Union[str, Tuple[str, str]]]]): A list of options
+            available in the dropdown. Each option can be a string (display value)
+            or a tuple of strings (display value, export value).
+        width (Optional[float]): The width of the dropdown field.
+        height (Optional[float]): The height of the dropdown field.
+        font (Optional[str]): The font to use for the dropdown text.
+        font_size (Optional[float]): The font size for the dropdown text.
+        font_color (Optional[Tuple[float, ...]]): The color of the font as an RGB or RGBA tuple.
+        bg_color (Optional[Tuple[float, ...]]): The background color of the dropdown field.
+        border_color (Optional[Tuple[float, ...]]): The color of the dropdown's border.
+        border_width (Optional[float]): The width of the dropdown's border.
+    """
+
+    _field_type: str = "dropdown"
+
+    options: Optional[List[Union[str, Tuple[str, str]]]] = None
+    width: Optional[float] = None
+    height: Optional[float] = None
+    # pylint: disable=R0801
+    font: Optional[str] = None
+    font_size: Optional[float] = None
+    font_color: Optional[Tuple[float, ...]] = None
+    bg_color: Optional[Tuple[float, ...]] = None
+    border_color: Optional[Tuple[float, ...]] = None
+    border_width: Optional[float] = None

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/image.py

@@ -16,22 +16,6 @@ from dataclasses import dataclass
 from .signature import SignatureField, SignatureWidget
 
 
-@dataclass
-class ImageField(SignatureField):
-    """
-    Represents an image field in a PDF document.
-
-    This dataclass extends the `SignatureField` base class and defines the
-    specific attributes for an image input field. It inherits `width` and
-    `height` from `SignatureField` as images also have dimensions.
-
-    Attributes:
-        _field_type (str): The type of the field, fixed as "image".
-    """
-
-    _field_type: str = "image"
-
-
 class ImageWidget(SignatureWidget):
     """
     Represents an image widget in a PDF form.
@@ -47,3 +31,19 @@ class ImageWidget(SignatureWidget):
     """
 
     BEDROCK_WIDGET_TO_COPY = "image"
+
+
+@dataclass
+class ImageField(SignatureField):
+    """
+    Represents an image field in a PDF document.
+
+    This dataclass extends the `SignatureField` base class and defines the
+    specific attributes for an image input field. It inherits `width` and
+    `height` from `SignatureField` as images also have dimensions.
+
+    Attributes:
+        _field_type (str): The type of the field, fixed as "image".
+    """
+
+    _field_type: str = "image"

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/radio.py

@@ -18,31 +18,6 @@ from reportlab.pdfgen.canvas import Canvas
 from .checkbox import CheckBoxField, CheckBoxWidget
 
 
-@dataclass
-class RadioGroup(CheckBoxField):
-    """
-    Represents a group of radio buttons in a PDF document.
-
-    This dataclass extends the `CheckBoxField` base class and defines the specific
-    attributes that can be configured for a radio button group. Unlike a single
-    checkbox, a radio group allows for multiple positions (x, y coordinates)
-    where individual radio buttons can be placed, but only one can be selected.
-
-    Attributes:
-        _field_type (str): The type of the field, fixed as "radio".
-        x (List[float]): A list of x-coordinates for each radio button in the group.
-        y (List[float]): A list of y-coordinates for each radio button in the group.
-        shape (Optional[str]): The shape of the radio button. Valid values are
-            "circle" or "square". Defaults to None, which typically means a default circle shape.
-    """
-
-    _field_type: str = "radio"
-
-    x: List[float]
-    y: List[float]
-    shape: Optional[str] = None
-
-
 class RadioWidget(CheckBoxWidget):
     """
     Represents a radio button widget in a PDF form.
@@ -97,3 +72,28 @@ class RadioWidget(CheckBoxWidget):
             new_acro_form_params["y"] = y
             new_acro_form_params["value"] = str(i)
             getattr(canvas.acroForm, self.ACRO_FORM_FUNC)(**new_acro_form_params)
+
+
+@dataclass
+class RadioGroup(CheckBoxField):
+    """
+    Represents a group of radio buttons in a PDF document.
+
+    This dataclass extends the `CheckBoxField` base class and defines the specific
+    attributes that can be configured for a radio button group. Unlike a single
+    checkbox, a radio group allows for multiple positions (x, y coordinates)
+    where individual radio buttons can be placed, but only one can be selected.
+
+    Attributes:
+        _field_type (str): The type of the field, fixed as "radio".
+        x (List[float]): A list of x-coordinates for each radio button in the group.
+        y (List[float]): A list of y-coordinates for each radio button in the group.
+        shape (Optional[str]): The shape of the radio button. Valid values are
+            "circle" or "square". Defaults to None, which typically means a default circle shape.
+    """
+
+    _field_type: str = "radio"
+
+    x: List[float]
+    y: List[float]
+    shape: Optional[str] = None

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/signature.py

@@ -26,26 +26,6 @@ from .base import Field
 from .bedrock import BEDROCK_PDF
 
 
-@dataclass
-class SignatureField(Field):
-    """
-    Represents a signature field in a PDF document.
-
-    This dataclass extends the `Field` base class and defines the specific
-    attributes that can be configured for a signature input field.
-
-    Attributes:
-        _field_type (str): The type of the field, fixed as "signature".
-        width (Optional[float]): The width of the signature field.
-        height (Optional[float]): The height of the signature field.
-    """
-
-    _field_type: str = "signature"
-
-    width: Optional[float] = None
-    height: Optional[float] = None
-
-
 class SignatureWidget:
     """
     Represents a signature widget in a PDF form.
@@ -151,3 +131,23 @@ class SignatureWidget:
                 f.read() if i == self.page_number - 1 else b""
                 for i in range(page_count)
             ]
+
+
+@dataclass
+class SignatureField(Field):
+    """
+    Represents a signature field in a PDF document.
+
+    This dataclass extends the `Field` base class and defines the specific
+    attributes that can be configured for a signature input field.
+
+    Attributes:
+        _field_type (str): The type of the field, fixed as "signature".
+        width (Optional[float]): The width of the signature field.
+        height (Optional[float]): The height of the signature field.
+    """
+
+    _field_type: str = "signature"
+
+    width: Optional[float] = None
+    height: Optional[float] = None

{pypdfform-3.5.4 → pypdfform-3.5.5}/PyPDFForm/widgets/text.py

@@ -16,6 +16,43 @@ from typing import Optional, Tuple
 from .base import Field, Widget
 
 
+class TextWidget(Widget):
+    """
+    Represents a text widget in a PDF form.
+
+    This class inherits from the base Widget class and provides specific
+    parameters for text field styling, such as width, height, font size,
+    font color, background color, border color, border width, and maximum
+    length.
+
+    Attributes:
+        USER_PARAMS (list): A list of tuples, where each tuple contains the
+            user-facing parameter name and the corresponding AcroForm parameter name.
+        COLOR_PARAMS (list): A list of user-facing parameter names that represent colors.
+        ALLOWED_HOOK_PARAMS (list): A list of allowed hook parameters.
+        NONE_DEFAULTS (list): A list of parameters that default to None.
+        ACRO_FORM_FUNC (str): The name of the AcroForm function to use for
+            creating the text field.
+    """
+
+    USER_PARAMS = [
+        ("required", "required"),
+        ("tooltip", "tooltip"),
+        ("width", "width"),
+        ("height", "height"),
+        ("font_size", "fontSize"),
+        ("font_color", "textColor"),
+        ("bg_color", "fillColor"),
+        ("border_color", "borderColor"),
+        ("border_width", "borderWidth"),
+        ("max_length", "maxlen"),
+    ]
+    COLOR_PARAMS = ["font_color", "bg_color", "border_color"]
+    ALLOWED_HOOK_PARAMS = ["alignment", "multiline", "comb", "font"]
+    NONE_DEFAULTS = ["max_length"]
+    ACRO_FORM_FUNC = "textfield"
+
+
 @dataclass
 class TextField(Field):
     """
@@ -55,40 +92,3 @@ class TextField(Field):
     border_width: Optional[float] = None
     alignment: Optional[int] = None
     multiline: Optional[bool] = None
-
-
-class TextWidget(Widget):
-    """
-    Represents a text widget in a PDF form.
-
-    This class inherits from the base Widget class and provides specific
-    parameters for text field styling, such as width, height, font size,
-    font color, background color, border color, border width, and maximum
-    length.
-
-    Attributes:
-        USER_PARAMS (list): A list of tuples, where each tuple contains the
-            user-facing parameter name and the corresponding AcroForm parameter name.
-        COLOR_PARAMS (list): A list of user-facing parameter names that represent colors.
-        ALLOWED_HOOK_PARAMS (list): A list of allowed hook parameters.
-        NONE_DEFAULTS (list): A list of parameters that default to None.
-        ACRO_FORM_FUNC (str): The name of the AcroForm function to use for
-            creating the text field.
-    """
-
-    USER_PARAMS = [
-        ("required", "required"),
-        ("tooltip", "tooltip"),
-        ("width", "width"),
-        ("height", "height"),
-        ("font_size", "fontSize"),
-        ("font_color", "textColor"),
-        ("bg_color", "fillColor"),
-        ("border_color", "borderColor"),
-        ("border_width", "borderWidth"),
-        ("max_length", "maxlen"),
-    ]
-    COLOR_PARAMS = ["font_color", "bg_color", "border_color"]
-    ALLOWED_HOOK_PARAMS = ["alignment", "multiline", "comb", "font"]
-    NONE_DEFAULTS = ["max_length"]
-    ACRO_FORM_FUNC = "textfield"