PyPDFForm 4.8.4__tar.gz → 5.0.0__tar.gz

{pypdfform-4.8.4 → pypdfform-5.0.0}/PKG-INFO

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

{pypdfform-4.8.4 → pypdfform-5.0.0}/PyPDFForm/__init__.py

@@ -22,7 +22,7 @@ PyPDFForm aims to simplify PDF form manipulation, making it accessible to develo
 
 import logging
 
-__version__ = "4.8.4"
+__version__ = "5.0.0"
 
 from .lib.annotations import Annotations
 from .lib.assets.blank import BlankPage

{pypdfform-4.8.4 → pypdfform-5.0.0}/PyPDFForm/cli/update.py

@@ -140,9 +140,7 @@ def rename(
     for item in input_data:
         for k, v in item.items():
             widget = get_widget(obj, k, cli_widget_key_error("--file"))
-            obj.update_widget_key(
-                widget.name, v["new_key"], index=v.get("index", 0), defer=True
-            )
+            obj.update_widget_key(widget.name, v["new_key"], index=v.get("index", 0))
 
     obj.commit_widget_key_updates().write(output or pdf)
 

{pypdfform-4.8.4 → pypdfform-5.0.0}/PyPDFForm/lib/annotations/link.py

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-# TODO: finish other features
 """
 This module defines the class for link annotations in PyPDFForm.
 

{pypdfform-4.8.4 → pypdfform-5.0.0}/PyPDFForm/lib/wrapper.py

@@ -29,7 +29,6 @@ from .adapter import (fp_or_f_obj_or_f_content_to_content,
                       fp_or_f_obj_or_stream_to_stream)
 from .constants import VERSION_IDENTIFIER_PREFIX, VERSION_IDENTIFIERS
 from .coordinate import generate_coordinate_grid
-from .deprecation import deprecation_notice
 from .egress import appearance_streams_handler, preserve_pdf_properties
 from .filler import fill
 from .font import (get_all_available_fonts, register_font_acroform,
@@ -160,7 +159,7 @@ class PdfWrapper:
         unique_suffix = generate_unique_suffix()
         for k in self.widgets:
             if k in other.widgets:
-                other.update_widget_key(k, f"{k}-{unique_suffix}", defer=True)
+                other.update_widget_key(k, f"{k}-{unique_suffix}")
 
         other.commit_widget_key_updates()
 
@@ -246,7 +245,7 @@ class PdfWrapper:
             "properties": {
                 key: value.schema_definition for key, value in self.widgets.items()
             },
-            "additionalProperties": True,
+            "additionalProperties": False,
         }
 
     @property
@@ -666,44 +665,20 @@ class PdfWrapper:
 
         return self
 
-    @deprecation_notice(to_replace="bulk_create_fields")
-    def create_field(
-        self,
-        field: FieldTypes,
-    ) -> PdfWrapper:
-        """
-        Creates a new form field (widget) on the PDF using a `FieldTypes` object.
-
-        This method simplifies widget creation by taking a `FieldTypes` object
-        and delegating to the internal `_bulk_create_fields` method.
-
-        Args:
-            field (FieldTypes): An object representing the field to create.
-                This object encapsulates all necessary properties like name,
-                page number, coordinates, and type of the field.
-
-        Returns:
-            PdfWrapper: The `PdfWrapper` object, allowing for method chaining.
-        """
-
-        return self._bulk_create_fields([field])
-
     def update_widget_key(
-        self, old_key: str, new_key: str, index: int = 0, defer: bool = False
+        self, old_key: str, new_key: str, index: int = 0
     ) -> PdfWrapper:
         """
         Updates the key (name) of a widget, allowing you to rename form fields.
 
-        This method allows you to change the name of a form field in the PDF.  This can be useful for
-        standardizing field names or resolving naming conflicts.  The update can be performed immediately
-        or deferred until `commit_widget_key_updates` is called.
+        This method queues a change to the name of a form field in the PDF.  This can be useful for
+        standardizing field names or resolving naming conflicts.  The queued update is applied when
+        `commit_widget_key_updates` is called.
 
         Args:
             old_key (str): The old key of the widget that you want to rename.
             new_key (str): The new key to assign to the widget.
             index (int): The index of the widget if there are multiple widgets with the same name (default: 0).
-            defer (bool): Whether to defer the update. If True, the update is added to a queue and applied
-                when `commit_widget_key_updates` is called. If False, the update is applied immediately (default: False).
 
         Returns:
             PdfWrapper: The PdfWrapper object.
@@ -712,27 +687,15 @@ class PdfWrapper:
         if getattr(self, "use_full_widget_name"):
             raise NotImplementedError
 
-        if defer:
-            deprecation_notice(to_replace="", param="defer").emit_notice(
-                self, "update_widget_key"
-            )
-            self._keys_to_update.append((old_key, new_key, index))
-            return self
-
-        self._key_update_tracker[new_key] = old_key
-        self._stream = update_widget_keys(
-            self._read(), self.widgets, [old_key], [new_key], [index]
-        )
-        self._init_helper()
-
+        self._keys_to_update.append((old_key, new_key, index))
         return self
 
     def commit_widget_key_updates(self) -> PdfWrapper:
         """
         Commits deferred widget key updates, applying all queued key renames to the PDF.
 
-        This method applies all widget key updates that were deferred using the `defer=True` option
-        in the `update_widget_key` method.  It updates the underlying PDF stream with the new key names.
+        This method applies all widget key updates queued by the `update_widget_key` method.  It updates
+        the underlying PDF stream with the new key names.
 
         Returns:
             PdfWrapper: The PdfWrapper object.

{pypdfform-4.8.4 → pypdfform-5.0.0}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-4.8.4 → pypdfform-5.0.0}/tests/test_create_widget.py

@@ -7,21 +7,6 @@ import pytest
 from PyPDFForm import Fields, PdfWrapper
 
 
-def test_create_field_deprecated(template_stream):
-    with pytest.warns(
-        DeprecationWarning,
-        match="PdfWrapper.create_field will be deprecated soon. Use PdfWrapper.bulk_create_fields instead.",
-    ):
-        assert (
-            PdfWrapper(template_stream)
-            .create_field(Fields.TextField("foo", 1, 100, 100))
-            .read()
-            == PdfWrapper(template_stream)
-            .bulk_create_fields([Fields.TextField("foo", 1, 100, 100)])
-            .read()
-        )
-
-
 @pytest.mark.posix_only
 def test_create_checkbox_complex_fill(template_stream, pdf_samples, request):
     expected_path = os.path.join(

{pypdfform-4.8.4 → pypdfform-5.0.0}/tests/test_functional.py

@@ -645,6 +645,7 @@ def test_update_radio_key(template_with_radiobutton_stream, pdf_samples, request
     with open(expected_path, "rb+") as f:
         obj = PdfWrapper(template_with_radiobutton_stream)
         obj.update_widget_key("radio_3", "RADIO")
+        obj.commit_widget_key_updates()
         obj.fill({"RADIO": 0})
 
         request.config.results["expected_path"] = expected_path
@@ -664,6 +665,7 @@ def test_update_sejda_key(sejda_template, pdf_samples, request):
         obj.update_widget_key("at_future_date", "FUTURE_DATE")
         obj.update_widget_key("purchase_option", "PURCHASE_OPTION")
         obj.update_widget_key("buyer_signed_date", "BUYER_SIGNED_DATE")
+        obj.commit_widget_key_updates()
         obj.fill(
             {
                 "YEAR": "12",