PyPDFForm 4.7.5__tar.gz → 4.7.7__tar.gz

{pypdfform-4.7.5 → pypdfform-4.7.7}/PKG-INFO

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

{pypdfform-4.7.5 → pypdfform-4.7.7}/PyPDFForm/__init__.py

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

{pypdfform-4.7.5 → pypdfform-4.7.7}/PyPDFForm/constants.py

@@ -28,7 +28,8 @@ VERSION_IDENTIFIERS = [
 ]
 VERSION_IDENTIFIER_PREFIX = "%PDF-".encode("utf-8")
 
-DEPRECATION_NOTICE = "{} will be deprecated soon. Use {} instead."
+DEPRECATION_NOTICE = "{} will be deprecated soon."
+DEPRECATION_REPLACE_NOTICE = "Use {} instead."
 
 Title = "/Title"
 Annots = "/Annots"

pypdfform-4.7.7/PyPDFForm/deprecation.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+"""
+A module for handling deprecation notices within the PyPDFForm library.
+
+This module provides utility functions to issue standard DeprecationWarning
+messages, ensuring consistency across the library when notifying users of
+deprecated features.
+"""
+
+from functools import wraps
+from warnings import warn
+
+from .constants import DEPRECATION_NOTICE, DEPRECATION_REPLACE_NOTICE
+
+
+def deprecation_notice(to_replace: str, param: str = "") -> callable:
+    """
+    Issues a DeprecationWarning when a deprecated method is called. Can also be called
+    directly within a method to emit deprecation warnings conditionally.
+
+    Args:
+        to_replace (str): The name of the method to use instead.
+        param (str): Optional parameter name to include in the deprecation notice.
+
+    Returns:
+        callable: A decorator function. The decorator has an `emit_notice` method
+            that can be called directly within a method body for conditional emission.
+
+    Examples:
+        As a decorator (emits on every call)::
+
+            @deprecation_notice(to_replace="new_method")
+            def old_method(self):
+                pass
+
+        As a decorator with a parameter (emits on every call)::
+
+            @deprecation_notice(to_replace="old_method.new_param.", param="old_param")
+            def old_method(self, old_param=None):
+                pass
+
+        Conditionally within a method body::
+
+            def my_method(self, use_legacy=False):
+                if use_legacy:
+                    deprecation_notice(to_replace="", param="use_legacy").emit_notice(self, "my_method")
+                    # legacy logic here
+    """
+
+    def _emit(class_name: str, method_name: str, stacklevel: int):
+        to_deprecate = (
+            f"{class_name}.{method_name}.{param}"
+            if param
+            else f"{class_name}.{method_name}"
+        )
+        notice = DEPRECATION_NOTICE.format(to_deprecate)
+        if to_replace:
+            replacement = f"{class_name}.{to_replace}"
+            notice = f"{notice} {DEPRECATION_REPLACE_NOTICE.format(replacement)}"
+        warn(notice, DeprecationWarning, stacklevel=stacklevel)
+
+    def decorator(func: callable) -> callable:
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            _emit(args[0].__class__.__name__, func.__name__, stacklevel=3)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    def emit_notice(obj, method_name: str):
+        _emit(obj.__class__.__name__, method_name, stacklevel=4)
+
+    decorator.emit_notice = emit_notice
+    return decorator

{pypdfform-4.7.5 → pypdfform-4.7.7}/PyPDFForm/wrapper.py

@@ -29,6 +29,7 @@ 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,
@@ -664,6 +665,7 @@ class PdfWrapper:
 
         return self
 
+    @deprecation_notice(to_replace="bulk_create_fields")
     def create_field(
         self,
         field: FieldTypes,
@@ -710,6 +712,9 @@ class PdfWrapper:
             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
 

{pypdfform-4.7.5 → pypdfform-4.7.7}/PyPDFForm.egg-info/PKG-INFO

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

{pypdfform-4.7.5 → pypdfform-4.7.7}/tests/test_create_widget.py

@@ -7,25 +7,42 @@ 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(
         pdf_samples, "widget", "test_create_checkbox_complex_fill.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.CheckBoxField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                size=100,
-                button_style="check",
-                tick_color=(0, 1, 0),
-                bg_color=(0, 0, 1),
-                border_color=(1, 0, 0),
-                border_width=5,
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.CheckBoxField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    size=100,
+                    button_style="check",
+                    tick_color=(0, 1, 0),
+                    bg_color=(0, 0, 1),
+                    border_color=(1, 0, 0),
+                    border_width=5,
+                )
+            ]
         )
         obj.fill(obj.sample_data)
 
@@ -46,14 +63,16 @@ def test_create_checkbox_check_fill(template_stream, pdf_samples, request):
         pdf_samples, "widget", "test_create_checkbox_check_fill.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.CheckBoxField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                button_style="check",
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.CheckBoxField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    button_style="check",
+                )
+            ]
         )
         obj.fill(obj.sample_data)
 
@@ -72,14 +91,16 @@ def test_create_checkbox_circle_fill(template_stream, pdf_samples, request):
         pdf_samples, "widget", "test_create_checkbox_circle_fill.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.CheckBoxField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                button_style="circle",
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.CheckBoxField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    button_style="circle",
+                )
+            ]
         )
         obj.fill(obj.sample_data)
 
@@ -98,14 +119,16 @@ def test_create_checkbox_cross_fill(template_stream, pdf_samples, request):
         pdf_samples, "widget", "test_create_checkbox_cross_fill.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.CheckBoxField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                button_style="cross",
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.CheckBoxField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    button_style="cross",
+                )
+            ]
         )
         obj.fill(obj.sample_data)
 
@@ -124,14 +147,16 @@ def test_create_text_alpha_bg_color(template_stream, pdf_samples, request):
         pdf_samples, "widget", "test_create_text_alpha_bg_color.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.TextField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                bg_color=(0, 0, 1, 0),
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.TextField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    bg_color=(0, 0, 1, 0),
+                )
+            ]
         )
         assert obj.schema["properties"]["foo"]["type"] == "string"
 
@@ -150,14 +175,16 @@ def test_create_text_align_center(template_stream, pdf_samples, request):
         pdf_samples, "widget", "test_create_text_align_center.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.TextField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                alignment=1,
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.TextField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    alignment=1,
+                )
+            ]
         )
         assert obj.schema["properties"]["foo"]["type"] == "string"
 
@@ -176,14 +203,16 @@ def test_create_text_multiline(template_stream, pdf_samples, request):
         pdf_samples, "widget", "test_create_text_align_multiline.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.TextField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-                multiline=True,
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.TextField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    multiline=True,
+                )
+            ]
         )
         assert obj.schema["properties"]["foo"]["type"] == "string"
 
@@ -207,22 +236,24 @@ def test_create_text_complex_filled(
         obj = (
             PdfWrapper(template_stream)
             .register_font("new_font", sample_font_stream)
-            .create_field(
-                Fields.TextField(
-                    name="foo",
-                    page_number=1,
-                    x=100,
-                    y=100,
-                    width=400,
-                    height=400,
-                    max_length=2,
-                    font="new_font",
-                    font_size=50,
-                    font_color=(1, 0.5, 1),
-                    bg_color=(0, 0, 1),
-                    border_color=(1, 0, 0),
-                    border_width=5,
-                )
+            .bulk_create_fields(
+                [
+                    Fields.TextField(
+                        name="foo",
+                        page_number=1,
+                        x=100,
+                        y=100,
+                        width=400,
+                        height=400,
+                        max_length=2,
+                        font="new_font",
+                        font_size=50,
+                        font_color=(1, 0.5, 1),
+                        bg_color=(0, 0, 1),
+                        border_color=(1, 0, 0),
+                        border_width=5,
+                    )
+                ]
             )
         )
         obj.fill(obj.sample_data)
@@ -240,15 +271,17 @@ def test_create_text_complex_filled(
 def test_create_text_comb(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "widget", "test_create_text_comb.pdf")
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.TextField(
-                "foo",
-                page_number=1,
-                x=100,
-                y=100,
-                max_length=3,
-                comb=True,
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.TextField(
+                    "foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                    max_length=3,
+                    comb=True,
+                )
+            ]
         )
 
         request.config.results["expected_path"] = expected_path
@@ -271,13 +304,15 @@ def test_create_checkbox_persist_old_widgets_fill(
         obj = PdfWrapper(template_stream)
         obj.widgets["test"].font_size = 30
         obj.widgets["test"].font_color = (0, 1, 0)
-        obj.create_field(
-            Fields.CheckBoxField(
-                name="foo",
-                page_number=1,
-                x=100,
-                y=100,
-            )
+        obj.bulk_create_fields(
+            [
+                Fields.CheckBoxField(
+                    name="foo",
+                    page_number=1,
+                    x=100,
+                    y=100,
+                )
+            ]
         ).fill(obj.sample_data)
         assert obj.schema["properties"]["foo"]["type"] == "boolean"
 
@@ -297,19 +332,21 @@ def test_create_widget_sejda_fill_flatten_before(sejda_template, pdf_samples, re
     )
     with open(expected_path, "rb+") as f:
         obj = PdfWrapper(sejda_template)
-        obj.fill(obj.sample_data, flatten=True).create_field(
-            Fields.TextField(
-                name="new_text_field_widget",
-                page_number=1,
-                x=72,
-                y=730,
-                width=120,
-                height=40,
-                max_length=6,
-                font="Helvetica",
-                font_size=20,
-                font_color=(0, 0, 1),
-            )
+        obj.fill(obj.sample_data, flatten=True).bulk_create_fields(
+            [
+                Fields.TextField(
+                    name="new_text_field_widget",
+                    page_number=1,
+                    x=72,
+                    y=730,
+                    width=120,
+                    height=40,
+                    max_length=6,
+                    font="Helvetica",
+                    font_size=20,
+                    font_color=(0, 0, 1),
+                )
+            ]
         ).fill(obj.sample_data)
         assert obj.schema["properties"]["new_text_field_widget"]["type"] == "string"
 
@@ -329,19 +366,21 @@ def test_create_widget_sejda_fill_flatten_after(sejda_template, pdf_samples, req
     )
     with open(expected_path, "rb+") as f:
         obj = PdfWrapper(sejda_template)
-        obj.fill(obj.sample_data).create_field(
-            Fields.TextField(
-                name="new_text_field_widget",
-                page_number=1,
-                x=72,
-                y=730,
-                width=120,
-                height=40,
-                max_length=6,
-                font="Helvetica",
-                font_size=20,
-                font_color=(0, 0, 1),
-            )
+        obj.fill(obj.sample_data).bulk_create_fields(
+            [
+                Fields.TextField(
+                    name="new_text_field_widget",
+                    page_number=1,
+                    x=72,
+                    y=730,
+                    width=120,
+                    height=40,
+                    max_length=6,
+                    font="Helvetica",
+                    font_size=20,
+                    font_color=(0, 0, 1),
+                )
+            ]
         ).fill(obj.sample_data, flatten=True)
         assert obj.schema["properties"]["new_text_field_widget"]["type"] == "string"
 
@@ -359,19 +398,21 @@ def test_create_widget_sejda_schema(sejda_template):
     old_schema = obj.schema
     schema = (
         PdfWrapper(sejda_template)
-        .create_field(
-            Fields.TextField(
-                name="new_text_field_widget",
-                page_number=1,
-                x=72,
-                y=730,
-                width=120,
-                height=40,
-                max_length=6,
-                font="Times-Roman",
-                font_size=20,
-                font_color=(0, 0, 1),
-            )
+        .bulk_create_fields(
+            [
+                Fields.TextField(
+                    name="new_text_field_widget",
+                    page_number=1,
+                    x=72,
+                    y=730,
+                    width=120,
+                    height=40,
+                    max_length=6,
+                    font="Times-Roman",
+                    font_size=20,
+                    font_color=(0, 0, 1),
+                )
+            ]
         )
         .schema
     )
@@ -400,20 +441,22 @@ def test_fill_cmyk_color(pdf_samples, request):
 def test_create_radio_complex(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "widget", "test_create_radio_complex.pdf")
     with open(expected_path, "rb+") as f:
-        obj = PdfWrapper(template_stream).create_field(
-            Fields.RadioGroup(
-                name="radio",
-                page_number=2,
-                x=[50, 100, 150],
-                y=[50, 100, 150],
-                size=50,
-                button_style="check",
-                shape="circle",
-                tick_color=(0, 1, 0),
-                bg_color=(0, 0, 1, 1),
-                border_color=(1, 0, 0),
-                border_width=5,
-            )
+        obj = PdfWrapper(template_stream).bulk_create_fields(
+            [
+                Fields.RadioGroup(
+                    name="radio",
+                    page_number=2,
+                    x=[50, 100, 150],
+                    y=[50, 100, 150],
+                    size=50,
+                    button_style="check",
+                    shape="circle",
+                    tick_color=(0, 1, 0),
+                    bg_color=(0, 0, 1, 1),
+                    border_color=(1, 0, 0),
+                    border_width=5,
+                )
+            ]
         )
         assert obj.schema["properties"]["radio"]["type"] == "integer"
 
@@ -432,28 +475,21 @@ def test_create_required_fields(pdf_samples, request):
         pdf_samples, "widget", "test_create_required_fields.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = (
-            PdfWrapper(os.path.join(pdf_samples, "dummy.pdf"))
-            .create_field(
+        obj = PdfWrapper(os.path.join(pdf_samples, "dummy.pdf")).bulk_create_fields(
+            [
                 Fields.TextField(
                     name="new_text", page_number=1, x=100, y=100, required=True
-                )
-            )
-            .create_field(
+                ),
                 Fields.CheckBoxField(
                     name="new_check", page_number=1, x=100, y=200, required=True
-                )
-            )
-            .create_field(
+                ),
                 Fields.RadioGroup(
                     name="new_radio_group",
                     page_number=1,
                     x=[300, 350, 400],
                     y=[100, 150, 200],
                     required=True,
-                )
-            )
-            .create_field(
+                ),
                 Fields.DropdownField(
                     name="new_dropdown",
                     page_number=1,
@@ -461,22 +497,18 @@ def test_create_required_fields(pdf_samples, request):
                     y=400,
                     required=True,
                     options=["apple", "banana", "cherry"],
-                )
-            )
-            .create_field(
+                ),
                 Fields.ImageField(
                     name="new_image",
                     page_number=1,
                     x=300,
                     y=600,
                     required=True,
-                )
-            )
-            .create_field(
+                ),
                 Fields.SignatureField(
                     name="new_signature", page_number=1, x=100, y=600, required=True
-                )
-            )
+                ),
+            ]
         )
 
         request.config.results["expected_path"] = expected_path
@@ -494,28 +526,21 @@ def test_create_not_required_fields(pdf_samples, request):
         pdf_samples, "widget", "test_create_not_required_fields.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = (
-            PdfWrapper(os.path.join(pdf_samples, "dummy.pdf"))
-            .create_field(
+        obj = PdfWrapper(os.path.join(pdf_samples, "dummy.pdf")).bulk_create_fields(
+            [
                 Fields.TextField(
                     name="new_text", page_number=1, x=100, y=100, required=False
-                )
-            )
-            .create_field(
+                ),
                 Fields.CheckBoxField(
                     name="new_check", page_number=1, x=100, y=200, required=False
-                )
-            )
-            .create_field(
+                ),
                 Fields.RadioGroup(
                     name="new_radio_group",
                     page_number=1,
                     x=[300, 350, 400],
                     y=[100, 150, 200],
                     required=False,
-                )
-            )
-            .create_field(
+                ),
                 Fields.DropdownField(
                     name="new_dropdown",
                     page_number=1,
@@ -523,22 +548,18 @@ def test_create_not_required_fields(pdf_samples, request):
                     y=400,
                     required=False,
                     options=["apple", "banana", "cherry"],
-                )
-            )
-            .create_field(
+                ),
                 Fields.ImageField(
                     name="new_image",
                     page_number=1,
                     x=300,
                     y=600,
                     required=False,
-                )
-            )
-            .create_field(
+                ),
                 Fields.SignatureField(
                     name="new_signature", page_number=1, x=100, y=600, required=False
-                )
-            )
+                ),
+            ]
         )
 
         request.config.results["expected_path"] = expected_path
@@ -556,32 +577,25 @@ def test_create_fields_with_tooltips(pdf_samples, request):
         pdf_samples, "widget", "test_create_fields_with_tooltips.pdf"
     )
     with open(expected_path, "rb+") as f:
-        obj = (
-            PdfWrapper(os.path.join(pdf_samples, "dummy.pdf"))
-            .create_field(
+        obj = PdfWrapper(os.path.join(pdf_samples, "dummy.pdf")).bulk_create_fields(
+            [
                 Fields.TextField(
                     name="new_text", page_number=1, x=100, y=100, tooltip="new_text"
-                )
-            )
-            .create_field(
+                ),
                 Fields.CheckBoxField(
                     name="new_check",
                     page_number=1,
                     x=100,
                     y=200,
                     tooltip="new_checkbox",
-                )
-            )
-            .create_field(
+                ),
                 Fields.RadioGroup(
                     name="new_radio_group",
                     page_number=1,
                     x=[300, 350, 400],
                     y=[100, 150, 200],
                     tooltip="new_radio_group",
-                )
-            )
-            .create_field(
+                ),
                 Fields.DropdownField(
                     name="new_dropdown",
                     page_number=1,
@@ -589,26 +603,22 @@ def test_create_fields_with_tooltips(pdf_samples, request):
                     y=400,
                     options=["apple", "banana", "cherry"],
                     tooltip="new_dropdown",
-                )
-            )
-            .create_field(
+                ),
                 Fields.ImageField(
                     name="new_image",
                     page_number=1,
                     x=300,
                     y=600,
                     tooltip="new_image",
-                )
-            )
-            .create_field(
+                ),
                 Fields.SignatureField(
                     name="new_signature",
                     page_number=1,
                     x=100,
                     y=600,
                     tooltip="new_signature",
-                )
-            )
+                ),
+            ]
         )
 
         request.config.results["expected_path"] = expected_path

{pypdfform-4.7.5 → pypdfform-4.7.7}/tests/test_functional.py

@@ -14,13 +14,81 @@ from PyPDFForm.template import get_widgets_by_page
 
 
 def test_deprecation_warning():
+    class MockClass:
+        @deprecation_notice(to_replace="new_method")
+        def old_method(self):
+            return "result"
+
+    obj = MockClass()
     with pytest.warns(
-        DeprecationWarning, match="foo will be deprecated soon. Use bar instead."
+        DeprecationWarning,
+        match="MockClass.old_method will be deprecated soon. Use MockClass.new_method instead.",
     ):
-        deprecation_notice(
-            "foo",
-            "bar",
-        )
+        assert obj.old_method() == "result"
+
+
+def test_deprecation_warning_with_param():
+    class MockClass:
+        @deprecation_notice(to_replace="old_method.new_param", param="old_param")
+        def old_method(self):
+            return "result"
+
+    obj = MockClass()
+    with pytest.warns(
+        DeprecationWarning,
+        match="MockClass.old_method.old_param will be deprecated soon. Use MockClass.old_method.new_param instead.",
+    ):
+        assert obj.old_method() == "result"
+
+
+def test_deprecation_warning_empty_replace():
+    class MockClass:
+        @deprecation_notice(to_replace="")
+        def old_method(self):
+            return "result"
+
+    obj = MockClass()
+    with pytest.warns(
+        DeprecationWarning,
+        match="MockClass.old_method will be deprecated soon.",
+    ) as record:
+        assert obj.old_method() == "result"
+    assert "Use" not in str(record[0].message)
+
+
+def test_deprecation_warning_direct_call():
+    class MockClass:
+        def my_method(self, use_legacy=False):
+            if use_legacy:
+                deprecation_notice(to_replace="", param="use_legacy").emit_notice(
+                    self, "my_method"
+                )
+            return "result"
+
+    obj = MockClass()
+    assert obj.my_method(use_legacy=False) == "result"
+    with pytest.warns(
+        DeprecationWarning,
+        match="MockClass.my_method.use_legacy will be deprecated soon.",
+    ):
+        assert obj.my_method(use_legacy=True) == "result"
+
+
+def test_deprecation_warning_direct_call_with_replace():
+    class MockClass:
+        def my_method(self, use_legacy=False):
+            if use_legacy:
+                deprecation_notice(
+                    to_replace="my_method.new_param", param="use_legacy"
+                ).emit_notice(self, "my_method")
+            return "result"
+
+    obj = MockClass()
+    with pytest.warns(
+        DeprecationWarning,
+        match="MockClass.my_method.use_legacy will be deprecated soon. Use MockClass.my_method.new_param instead.",
+    ):
+        assert obj.my_method(use_legacy=True) == "result"
 
 
 def test_base_schema_definition():

{pypdfform-4.7.5 → pypdfform-4.7.7}/tests/test_need_appearances.py

@@ -32,59 +32,51 @@ def run_sample_template_library_test(
                 need_appearances=need_appearances,
             )
             .register_font("new_font", sample_font_stream)
-            .create_field(
-                Fields.TextField(
-                    name="new_text_field_widget",
-                    page_number=1,
-                    x=60,
-                    y=710,
-                )
-            )
-            .create_field(
-                Fields.CheckBoxField(
-                    name="new_checkbox_widget",
-                    page_number=1,
-                    x=100,
-                    y=600,
-                )
-            )
-            .create_field(
-                Fields.RadioGroup(
-                    name="new_radio_group",
-                    page_number=1,
-                    x=[50, 100, 150],
-                    y=[50, 100, 150],
-                )
-            )
-            .create_field(
-                Fields.DropdownField(
-                    name="new_dropdown_widget",
-                    page_number=1,
-                    x=300,
-                    y=710,
-                    options=[
-                        "foo",
-                        "bar",
-                        "foobar",
-                    ],
-                    font="new_font",
-                )
-            )
-            .create_field(
-                Fields.ImageField(
-                    name="new_image_widget",
-                    page_number=1,
-                    x=300,
-                    y=200,
-                )
-            )
-            .create_field(
-                Fields.SignatureField(
-                    name="new_signature_wiget",
-                    page_number=1,
-                    x=300,
-                    y=400,
-                )
+            .bulk_create_fields(
+                [
+                    Fields.TextField(
+                        name="new_text_field_widget",
+                        page_number=1,
+                        x=60,
+                        y=710,
+                    ),
+                    Fields.CheckBoxField(
+                        name="new_checkbox_widget",
+                        page_number=1,
+                        x=100,
+                        y=600,
+                    ),
+                    Fields.RadioGroup(
+                        name="new_radio_group",
+                        page_number=1,
+                        x=[50, 100, 150],
+                        y=[50, 100, 150],
+                    ),
+                    Fields.DropdownField(
+                        name="new_dropdown_widget",
+                        page_number=1,
+                        x=300,
+                        y=710,
+                        options=[
+                            "foo",
+                            "bar",
+                            "foobar",
+                        ],
+                        font="new_font",
+                    ),
+                    Fields.ImageField(
+                        name="new_image_widget",
+                        page_number=1,
+                        x=300,
+                        y=200,
+                    ),
+                    Fields.SignatureField(
+                        name="new_signature_wiget",
+                        page_number=1,
+                        x=300,
+                        y=400,
+                    ),
+                ]
             )
             .fill(
                 {

{pypdfform-4.7.5 → pypdfform-4.7.7}/tests/test_widget_attr_trigger.py

@@ -14,8 +14,8 @@ def test_register_font_no_form_fields(pdf_samples, sample_font_stream, request):
     )
     with open(expected_path, "rb+") as f:
         obj = PdfWrapper(os.path.join(pdf_samples, "dummy.pdf"))
-        obj.register_font("new_font", sample_font_stream).create_field(
-            Fields.TextField(name="foo", page_number=1, x=100, y=100, font="new_font")
+        obj.register_font("new_font", sample_font_stream).bulk_create_fields(
+            [Fields.TextField(name="foo", page_number=1, x=100, y=100, font="new_font")]
         )
         obj.draw([RawElements.RawText("foo", 1, 200, 200, font="new_font")])
 

pypdfform-4.7.5/PyPDFForm/deprecation.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-A module for handling deprecation notices within the PyPDFForm library.
-
-This module provides utility functions to issue standard DeprecationWarning
-messages, ensuring consistency across the library when notifying users of
-deprecated features.
-"""
-
-from warnings import warn
-
-from .constants import DEPRECATION_NOTICE
-
-
-def deprecation_notice(to_deprecate: str, to_replace: str) -> None:
-    """
-    Issues a DeprecationWarning for a feature that is being deprecated.
-
-    Args:
-        to_deprecate (str): The name of the feature or function being deprecated.
-        to_replace (str): The name of the feature or function that should be used instead.
-    """
-    warn(
-        DEPRECATION_NOTICE.format(
-            to_deprecate,
-            to_replace,
-        ),
-        DeprecationWarning,  # noqa: PT030
-        stacklevel=3,
-    )