PyPDFForm 1.4.26__tar.gz → 1.4.28__tar.gz

{pypdfform-1.4.26 → pypdfform-1.4.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.26
+Version: 1.4.28
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -34,22 +34,6 @@ Requires-Dist: reportlab
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important API Changes
-
-Happy new year fellow developers! We start the year 2024 with a new release of v1.4.0 and 
-there are some important changes I'm making to the APIs of the library.
-
-* The PDF object that gets instantiated is now `PyPDFForm.PdfWrapper`, changed from `PyPDFForm.PyPDFForm`.
-* Form widgets are now accessed via the `PdfWrapper.widgets` attribute, changed from `PdfWrapper.elements`.
-* The JSON schema of the form data is now accessed via a new attribute called `PdfWrapper.schema`, 
-changed from the old method of `PdfWrapper.generate_schema()`.
-
-All the old APIs will be persisted for half a year and then fully deprecated. Each of them 
-will emit a `DeprecationWarning` when invoked, so it is advised that you make the switch before they are 
-removed and start breaking your code.
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

pypdfform-1.4.28/PyPDFForm/__init__.py

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

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm/constants.py

@@ -54,6 +54,11 @@ AS = "/AS"
 Yes = "/Yes"
 Off = "/Off"
 
+# For Adobe Acrobat
+AcroForm = "/AcroForm"
+Root = "/Root"
+NeedAppearances = "/NeedAppearances"
+
 # Field flag bits
 READ_ONLY = 1 << 0
 MULTILINE = 1 << 12

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm/filler.py

@@ -5,9 +5,9 @@ from io import BytesIO
 from typing import Dict, Tuple, Union, cast
 
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import DictionaryObject
+from pypdf.generic import BooleanObject, DictionaryObject, NameObject
 
-from .constants import WIDGET_TYPES, Annots
+from .constants import WIDGET_TYPES, AcroForm, Annots, NeedAppearances, Root
 from .coordinate import (get_draw_checkbox_radio_coordinates,
                          get_draw_image_coordinates_resolutions,
                          get_draw_text_coordinates,
@@ -160,14 +160,25 @@ def fill(
     return result
 
 
+def enable_adobe_mode(pdf: PdfReader, adobe_mode: bool) -> None:
+    """Enables Adobe mode so that texts filled can show up in Acrobat."""
+
+    if adobe_mode and AcroForm in pdf.trailer[Root]:
+        pdf.trailer[Root][AcroForm].update(
+            {NameObject(NeedAppearances): BooleanObject(True)}
+        )
+
+
 def simple_fill(
     template: bytes,
     widgets: Dict[str, WIDGET_TYPES],
     flatten: bool = False,
+    adobe_mode: bool = False,
 ) -> bytes:
     """Fills a PDF form in place."""
 
     pdf = PdfReader(stream_to_io(template))
+    enable_adobe_mode(pdf, adobe_mode)
     out = PdfWriter()
     out.append(pdf)
 

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm/font.py

@@ -7,11 +7,14 @@ from re import findall
 from typing import Tuple, Union
 
 from reportlab.pdfbase.acroform import AcroForm
-from reportlab.pdfbase.pdfmetrics import registerFont, standardFonts
+from reportlab.pdfbase.pdfmetrics import (registerFont, standardFonts,
+                                          stringWidth)
 from reportlab.pdfbase.ttfonts import TTFError, TTFont
 
 from .constants import (DEFAULT_FONT, FONT_COLOR_IDENTIFIER,
-                        FONT_SIZE_IDENTIFIER, Rect)
+                        FONT_SIZE_IDENTIFIER, FONT_SIZE_REDUCE_STEP,
+                        MARGIN_BETWEEN_LINES, Rect)
+from .middleware.text import Text
 from .patterns import TEXT_FIELD_APPEARANCE_PATTERNS
 from .utils import traverse_pattern
 
@@ -146,3 +149,36 @@ def get_text_field_font_color(
                     break
 
     return result
+
+
+def adjust_paragraph_font_size(widget: dict, widget_middleware: Text) -> None:
+    """Reduces the font size of a paragraph field until texts fits."""
+
+    # pylint: disable=C0415, R0401
+    from .template import get_paragraph_lines
+
+    height = abs(float(widget[Rect][1]) - float(widget[Rect][3]))
+
+    while (
+        widget_middleware.font_size > FONT_SIZE_REDUCE_STEP
+        and len(widget_middleware.text_lines)
+        * (widget_middleware.font_size + MARGIN_BETWEEN_LINES)
+        > height
+    ):
+        widget_middleware.font_size -= FONT_SIZE_REDUCE_STEP
+        widget_middleware.text_lines = get_paragraph_lines(widget, widget_middleware)
+
+
+def adjust_text_field_font_size(widget: dict, widget_middleware: Text) -> None:
+    """Reduces the font size of a text field until texts fits."""
+
+    width = abs(float(widget[Rect][0]) - float(widget[Rect][2]))
+
+    while (
+        widget_middleware.font_size > FONT_SIZE_REDUCE_STEP
+        and stringWidth(
+            widget_middleware.value, widget_middleware.font, widget_middleware.font_size
+        )
+        > width
+    ):
+        widget_middleware.font_size -= FONT_SIZE_REDUCE_STEP

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm/template.py

@@ -8,10 +8,10 @@ from typing import Dict, List, Tuple, Union
 from pypdf import PdfReader
 from reportlab.pdfbase.pdfmetrics import stringWidth
 
-from .constants import (COMB, DEFAULT_FONT_SIZE, FONT_SIZE_REDUCE_STEP,
-                        MARGIN_BETWEEN_LINES, MULTILINE, NEW_LINE_SYMBOL,
+from .constants import (COMB, DEFAULT_FONT_SIZE, MULTILINE, NEW_LINE_SYMBOL,
                         WIDGET_TYPES, MaxLen, Rect)
-from .font import (auto_detect_font, get_text_field_font_color,
+from .font import (adjust_paragraph_font_size, adjust_text_field_font_size,
+                   auto_detect_font, get_text_field_font_color,
                    get_text_field_font_size, text_field_font_size)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
@@ -403,33 +403,3 @@ def get_paragraph_auto_wrap_length(widget_middleware: Text) -> int:
         result = min(result, len(line))
 
     return result
-
-
-def adjust_paragraph_font_size(widget: dict, widget_middleware: Text) -> None:
-    """Reduces the font size of a paragraph field until texts fits."""
-
-    height = abs(float(widget[Rect][1]) - float(widget[Rect][3]))
-
-    while (
-        widget_middleware.font_size > FONT_SIZE_REDUCE_STEP
-        and len(widget_middleware.text_lines)
-        * (widget_middleware.font_size + MARGIN_BETWEEN_LINES)
-        > height
-    ):
-        widget_middleware.font_size -= FONT_SIZE_REDUCE_STEP
-        widget_middleware.text_lines = get_paragraph_lines(widget, widget_middleware)
-
-
-def adjust_text_field_font_size(widget: dict, widget_middleware: Text) -> None:
-    """Reduces the font size of a text field until texts fits."""
-
-    width = abs(float(widget[Rect][0]) - float(widget[Rect][2]))
-
-    while (
-        widget_middleware.font_size > FONT_SIZE_REDUCE_STEP
-        and stringWidth(
-            widget_middleware.value, widget_middleware.font, widget_middleware.font_size
-        )
-        > width
-    ):
-        widget_middleware.font_size -= FONT_SIZE_REDUCE_STEP

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm/wrapper.py

@@ -5,12 +5,10 @@ from __future__ import annotations
 
 from functools import cached_property
 from typing import BinaryIO, Dict, List, Tuple, Union
-from warnings import warn
 
 from .adapter import fp_or_f_obj_or_stream_to_stream
 from .constants import (DEFAULT_FONT, DEFAULT_FONT_COLOR, DEFAULT_FONT_SIZE,
-                        DEPRECATION_NOTICE, VERSION_IDENTIFIER_PREFIX,
-                        VERSION_IDENTIFIERS)
+                        VERSION_IDENTIFIER_PREFIX, VERSION_IDENTIFIERS)
 from .coordinate import generate_coordinate_grid
 from .filler import fill, simple_fill
 from .font import register_font
@@ -58,7 +56,10 @@ class FormWrapper:
                 widgets[key].value = value
 
         self.stream = simple_fill(
-            self.read(), widgets, flatten=kwargs.get("flatten", False)
+            self.read(),
+            widgets,
+            flatten=kwargs.get("flatten", False),
+            adobe_mode=kwargs.get("adobe_mode", False),
         )
 
         return self
@@ -87,21 +88,6 @@ class PdfWrapper(FormWrapper):
                 each.font_size = self.global_font_size
                 each.font_color = self.global_font_color
 
-    @property
-    def elements(self) -> dict:
-        """ToDo: deprecate this."""
-
-        warn(
-            DEPRECATION_NOTICE.format(
-                f"{self.__class__.__name__}.elements",
-                f"{self.__class__.__name__}.widgets",
-            ),
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.widgets
-
     @property
     def sample_data(self) -> dict:
         """Returns a valid sample data that can be filled into the PDF form."""
@@ -311,20 +297,6 @@ class PdfWrapper(FormWrapper):
 
         return result
 
-    def generate_schema(self) -> dict:
-        """ToDo: deprecate this."""
-
-        warn(
-            DEPRECATION_NOTICE.format(
-                f"{self.__class__.__name__}.generate_schema()",
-                f"{self.__class__.__name__}.schema",
-            ),
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.schema
-
     @classmethod
     def register_font(
         cls, font_name: str, ttf_file: Union[bytes, str, BinaryIO]
@@ -334,22 +306,3 @@ class PdfWrapper(FormWrapper):
         ttf_file = fp_or_f_obj_or_stream_to_stream(ttf_file)
 
         return register_font(font_name, ttf_file) if ttf_file is not None else False
-
-
-class PyPDFForm(PdfWrapper):
-    """ToDo: deprecate this."""
-
-    def __init__(
-        self,
-        template: Union[bytes, str, BinaryIO] = b"",
-        **kwargs,
-    ):
-        """Only extra thing is the deprecation notice."""
-
-        warn(
-            DEPRECATION_NOTICE.format("PyPDFForm.PyPDFForm", "PyPDFForm.PdfWrapper"),
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        super().__init__(template, **kwargs)

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.26
+Version: 1.4.28
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -34,22 +34,6 @@ Requires-Dist: reportlab
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important API Changes
-
-Happy new year fellow developers! We start the year 2024 with a new release of v1.4.0 and 
-there are some important changes I'm making to the APIs of the library.
-
-* The PDF object that gets instantiated is now `PyPDFForm.PdfWrapper`, changed from `PyPDFForm.PyPDFForm`.
-* Form widgets are now accessed via the `PdfWrapper.widgets` attribute, changed from `PdfWrapper.elements`.
-* The JSON schema of the form data is now accessed via a new attribute called `PdfWrapper.schema`, 
-changed from the old method of `PdfWrapper.generate_schema()`.
-
-All the old APIs will be persisted for half a year and then fully deprecated. Each of them 
-will emit a `DeprecationWarning` when invoked, so it is advised that you make the switch before they are 
-removed and start breaking your code.
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

{pypdfform-1.4.26 → pypdfform-1.4.28}/PyPDFForm.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ PyPDFForm/widgets/base.py
 PyPDFForm/widgets/checkbox.py
 PyPDFForm/widgets/dropdown.py
 PyPDFForm/widgets/text.py
+tests/test_adobe_mode.py
 tests/test_create_widget.py
 tests/test_dropdown.py
 tests/test_dropdown_simple.py

{pypdfform-1.4.26 → pypdfform-1.4.28}/README.md

@@ -8,22 +8,6 @@
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important API Changes
-
-Happy new year fellow developers! We start the year 2024 with a new release of v1.4.0 and 
-there are some important changes I'm making to the APIs of the library.
-
-* The PDF object that gets instantiated is now `PyPDFForm.PdfWrapper`, changed from `PyPDFForm.PyPDFForm`.
-* Form widgets are now accessed via the `PdfWrapper.widgets` attribute, changed from `PdfWrapper.elements`.
-* The JSON schema of the form data is now accessed via a new attribute called `PdfWrapper.schema`, 
-changed from the old method of `PdfWrapper.generate_schema()`.
-
-All the old APIs will be persisted for half a year and then fully deprecated. Each of them 
-will emit a `DeprecationWarning` when invoked, so it is advised that you make the switch before they are 
-removed and start breaking your code.
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

pypdfform-1.4.28/tests/test_adobe_mode.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+
+import os
+
+from PyPDFForm import FormWrapper
+
+
+def test_dropdown_one(sample_template_with_dropdown, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "adobe_mode", "dropdown", "dropdown_one.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = FormWrapper(sample_template_with_dropdown).fill(
+            {
+                "test_1": "test_1",
+                "test_2": "test_2",
+                "test_3": "test_3",
+                "check_1": True,
+                "check_2": True,
+                "check_3": True,
+                "radio_1": 1,
+                "dropdown_1": 0,
+            },
+            adobe_mode=True,
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.stream == expected
+
+
+def test_fill_sejda_complex(sejda_template_complex, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "adobe_mode", "paragraph", "sample_filled_sejda_complex.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = FormWrapper(sejda_template_complex).fill(
+            {
+                "checkbox": True,
+                "radio": 0,
+                "dropdown_font_auto_left": 0,
+                "dropdown_font_auto_center": 1,
+                "dropdown_font_auto_right": 2,
+                "dropdown_font_ten_left": 0,
+                "dropdown_font_ten_center": 1,
+                "dropdown_font_ten_right": 2,
+                "paragraph_font_auto_left": "paragraph_font_auto_left",
+                "paragraph_font_auto_center": "paragraph_font_auto_center",
+                "paragraph_font_auto_right": "paragraph_font_auto_right",
+                "paragraph_font_ten_left": "paragraph_font_ten_left",
+                "paragraph_font_ten_center": "paragraph_font_ten_center",
+                "paragraph_font_ten_right": "paragraph_font_ten_right",
+                "text__font_auto_left": "test text",
+                "text_font_auto_center": "test text",
+                "text_font_auto_right": "test text",
+                "text_font_ten_left": "text_font_ten_left",
+                "text_font_ten_center": "text_font_ten_center",
+                "text_font_ten_right": "text_font_ten_right",
+            },
+            adobe_mode=True,
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.stream == expected
+
+
+def test_issue_613(pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "adobe_mode", "issues", "613_expected.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = FormWrapper(
+            os.path.join(pdf_samples, "scenario", "issues", "613.pdf")
+        ).fill(
+            {
+                "301 Full name": "John Smith",
+                "301 Address Street": "1234 road number 6",
+            },
+            adobe_mode=True,
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.stream == expected

{pypdfform-1.4.26 → pypdfform-1.4.28}/tests/test_functional.py

@@ -2,10 +2,9 @@
 
 import os
 
-import pytest
 from jsonschema import ValidationError, validate
 
-from PyPDFForm import PdfWrapper, PyPDFForm, constants, template
+from PyPDFForm import PdfWrapper, constants, template
 from PyPDFForm.middleware.base import Widget
 from PyPDFForm.middleware.text import Text
 
@@ -18,30 +17,6 @@ def test_base_schema_definition():
         pass
 
 
-def test_elements_deprecation_notice(template_stream):
-    with pytest.warns(DeprecationWarning) as r:
-        obj = PdfWrapper(template_stream)
-        assert not r
-        assert obj.elements is obj.widgets
-        obj.elements["test"].font_size = 20
-        assert obj.widgets["test"].font_size == 20
-        assert r
-
-
-def test_generate_schema_deprecation_notice(template_stream):
-    with pytest.warns(DeprecationWarning) as r:
-        obj = PdfWrapper(template_stream)
-        assert not r
-        assert obj.generate_schema() == obj.schema
-        assert r
-
-
-def test_pypdfform_deprecation_notice(template_stream):
-    with pytest.warns(DeprecationWarning) as r:
-        assert PyPDFForm(template_stream)
-        assert r
-
-
 def test_fill(template_stream, pdf_samples, data_dict, request):
     expected_path = os.path.join(pdf_samples, "sample_filled.pdf")
     with open(expected_path, "rb+") as f:

pypdfform-1.4.26/PyPDFForm/__init__.py

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