PyPDFForm 1.4.11__py3-none-any.whl → 1.4.13__py3-none-any.whl

PyPDFForm/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.4.11"
+__version__ = "1.4.13"
 
-from .wrapper import PdfWrapper, PyPDFForm
+from .wrapper import FormWrapper, PdfWrapper, PyPDFForm

PyPDFForm/constants.py

@@ -26,6 +26,7 @@ WIDGET_TYPES = Union[Text, Checkbox, Radio, Dropdown, Signature]
 
 DEPRECATION_NOTICE = "{} will be deprecated soon. Use {} instead."
 
+ANNOTATION_KEY = "/Annots"
 ANNOTATION_FIELD_KEY = "/T"
 ANNOTATION_RECTANGLE_KEY = "/Rect"
 SUBTYPE_KEY = "/Subtype"
@@ -34,6 +35,8 @@ WIDGET_TYPE_KEY = "/FT"
 PARENT_KEY = "/Parent"
 FIELD_FLAG_KEY = "/Ff"
 TEXT_FIELD_IDENTIFIER = "/Tx"
+TEXT_VALUE_IDENTIFIER = "/V"
+TEXT_VALUE_SHOW_UP_IDENTIFIER = "/AP"
 SIGNATURE_FIELD_IDENTIFIER = "/Sig"
 TEXT_FIELD_APPEARANCE_IDENTIFIER = "/DA"
 SELECTABLE_IDENTIFIER = "/Btn"
@@ -43,6 +46,7 @@ CHOICE_FIELD_IDENTIFIER = "/Ch"
 CHOICES_IDENTIFIER = "/Opt"
 BUTTON_IDENTIFIER = "/MK"
 BUTTON_STYLE_IDENTIFIER = "/CA"
+SELECTED_IDENTIFIER = "/AS"
 
 # Field flag bits
 MULTILINE = 1 << 12
@@ -60,9 +64,11 @@ NEW_LINE_SYMBOL = "\n"
 DEFAULT_CHECKBOX_STYLE = "\u2713"
 DEFAULT_RADIO_STYLE = "\u25CF"
 BUTTON_STYLES = {
-    "4": "\u2713",
-    "5": "\u00D7",
-    "l": "\u25CF",
+    "4": "\u2713",  # check
+    "5": "\u00D7",  # cross
+    "l": "\u25CF",  # circle
 }
 
+CHECKBOX_SELECT = "/Yes"
+
 COORDINATE_GRID_FONT_SIZE_MARGIN_RATIO = DEFAULT_FONT_SIZE / 100

PyPDFForm/filler.py

@@ -1,9 +1,15 @@
 # -*- coding: utf-8 -*-
 """Contains helpers for filling a PDF form."""
 
-from typing import Dict
+from io import BytesIO
+from typing import Dict, cast
 
-from .constants import WIDGET_TYPES
+from pypdf import PdfReader, PdfWriter
+from pypdf.generic import DictionaryObject, NameObject, TextStringObject
+
+from .constants import (ANNOTATION_KEY, CHECKBOX_SELECT, SELECTED_IDENTIFIER,
+                        TEXT_VALUE_IDENTIFIER, TEXT_VALUE_SHOW_UP_IDENTIFIER,
+                        WIDGET_TYPES)
 from .coordinate import (get_draw_checkbox_radio_coordinates,
                          get_draw_sig_coordinates_resolutions,
                          get_draw_text_coordinates,
@@ -11,10 +17,12 @@ from .coordinate import (get_draw_checkbox_radio_coordinates,
 from .font import checkbox_radio_font_size
 from .image import any_image_to_jpg
 from .middleware.checkbox import Checkbox
+from .middleware.dropdown import Dropdown
 from .middleware.radio import Radio
 from .middleware.signature import Signature
+from .middleware.text import Text
 from .template import get_widget_key, get_widgets_by_page
-from .utils import checkbox_radio_to_draw
+from .utils import checkbox_radio_to_draw, stream_to_io
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
 
 
@@ -44,10 +52,14 @@ def fill(
             _to_draw = x = y = None
 
             if isinstance(widgets[key], (Checkbox, Radio)):
-                font_size = checkbox_radio_font_size(_widget)
+                font_size = (
+                    checkbox_radio_font_size(_widget)
+                    if widgets[key].size is None
+                    else widgets[key].size
+                )
                 _to_draw = checkbox_radio_to_draw(widgets[key], font_size)
                 x, y = get_draw_checkbox_radio_coordinates(_widget, _to_draw)
-                if isinstance(widgets[key], Checkbox) and widgets[key].value:
+                if type(widgets[key]) is Checkbox and widgets[key].value:
                     text_needs_to_be_drawn = True
                 elif isinstance(widgets[key], Radio):
                     if key not in radio_button_tracker:
@@ -113,3 +125,55 @@ def fill(
         result = merge_watermarks_with_pdf(result, image_watermarks)
 
     return result
+
+
+def simple_fill(
+    template: bytes,
+    widgets: Dict[str, WIDGET_TYPES],
+) -> bytes:
+    """Fills a PDF form in place."""
+
+    pdf = PdfReader(stream_to_io(template))
+    out = PdfWriter()
+    out.append(pdf)
+
+    radio_button_tracker = {}
+
+    for page in out.pages:
+        for annot in page.get(ANNOTATION_KEY, []):  # noqa
+            annot = cast(DictionaryObject, annot.get_object())
+            key = get_widget_key(annot.get_object())
+
+            widget = widgets.get(key)
+            if widget is None:
+                continue
+
+            if isinstance(widget, Checkbox) and widget.value is True:
+                annot[NameObject(SELECTED_IDENTIFIER)] = NameObject(CHECKBOX_SELECT)
+            elif isinstance(widget, Radio):
+                if key not in radio_button_tracker:
+                    radio_button_tracker[key] = 0
+                radio_button_tracker[key] += 1
+                if widget.value == radio_button_tracker[key] - 1:
+                    annot[NameObject(SELECTED_IDENTIFIER)] = NameObject(
+                        f"/{widget.value}"
+                    )
+            elif isinstance(widget, Dropdown) and widget.value is not None:
+                annot[NameObject(TEXT_VALUE_IDENTIFIER)] = TextStringObject(
+                    widget.choices[widget.value]
+                )
+                annot[NameObject(TEXT_VALUE_SHOW_UP_IDENTIFIER)] = TextStringObject(
+                    widget.choices[widget.value]
+                )
+            elif isinstance(widget, Text) and widget.value:
+                annot[NameObject(TEXT_VALUE_IDENTIFIER)] = TextStringObject(
+                    widget.value
+                )
+                annot[NameObject(TEXT_VALUE_SHOW_UP_IDENTIFIER)] = TextStringObject(
+                    widget.value
+                )
+
+    with BytesIO() as f:
+        out.write(f)
+        f.seek(0)
+        return f.read()

PyPDFForm/middleware/checkbox.py

@@ -1,12 +1,20 @@
 # -*- coding: utf-8 -*-
 """Contains checkbox middleware."""
 
+from typing import Union
+
 from .base import Widget
 
 
 class Checkbox(Widget):
     """A class to represent a checkbox widget."""
 
+    BUTTON_STYLE_MAPPING = {
+        "check": "4",
+        "cross": "5",
+        "circle": "l",
+    }
+
     def __init__(
         self,
         name: str,
@@ -16,7 +24,8 @@ class Checkbox(Widget):
 
         super().__init__(name, value)
 
-        self.button_style = None
+        self.size = None
+        self._button_style = None
 
     @property
     def schema_definition(self) -> dict:
@@ -29,3 +38,18 @@ class Checkbox(Widget):
         """Sample value of the checkbox."""
 
         return True
+
+    @property
+    def button_style(self) -> Union[str, None]:
+        """Shape of the tick for the checkbox."""
+
+        return self._button_style
+
+    @button_style.setter
+    def button_style(self, value) -> None:
+        """Converts user specified button styles to acroform values."""
+
+        if value in self.BUTTON_STYLE_MAPPING:
+            self._button_style = self.BUTTON_STYLE_MAPPING[value]
+        elif value in self.BUTTON_STYLE_MAPPING.values():
+            self._button_style = value

PyPDFForm/middleware/radio.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 """Contains radio middleware."""
 
-from .base import Widget
+from .checkbox import Checkbox
 
 
-class Radio(Widget):
+class Radio(Checkbox):
     """A class to represent a radiobutton widget."""
 
     def __init__(
@@ -16,7 +16,6 @@ class Radio(Widget):
 
         super().__init__(name, value)
 
-        self.button_style = None
         self.number_of_options = 0
 
     @property

PyPDFForm/utils.py

@@ -38,7 +38,7 @@ def checkbox_radio_to_draw(
     new_widget.font_size = font_size
     new_widget.font_color = DEFAULT_FONT_COLOR
     new_widget.value = BUTTON_STYLES.get(widget.button_style) or (
-        DEFAULT_CHECKBOX_STYLE if isinstance(widget, Checkbox) else DEFAULT_RADIO_STYLE
+        DEFAULT_CHECKBOX_STYLE if type(widget) is Checkbox else DEFAULT_RADIO_STYLE
     )
 
     return new_widget

PyPDFForm/wrapper.py

@@ -11,7 +11,7 @@ from .constants import (DEFAULT_FONT, DEFAULT_FONT_COLOR, DEFAULT_FONT_SIZE,
                         DEPRECATION_NOTICE, VERSION_IDENTIFIER_PREFIX,
                         VERSION_IDENTIFIERS)
 from .coordinate import generate_coordinate_grid
-from .filler import fill
+from .filler import fill, simple_fill
 from .font import register_font
 from .image import any_image_to_jpg, rotate_image
 from .middleware.dropdown import Dropdown
@@ -26,7 +26,40 @@ from .widgets.checkbox import CheckBoxWidget
 from .widgets.text import TextWidget
 
 
-class PdfWrapper:
+class FormWrapper:
+    """A simple base wrapper for just filling a PDF form."""
+
+    def __init__(
+        self,
+        template: Union[bytes, str, BinaryIO] = b"",
+    ) -> None:
+        """Constructs all attributes for the object."""
+
+        self.stream = fp_or_f_obj_or_stream_to_stream(template)
+
+    def read(self) -> bytes:
+        """Reads the file stream of a PDF form."""
+
+        return self.stream
+
+    def fill(
+        self,
+        data: Dict[str, Union[str, bool, int]],
+    ) -> FormWrapper:
+        """Fills a PDF form."""
+
+        widgets = build_widgets(self.stream) if self.stream else {}
+
+        for key, value in data.items():
+            if key in widgets:
+                widgets[key].value = value
+
+        self.stream = simple_fill(self.read(), widgets)
+
+        return self
+
+
+class PdfWrapper(FormWrapper):
     """A class to represent a PDF form."""
 
     def __init__(
@@ -36,7 +69,7 @@ class PdfWrapper:
     ) -> None:
         """Constructs all attributes for the object."""
 
-        self.stream = fp_or_f_obj_or_stream_to_stream(template)
+        super().__init__(template)
         self.widgets = build_widgets(self.stream) if self.stream else {}
 
         self.global_font = kwargs.get("global_font")
@@ -49,11 +82,6 @@ class PdfWrapper:
                 each.font_size = self.global_font_size
                 each.font_color = self.global_font_color
 
-    def read(self) -> bytes:
-        """Reads the file stream of a PDF form."""
-
-        return self.stream
-
     @property
     def elements(self) -> dict:
         """ToDo: deprecate this."""

{PyPDFForm-1.4.11.dist-info → PyPDFForm-1.4.13.dist-info}/METADATA

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

{PyPDFForm-1.4.11.dist-info → PyPDFForm-1.4.13.dist-info}/RECORD

@@ -1,28 +1,28 @@
-PyPDFForm/__init__.py,sha256=mtq3XW38VKYpCu0_gUwtNRdNTHOnh6tAjv3VkDnaW6k,136
+PyPDFForm/__init__.py,sha256=KAGYHIP-vZnPpNmy2UPIQSULuxgByHXmJhj303FFmCg,149
 PyPDFForm/adapter.py,sha256=OgAIwcmukpBqHFBLymd3I7wA7wIdipRqgURZA2Y0Hgo,885
-PyPDFForm/constants.py,sha256=C-eTxxJRBqbahOXJvwuVl50kzTsghgslgCcbsM06dyY,1615
+PyPDFForm/constants.py,sha256=qxC6FN_K5kWD5XmwypeTyGLBG778geIGf2kHnHGcXAQ,1791
 PyPDFForm/coordinate.py,sha256=EZxqeM3mkPSvhrsdOa-R2wPylmIECvUwMIlpigWRSbI,7854
-PyPDFForm/filler.py,sha256=uPHWoeY7g9kL3r82cLma3slj-SETaDU9bG50mYVVkaI,4308
+PyPDFForm/filler.py,sha256=aVmzJZFW_XwX19KLbRWuDCBZ8ek2s8BapLydf44ZbxY,6707
 PyPDFForm/font.py,sha256=iXsih_EJ9qe_penqakbQWuP44yUdxhWlQzlpZlMl3uw,4347
 PyPDFForm/image.py,sha256=0GV8PFgY5oLJFHmhPD1fG-_5SBEO7jVLLtxCc_Uodfo,1143
 PyPDFForm/patterns.py,sha256=LQRwSk7jImTYZFfN_DC38mCWFrPrXDgkYtu-yQLI7PA,2340
 PyPDFForm/template.py,sha256=bvjrrIz6RZZl2h7MIjpI1g1FGD0mcabCjtseTvVUQTA,13176
-PyPDFForm/utils.py,sha256=rJ9c-HLQy1PiYA6EXNOXFBbq7N1NoyHFf4pAtnO8aXo,4144
+PyPDFForm/utils.py,sha256=_gskLLNmwhfGF16gfMP00twVY6iYADYYAYWHMvKCDrg,4140
 PyPDFForm/watermark.py,sha256=clYdRqCuWEE25IL-BUHnSo4HgLkHPSOl7FUJLhbAfGg,4755
-PyPDFForm/wrapper.py,sha256=Yj56fK744JRtQ8yoJlxyilYlHoszOggZQtkm10N1EN0,9538
+PyPDFForm/wrapper.py,sha256=pXLY84cXuL4X81hvGdmcatp_GV07XXeLfGMdjOT2sx4,10232
 PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 PyPDFForm/middleware/base.py,sha256=TmoO8XpjFa5NerAumrAGm_kUt2eFP3DyyF-Vx0uXloM,724
-PyPDFForm/middleware/checkbox.py,sha256=noMj4gkwIb4icVUj-YIvbmvkU9bK58IpLqjglmXh5Z4,650
+PyPDFForm/middleware/checkbox.py,sha256=Z92awlKjceMd_ryb9Fhrtyd4fLkU84Ii6fSum60rHcA,1305
 PyPDFForm/middleware/dropdown.py,sha256=BpRh2YPndhhaLY-s-3gqck64d5FoC719-ARgvfV3_N0,674
-PyPDFForm/middleware/radio.py,sha256=mmmZTsNIzhm469-qPPpPtaOvc0qWO1GEmzKPukkMLnU,725
+PyPDFForm/middleware/radio.py,sha256=ehaJoehEzZqxDVb5A6fJkYludeBmtV2Z5GZUPPfUWng,700
 PyPDFForm/middleware/signature.py,sha256=m7tNvGZ7fQ0yuVKzSlLbNQ2IILo1GDnjzMDzMnYCKVM,1104
 PyPDFForm/middleware/text.py,sha256=-ETNQoLvgu5cLkpIQtNYHtq75Ou3P7ezYur-E1yb9-k,1057
 PyPDFForm/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 PyPDFForm/widgets/base.py,sha256=Stq-oQt-cfwQ6nilQ4NqpO5udFSKDNb1mAwryrWggZA,2076
 PyPDFForm/widgets/checkbox.py,sha256=issx3onojq9plTHbNQwEnkbnhTo5vJKA5XSAoxRzQCg,264
 PyPDFForm/widgets/text.py,sha256=lUVlfQ-ndemSelsKNzY6nS4Kuf_H4mDPxotFMQFV-so,484
-PyPDFForm-1.4.11.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-PyPDFForm-1.4.11.dist-info/METADATA,sha256=YDpFcJzOYMWtp5tUHfHEmLxwmItBNO14P6OTfPkx-dU,5178
-PyPDFForm-1.4.11.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-PyPDFForm-1.4.11.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-PyPDFForm-1.4.11.dist-info/RECORD,,
+PyPDFForm-1.4.13.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+PyPDFForm-1.4.13.dist-info/METADATA,sha256=1RfinIDEtIhuU7zhUfbvhAzp479KlQ0MH2GrLy7QxuA,5178
+PyPDFForm-1.4.13.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+PyPDFForm-1.4.13.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+PyPDFForm-1.4.13.dist-info/RECORD,,

{PyPDFForm-1.4.11.dist-info → PyPDFForm-1.4.13.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any