PyPDFForm 1.4.27__tar.gz → 1.4.29__tar.gz

{pypdfform-1.4.27 → pypdfform-1.4.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.27
+Version: 1.4.29
 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 
@@ -99,12 +83,6 @@ and it should look like [this](https://github.com/chinapandaman/PyPDFForm/raw/ma
 
 The official documentation can be found on [the GitHub page](https://chinapandaman.github.io/PyPDFForm/) of this repository.
 
-## Public Speak
+## Other Resources
 
 [Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)
-
-## How to Contribute
-
-It is difficult to make sure that the library supports all the PDF form creating tools out 
-there. So if you run into a case where the library does not work for certain PDF forms created by certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
-to make the library support the attached PDF form as well as the tool used to create it.

pypdfform-1.4.29/PyPDFForm/__init__.py

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

{pypdfform-1.4.27 → pypdfform-1.4.29}/PyPDFForm/filler.py

@@ -177,7 +177,6 @@ def simple_fill(
 ) -> bytes:
     """Fills a PDF form in place."""
 
-    # pylint: disable=too-many-branches
     pdf = PdfReader(stream_to_io(template))
     enable_adobe_mode(pdf, adobe_mode)
     out = PdfWriter()

{pypdfform-1.4.27 → pypdfform-1.4.29}/PyPDFForm/wrapper.py

@@ -5,11 +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,
+                        NEW_LINE_SYMBOL, VERSION_IDENTIFIER_PREFIX,
                         VERSION_IDENTIFIERS)
 from .coordinate import generate_coordinate_grid
 from .filler import fill, simple_fill
@@ -90,21 +89,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."""
@@ -261,6 +245,9 @@ class PdfWrapper(FormWrapper):
         new_widget.font_size = kwargs.get("font_size", DEFAULT_FONT_SIZE)
         new_widget.font_color = kwargs.get("font_color", DEFAULT_FONT_COLOR)
 
+        if NEW_LINE_SYMBOL in text:
+            new_widget.text_lines = text.split(NEW_LINE_SYMBOL)
+
         watermarks = create_watermarks_and_draw(
             self.stream,
             page_number,
@@ -314,20 +301,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]
@@ -337,22 +310,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.27 → pypdfform-1.4.29}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.27
+Version: 1.4.29
 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 
@@ -99,12 +83,6 @@ and it should look like [this](https://github.com/chinapandaman/PyPDFForm/raw/ma
 
 The official documentation can be found on [the GitHub page](https://chinapandaman.github.io/PyPDFForm/) of this repository.
 
-## Public Speak
+## Other Resources
 
 [Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)
-
-## How to Contribute
-
-It is difficult to make sure that the library supports all the PDF form creating tools out 
-there. So if you run into a case where the library does not work for certain PDF forms created by certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
-to make the library support the attached PDF form as well as the tool used to create it.

{pypdfform-1.4.27 → pypdfform-1.4.29}/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 
@@ -73,12 +57,6 @@ and it should look like [this](https://github.com/chinapandaman/PyPDFForm/raw/ma
 
 The official documentation can be found on [the GitHub page](https://chinapandaman.github.io/PyPDFForm/) of this repository.
 
-## Public Speak
+## Other Resources
 
 [Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)
-
-## How to Contribute
-
-It is difficult to make sure that the library supports all the PDF form creating tools out 
-there. So if you run into a case where the library does not work for certain PDF forms created by certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
-to make the library support the attached PDF form as well as the tool used to create it.

{pypdfform-1.4.27 → pypdfform-1.4.29}/tests/test_adobe_mode.py

@@ -5,6 +5,34 @@ 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"
@@ -43,3 +71,27 @@ def test_fill_sejda_complex(sejda_template_complex, pdf_samples, request):
 
         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.27 → pypdfform-1.4.29}/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:
@@ -247,6 +222,27 @@ def test_draw_text_on_one_page(template_stream, pdf_samples, request):
         assert obj.stream == expected
 
 
+def test_draw_text_new_line_symbol(template_stream, pdf_samples, request):
+    expected_path = os.path.join(
+        pdf_samples, "sample_pdf_with_drawn_text_new_line_symbol.pdf"
+    )
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).draw_text(
+            "test\ntest\ntest",
+            1,
+            300,
+            225,
+        )
+
+        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_draw_image_on_one_page(template_stream, image_samples, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "sample_pdf_with_image.pdf")
     with open(expected_path, "rb+") as f:

pypdfform-1.4.27/PyPDFForm/__init__.py

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