PyPDFForm 4.8.4__tar.gz → 5.0.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.8.4
+Version: 5.0.1
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -21,18 +21,16 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography<49.0.0,>=48.0.0
-Requires-Dist: fonttools<5.0.0,>=4.62.1
+Requires-Dist: fonttools<5.0.0,>=4.63.0
 Requires-Dist: pikepdf<11.0.0,>=10.5.1
 Requires-Dist: pillow<13.0.0,>=12.2.0
 Requires-Dist: pypdf<7.0.0,>=6.11.0
-Requires-Dist: reportlab<5.0.0,>=4.5.0
+Requires-Dist: reportlab<5.0.0,>=4.5.1
 Provides-Extra: cli
 Requires-Dist: typer<1.0.0,>=0.25.1; extra == "cli"
 Requires-Dist: jsonschema<5.0.0,>=4.26.0; extra == "cli"
-Provides-Extra: web-api
-Requires-Dist: fastapi[standard]<1.0.0,>=0.136.1; extra == "web-api"
 Provides-Extra: dev
-Requires-Dist: black<27.0.0,>=26.3.1; extra == "dev"
+Requires-Dist: black<27.0.0,>=26.5.1; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.14.0; extra == "dev"
 Requires-Dist: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
@@ -42,8 +40,8 @@ Requires-Dist: pudb<2026.0.0,>=2025.1.5; extra == "dev"
 Requires-Dist: pylint<5.0.0,>=4.0.5; extra == "dev"
 Requires-Dist: pyright<2.0.0,>=1.1.409; extra == "dev"
 Requires-Dist: pytest<10.0.0,>=9.0.3; extra == "dev"
-Requires-Dist: requests<3.0.0,>=2.34.0; extra == "dev"
-Requires-Dist: ruff<1.0.0,>=0.15.12; extra == "dev"
+Requires-Dist: requests<3.0.0,>=2.34.2; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.15.13; extra == "dev"
 Dynamic: license-file
 
 <p align="center"><img src="https://github.com/chinapandaman/PyPDFForm/raw/master/docs/img/logo.png"></p>

{pypdfform-4.8.4 → pypdfform-5.0.1}/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.1"
 
 from .lib.annotations import Annotations
 from .lib.assets.blank import BlankPage

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm/cli/common.py

@@ -15,7 +15,7 @@ import typer
 from jsonschema import ValidationError, validate
 
 from .. import PdfWrapper
-from ..shared.utils import WidgetKeyErrorHandler
+from ..lib.middleware.base import Widget
 
 INPUT_PDF = Annotated[
     Path,
@@ -100,23 +100,6 @@ def cli_bad_parameter(
     raise typer.BadParameter(message, param_hint=param_hint) from cause
 
 
-def cli_widget_key_error(param_hint: str) -> WidgetKeyErrorHandler:
-    """
-    Build a CLI error handler for missing form fields.
-
-    Args:
-        param_hint (str): CLI parameter associated with the field name.
-
-    Returns:
-        WidgetKeyErrorHandler: Handler that raises a Typer input error.
-    """
-
-    def _raise_cli_bad_parameter(message: str, cause: KeyError) -> NoReturn:
-        cli_bad_parameter(message, param_hint=param_hint, cause=cause)
-
-    return _raise_cli_bad_parameter
-
-
 def _validation_error_path(exc: ValidationError) -> str:
     """
     Builds a dotted JSON path for a validation error.
@@ -170,6 +153,31 @@ def load_json_file(data: Path, schema: dict, param_hint: str) -> Any:
     return input_data
 
 
+def get_widget(wrapper: PdfWrapper, field: str, param_hint: str) -> Widget:
+    """
+    Look up a widget and report missing names as CLI input errors.
+
+    Args:
+        wrapper (PdfWrapper): PDF wrapper containing form widgets.
+        field (str): Form field name to look up.
+        param_hint (str): CLI parameter associated with the field name.
+
+    Returns:
+        Widget: The matching widget.
+
+    Raises:
+        typer.BadParameter: Raised when the widget name is not present.
+    """
+    try:
+        return wrapper.widgets[field]
+    except KeyError as exc:
+        cli_bad_parameter(
+            f"Form field '{field}' does not exist.",
+            param_hint=param_hint,
+            cause=exc,
+        )
+
+
 def handle_font_registration(
     obj: PdfWrapper, params: dict, registered_font: dict
 ) -> None:

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm/cli/inspect.py

@@ -13,8 +13,7 @@ import json
 import typer
 
 from .. import PdfWrapper
-from ..shared.utils import get_widget
-from .common import FIELD_NAME, INPUT_PDF, cli_widget_key_error
+from .common import FIELD_NAME, INPUT_PDF, get_widget
 
 inspect_cli = typer.Typer(
     context_settings={"help_option_names": ["--help", "-h"]}, no_args_is_help=True
@@ -55,9 +54,7 @@ def location(
     field: FIELD_NAME,
 ) -> None:
     """Print a form field's location and size as JSON."""
-    f = get_widget(
-        PdfWrapper(str(pdf), **ctx.obj), field, cli_widget_key_error("--field")
-    )
+    f = get_widget(PdfWrapper(str(pdf), **ctx.obj), field, "--field")
 
     typer.echo(
         json.dumps(

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm/cli/schemas/create.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 JSON schemas for the PyPDFForm create CLI commands.
 """

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

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 JSON schemas for the PyPDFForm update CLI commands.
 """

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

@@ -17,11 +17,9 @@ import typer
 
 from .. import PdfWrapper
 from ..lib.constants import PdfVersion
-from ..shared.utils import get_widget
 from .common import (FIELD_NAME, INPUT_PDF, OPTIONAL_OUTPUT_PDF,
-                     cli_bad_parameter, cli_widget_key_error,
-                     handle_font_registration, json_file_option,
-                     load_json_file)
+                     cli_bad_parameter, get_widget, handle_font_registration,
+                     json_file_option, load_json_file)
 from .schemas.update import FIELD_SCHEMA, RENAME_SCHEMA
 
 update_cli = typer.Typer(
@@ -109,7 +107,7 @@ def bounds(
 ) -> None:
     """Update a form field's position and size."""
     obj = PdfWrapper(str(pdf), **ctx.obj)
-    f = get_widget(obj, widget, cli_widget_key_error("--field"))
+    f = get_widget(obj, widget, "--field")
 
     f.x = x if x is not None else f.x
     f.y = y if y is not None else f.y
@@ -139,10 +137,8 @@ def rename(
     obj = PdfWrapper(str(pdf), **ctx.obj)
     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
-            )
+            widget = get_widget(obj, k, "--file")
+            obj.update_widget_key(widget.name, v["new_key"], index=v.get("index", 0))
 
     obj.commit_widget_key_updates().write(output or pdf)
 
@@ -162,7 +158,7 @@ def field(
     obj = PdfWrapper(str(pdf), **ctx.obj)
     registered_font = {}
     for k, each in input_data.items():
-        widget = get_widget(obj, k, cli_widget_key_error("--file"))
+        widget = get_widget(obj, k, "--file")
         handle_font_registration(obj, each, registered_font)
         for param, v in each.items():
             setattr(widget, param, v)

{pypdfform-4.8.4 → pypdfform-5.0.1}/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.1}/PyPDFForm/lib/raw/image.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 Contains the RawImage class, which represents an image that can be drawn
 directly onto a PDF page at a specified position and size.

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm/lib/raw/rect.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 Contains the RawRectangle class, which represents a rectangle that can be drawn
 directly onto a PDF page at specified coordinates and dimensions.

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm/lib/widgets/dropdown.py

@@ -89,6 +89,7 @@ class DropdownField(Field):
     options: Optional[List[str | Tuple[str, str]]] = None
     width: Optional[float] = None
     height: Optional[float] = None
+    # pylint: disable=R0801
     font: Optional[str] = None
     font_size: Optional[float] = None
     font_color: Optional[Tuple[float, ...]] = None

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm/lib/widgets/signature.py

@@ -121,6 +121,7 @@ class SignatureWidget:
             annot_type_to_annot[key] = annot.get_object()
 
         for i, p in enumerate(input_pdf.pages):
+            # pylint: disable=R0801
             watermark = BytesIO()
             canvas = Canvas(
                 watermark,

{pypdfform-4.8.4 → pypdfform-5.0.1}/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.1}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.8.4
+Version: 5.0.1
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -21,18 +21,16 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography<49.0.0,>=48.0.0
-Requires-Dist: fonttools<5.0.0,>=4.62.1
+Requires-Dist: fonttools<5.0.0,>=4.63.0
 Requires-Dist: pikepdf<11.0.0,>=10.5.1
 Requires-Dist: pillow<13.0.0,>=12.2.0
 Requires-Dist: pypdf<7.0.0,>=6.11.0
-Requires-Dist: reportlab<5.0.0,>=4.5.0
+Requires-Dist: reportlab<5.0.0,>=4.5.1
 Provides-Extra: cli
 Requires-Dist: typer<1.0.0,>=0.25.1; extra == "cli"
 Requires-Dist: jsonschema<5.0.0,>=4.26.0; extra == "cli"
-Provides-Extra: web-api
-Requires-Dist: fastapi[standard]<1.0.0,>=0.136.1; extra == "web-api"
 Provides-Extra: dev
-Requires-Dist: black<27.0.0,>=26.3.1; extra == "dev"
+Requires-Dist: black<27.0.0,>=26.5.1; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.14.0; extra == "dev"
 Requires-Dist: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
@@ -42,8 +40,8 @@ Requires-Dist: pudb<2026.0.0,>=2025.1.5; extra == "dev"
 Requires-Dist: pylint<5.0.0,>=4.0.5; extra == "dev"
 Requires-Dist: pyright<2.0.0,>=1.1.409; extra == "dev"
 Requires-Dist: pytest<10.0.0,>=9.0.3; extra == "dev"
-Requires-Dist: requests<3.0.0,>=2.34.0; extra == "dev"
-Requires-Dist: ruff<1.0.0,>=0.15.12; extra == "dev"
+Requires-Dist: requests<3.0.0,>=2.34.2; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.15.13; extra == "dev"
 Dynamic: license-file
 
 <p align="center"><img src="https://github.com/chinapandaman/PyPDFForm/raw/master/docs/img/logo.png"></p>

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm.egg-info/SOURCES.txt

@@ -8,12 +8,6 @@ PyPDFForm.egg-info/dependency_links.txt
 PyPDFForm.egg-info/entry_points.txt
 PyPDFForm.egg-info/requires.txt
 PyPDFForm.egg-info/top_level.txt
-PyPDFForm/api/__init__.py
-PyPDFForm/api/common.py
-PyPDFForm/api/create.py
-PyPDFForm/api/inspect.py
-PyPDFForm/api/root.py
-PyPDFForm/api/update.py
 PyPDFForm/cli/__init__.py
 PyPDFForm/cli/common.py
 PyPDFForm/cli/create.py
@@ -72,8 +66,6 @@ PyPDFForm/lib/widgets/image.py
 PyPDFForm/lib/widgets/radio.py
 PyPDFForm/lib/widgets/signature.py
 PyPDFForm/lib/widgets/text.py
-PyPDFForm/shared/__init__.py
-PyPDFForm/shared/utils.py
 tests/test_bulk_create_fields.py
 tests/test_create_widget.py
 tests/test_draw_elements.py

{pypdfform-4.8.4 → pypdfform-5.0.1}/PyPDFForm.egg-info/requires.txt

@@ -1,16 +1,16 @@
 cryptography<49.0.0,>=48.0.0
-fonttools<5.0.0,>=4.62.1
+fonttools<5.0.0,>=4.63.0
 pikepdf<11.0.0,>=10.5.1
 pillow<13.0.0,>=12.2.0
 pypdf<7.0.0,>=6.11.0
-reportlab<5.0.0,>=4.5.0
+reportlab<5.0.0,>=4.5.1
 
 [cli]
 typer<1.0.0,>=0.25.1
 jsonschema<5.0.0,>=4.26.0
 
 [dev]
-black<27.0.0,>=26.3.1
+black<27.0.0,>=26.5.1
 coverage<8.0.0,>=7.14.0
 isort<9.0.0,>=8.0.1
 mike<3.0.0,>=2.2.0
@@ -20,8 +20,5 @@ pudb<2026.0.0,>=2025.1.5
 pylint<5.0.0,>=4.0.5
 pyright<2.0.0,>=1.1.409
 pytest<10.0.0,>=9.0.3
-requests<3.0.0,>=2.34.0
-ruff<1.0.0,>=0.15.12
-
-[web_api]
-fastapi[standard]<1.0.0,>=0.136.1
+requests<3.0.0,>=2.34.2
+ruff<1.0.0,>=0.15.13

{pypdfform-4.8.4 → pypdfform-5.0.1}/pyproject.toml

@@ -26,11 +26,11 @@ classifiers = [
 requires-python = ">=3.10"
 dependencies = [
     "cryptography>=48.0.0,<49.0.0",
-    "fonttools>=4.62.1,<5.0.0",
+    "fonttools>=4.63.0,<5.0.0",
     "pikepdf>=10.5.1,<11.0.0",
     "pillow>=12.2.0,<13.0.0",
     "pypdf>=6.11.0,<7.0.0",
-    "reportlab>=4.5.0,<5.0.0",
+    "reportlab>=4.5.1,<5.0.0",
 ]
 
 [project.urls]
@@ -38,10 +38,10 @@ Homepage = "https://github.com/chinapandaman/PyPDFForm"
 Documentation = "https://chinapandaman.github.io/PyPDFForm/"
 
 [project.optional-dependencies]
+# update `CLI_DEPENDENCIES` in `PyPDFForm/cli/entry.py` when changing cli dependencies
 cli = ["typer>=0.25.1,<1.0.0", "jsonschema>=4.26.0,<5.0.0"]
-web_api = ["fastapi[standard]>=0.136.1,<1.0.0"]
 dev = [
-    "black>=26.3.1,<27.0.0",
+    "black>=26.5.1,<27.0.0",
     "coverage>=7.14.0,<8.0.0",
     "isort>=8.0.1,<9.0.0",
     "mike>=2.2.0,<3.0.0",
@@ -51,8 +51,8 @@ dev = [
     "pylint>=4.0.5,<5.0.0",
     "pyright>=1.1.409,<2.0.0",
     "pytest>=9.0.3,<10.0.0",
-    "requests>=2.34.0,<3.0.0",
-    "ruff>=0.15.12,<1.0.0",
+    "requests>=2.34.2,<3.0.0",
+    "ruff>=0.15.13,<1.0.0",
 ]
 
 [project.scripts]
@@ -74,7 +74,6 @@ disable = [
     "C2801",
     "C0301",
     "W0511",
-    "R0801",
 ]
 
 [tool.ruff.lint]
@@ -139,7 +138,6 @@ include = ["PyPDFForm*"]
 
 [tool.pytest.ini_options]
 markers = [
-    "posix_only",   # mainly because of zlib vs zlib-ng
+    "posix_only", # mainly because of zlib vs zlib-ng
     "cli_test",
-    "web_api_test",
 ]

{pypdfform-4.8.4 → pypdfform-5.0.1}/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.1}/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",

pypdfform-4.8.4/PyPDFForm/api/__init__.py

@@ -1,28 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-FastAPI application for the optional PyPDFForm web API.
-
-The web API is intended to be PyPDFForm's third user-facing interface alongside
-the Python library and CLI. As the API surface grows, its endpoints should
-closely mirror the CLI workflows for creating, filling, inspecting, and updating
-PDF forms, while exposing those operations over HTTP.
-"""
-
-from fastapi import FastAPI
-
-from .. import __version__
-from .create import create_router
-from .inspect import inspect_router
-from .root import root_router
-from .update import update_router
-
-app = FastAPI(
-    title="PyPDFForm Web API",
-    summary="Create, fill, inspect, and update PDF forms.",
-    version=__version__,
-)
-
-app.include_router(root_router)
-app.include_router(create_router)
-app.include_router(inspect_router)
-app.include_router(update_router)

pypdfform-4.8.4/PyPDFForm/api/common.py

@@ -1,101 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-This module provides shared helpers for PyPDFForm web API routes.
-
-It defines the PDF response class and common query parameter parsing used by
-endpoint groups that construct `PdfWrapper` instances from uploaded PDF files.
-"""
-
-from typing import NoReturn
-
-from fastapi import HTTPException, Query, Response, status
-from pydantic import BaseModel
-
-
-class PdfResponse(Response):
-    """
-    FastAPI response class for PDF bytes.
-
-    Attributes:
-        media_type (str): Response media type for PDF content.
-    """
-
-    media_type = "application/pdf"
-
-
-class PdfWrapperOptions(BaseModel):
-    """
-    Common `PdfWrapper` options accepted by web API endpoints.
-
-    These fields mirror the constructor options exposed by the Python library
-    and CLI so each route can opt into the same PDF handling behavior.
-
-    Attributes:
-        need_appearances (bool): Whether to set the PDF's NeedAppearances flag.
-        generate_appearance_streams (bool): Whether to generate appearance
-            streams for filled fields.
-        preserve_metadata (bool): Whether to preserve source PDF metadata.
-        use_full_widget_name (bool): Whether to use full widget names when
-            reading fields.
-    """
-
-    need_appearances: bool = False
-    generate_appearance_streams: bool = False
-    preserve_metadata: bool = False
-    use_full_widget_name: bool = False
-
-    def as_kwargs(self) -> dict:
-        """
-        Convert options into `PdfWrapper` keyword arguments.
-
-        Returns:
-            dict: Mapping of option names to values accepted by `PdfWrapper`.
-        """
-        return self.model_dump()
-
-
-def pdf_wrapper_options(
-    need_appearances: bool = Query(False),
-    generate_appearance_streams: bool = Query(False),
-    preserve_metadata: bool = Query(False),
-    use_full_widget_name: bool = Query(False),
-) -> PdfWrapperOptions:
-    """
-    Build common `PdfWrapper` options from query parameters.
-
-    FastAPI uses this function as a dependency so routes can share a
-    consistent query parameter set.
-
-    Args:
-        need_appearances (bool): Whether to set the PDF's NeedAppearances flag.
-        generate_appearance_streams (bool): Whether to generate appearance
-            streams for filled fields.
-        preserve_metadata (bool): Whether to preserve source PDF metadata.
-        use_full_widget_name (bool): Whether to use full widget names when
-            reading fields.
-
-    Returns:
-        PdfWrapperOptions: Parsed options for constructing a `PdfWrapper`.
-    """
-    return PdfWrapperOptions(
-        need_appearances=need_appearances,
-        generate_appearance_streams=generate_appearance_streams,
-        preserve_metadata=preserve_metadata,
-        use_full_widget_name=use_full_widget_name,
-    )
-
-
-def api_widget_key_error(message: str, cause: KeyError) -> NoReturn:
-    """
-    Raise a web API error for a missing form field.
-
-    Args:
-        message (str): Error message to return to the API client.
-        cause (KeyError): Original lookup error.
-
-    Raises:
-        HTTPException: Raised with a 404 response for the missing field.
-    """
-    raise HTTPException(
-        status_code=status.HTTP_404_NOT_FOUND, detail=message
-    ) from cause

pypdfform-4.8.4/PyPDFForm/api/create.py

@@ -1,75 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-This module defines web API routes for creating PDF files and PDF content.
-
-It exposes `/create` endpoints that accept uploaded PDFs, apply matching
-`PdfWrapper` creation operations, and return generated PDF bytes to HTTP
-clients.
-"""
-
-from typing import Annotated
-
-from fastapi import APIRouter, Depends, File, Form, UploadFile
-
-from .. import PdfWrapper
-from .common import PdfResponse, PdfWrapperOptions, pdf_wrapper_options
-
-create_router = APIRouter(prefix="/create", tags=["create"])
-
-
-@create_router.post(
-    "/grid",
-    summary="Add a coordinate grid to a PDF.",
-    response_class=PdfResponse,
-    responses={
-        200: {
-            "content": {
-                "application/pdf": {"schema": {"type": "string", "format": "binary"}}
-            },
-        }
-    },
-)
-def grid(
-    options: Annotated[PdfWrapperOptions, Depends(pdf_wrapper_options)],
-    pdf: Annotated[UploadFile, File()],
-    red: Annotated[float, Form()] = None,
-    green: Annotated[float, Form()] = None,
-    blue: Annotated[float, Form()] = None,
-    margin: Annotated[float, Form()] = None,
-) -> PdfResponse:
-    """
-    Upload a PDF and return a copy with a coordinate grid overlaid on each page.
-
-    Use the optional RGB components to choose the grid color and `margin` to
-    adjust the grid spacing from the page edges.
-
-    \f
-
-    Args:
-        options (PdfWrapperOptions): Common `PdfWrapper` construction options.
-        pdf (UploadFile): Uploaded PDF file to annotate with a grid.
-        red (float): Red component of the grid color, from 0 to 1.
-        green (float): Green component of the grid color, from 0 to 1.
-        blue (float): Blue component of the grid color, from 0 to 1.
-        margin (float): Grid margin in points.
-
-    Returns:
-        PdfResponse: PDF response containing the document with a coordinate grid.
-    """
-    params = {}
-    if any(
-        [
-            red is not None,
-            green is not None,
-            blue is not None,
-        ]
-    ):
-        params["color"] = (red or 0, green or 0, blue or 0)
-
-    if margin is not None:
-        params["margin"] = int(margin) if margin.is_integer() else margin
-    return PdfResponse(
-        PdfWrapper(pdf.file.read(), **options.as_kwargs())
-        .generate_coordinate_grid(**params)
-        .read()
-    )

pypdfform-4.8.4/PyPDFForm/api/inspect.py

@@ -1,127 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-This module defines web API routes for inspecting PDF form information.
-
-It exposes `/inspect` endpoints that return JSON for form schemas, current
-form values, generated sample data, and field rectangle metadata. Each endpoint
-wraps read-only `PdfWrapper` properties for clients calling PyPDFForm over HTTP.
-"""
-
-from typing import Annotated
-
-from fastapi import APIRouter, Depends, File, Form, UploadFile
-
-from .. import PdfWrapper
-from ..shared.utils import get_widget
-from .common import (PdfWrapperOptions, api_widget_key_error,
-                     pdf_wrapper_options)
-
-inspect_router = APIRouter(prefix="/inspect", tags=["inspect"])
-
-
-@inspect_router.post("/schema", summary="Return the form schema as JSON.")
-def schema(
-    options: Annotated[PdfWrapperOptions, Depends(pdf_wrapper_options)],
-    pdf: Annotated[UploadFile, File()],
-) -> dict:
-    """
-    Upload a PDF form and return the JSON schema PyPDFForm detects for its
-    fields.
-
-    Use this response to discover field names, value types, and validation
-    constraints before filling or updating a form.
-
-    \f
-
-    Args:
-        options (PdfWrapperOptions): Common `PdfWrapper` construction options.
-        pdf (UploadFile): Uploaded PDF file to inspect.
-
-    Returns:
-        dict: JSON-serializable form schema.
-    """
-    return PdfWrapper(pdf.file.read(), **options.as_kwargs()).schema
-
-
-@inspect_router.post("/data", summary="Return current form data as JSON.")
-def data(
-    options: Annotated[PdfWrapperOptions, Depends(pdf_wrapper_options)],
-    pdf: Annotated[UploadFile, File()],
-) -> dict:
-    """
-    Upload a PDF form and return the values currently stored in its fields.
-
-    Empty fields are included in the response so clients can distinguish
-    missing form fields from blank values.
-
-    \f
-
-    Args:
-        options (PdfWrapperOptions): Common `PdfWrapper` construction options.
-        pdf (UploadFile): Uploaded PDF file to inspect.
-
-    Returns:
-        dict: JSON-serializable current form data.
-    """
-    return PdfWrapper(pdf.file.read(), **options.as_kwargs()).data
-
-
-@inspect_router.post("/sample", summary="Return sample fill data as JSON.")
-def sample(
-    options: Annotated[PdfWrapperOptions, Depends(pdf_wrapper_options)],
-    pdf: Annotated[UploadFile, File()],
-) -> dict:
-    """
-    Upload a PDF form and return example data matching the detected schema.
-
-    Use this response as a starting payload when testing form filling or when
-    building a client-side editor for a PDF form.
-
-    \f
-
-    Args:
-        options (PdfWrapperOptions): Common `PdfWrapper` construction options.
-        pdf (UploadFile): Uploaded PDF file to inspect.
-
-    Returns:
-        dict: JSON-serializable sample fill data.
-    """
-    return PdfWrapper(pdf.file.read(), **options.as_kwargs()).sample_data
-
-
-@inspect_router.post(
-    "/location", summary="Return a form field's location and size as JSON."
-)
-def location(
-    options: Annotated[PdfWrapperOptions, Depends(pdf_wrapper_options)],
-    pdf: Annotated[UploadFile, File()],
-    field: Annotated[str, Form()],
-) -> dict:
-    """
-    Upload a PDF form and field name, then return that field's page number,
-    coordinates, width, and height.
-
-    Use this endpoint when placing overlays, annotations, or generated content
-    relative to an existing form field.
-
-    \f
-
-    Args:
-        options (PdfWrapperOptions): Common `PdfWrapper` construction options.
-        pdf (UploadFile): Uploaded PDF file to inspect.
-        field (str): Name of the form field to locate.
-
-    Returns:
-        dict: JSON-serializable field page number, coordinates, and dimensions.
-    """
-    f = get_widget(
-        PdfWrapper(pdf.file.read(), **options.as_kwargs()), field, api_widget_key_error
-    )
-
-    return {
-        "page_number": f.page_number,
-        "x": f.x,
-        "y": f.y,
-        "width": f.width,
-        "height": f.height,
-    }

pypdfform-4.8.4/PyPDFForm/api/root.py

@@ -1,20 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Root router for the PyPDFForm web API.
-
-This router owns the top-level API routes that make PyPDFForm available over
-HTTP. Finished endpoint groups should stay aligned with the CLI's behavior so
-users can choose between the Python library, command line, or web API without
-learning a different workflow model.
-"""
-
-from fastapi import APIRouter
-from fastapi.responses import RedirectResponse
-
-root_router = APIRouter()
-
-
-@root_router.get("/", include_in_schema=False)
-def index() -> RedirectResponse:
-    """Redirect the API root to the generated OpenAPI documentation."""
-    return RedirectResponse(url="/docs")

pypdfform-4.8.4/PyPDFForm/api/update.py

@@ -1,56 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-This module defines web API routes for updating existing PDF files.
-
-It exposes `/update` endpoints that accept uploaded PDFs, apply matching
-`PdfWrapper` operations, and return modified PDF bytes to HTTP clients.
-"""
-
-from typing import Annotated
-
-from fastapi import APIRouter, Depends, File, Form, UploadFile
-
-from .. import PdfWrapper
-from .common import PdfResponse, PdfWrapperOptions, pdf_wrapper_options
-
-update_router = APIRouter(prefix="/update", tags=["update"])
-
-
-@update_router.post(
-    "/title",
-    summary="Set the PDF title.",
-    response_class=PdfResponse,
-    responses={
-        200: {
-            "content": {
-                "application/pdf": {"schema": {"type": "string", "format": "binary"}}
-            },
-        }
-    },
-)
-def title(
-    options: Annotated[PdfWrapperOptions, Depends(pdf_wrapper_options)],
-    pdf: Annotated[UploadFile, File()],
-    new_title: Annotated[str, Form()],
-) -> PdfResponse:
-    """
-    Upload a PDF and return a copy with its document title metadata updated.
-
-    The response body is the modified PDF file, preserving other behavior from
-    the common `PdfWrapper` options supplied as query parameters.
-
-    \f
-
-    Args:
-        options (PdfWrapperOptions): Common `PdfWrapper` construction options.
-        pdf (UploadFile): Uploaded PDF file to update.
-        new_title (str): New title to write into the PDF metadata.
-
-    Returns:
-        PdfResponse: PDF response containing the updated document bytes.
-    """
-    return PdfResponse(
-        content=PdfWrapper(
-            pdf.file.read(), title=new_title, **options.as_kwargs()
-        ).read()
-    )

pypdfform-4.8.4/PyPDFForm/shared/utils.py

@@ -1,42 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Shared helpers used by multiple PyPDFForm interfaces.
-
-These utilities contain behavior that should stay consistent across the CLI,
-web API, and any future user-facing entry points.
-"""
-
-from collections.abc import Callable
-from typing import NoReturn
-
-from .. import PdfWrapper
-from ..lib.middleware.base import Widget
-
-WidgetKeyErrorHandler = Callable[[str, KeyError], NoReturn]
-
-
-def get_widget(
-    wrapper: PdfWrapper,
-    field: str,
-    key_error_handler: WidgetKeyErrorHandler,
-) -> Widget:
-    """
-    Look up a widget by field name.
-
-    Args:
-        wrapper (PdfWrapper): PDF wrapper containing form widgets.
-        field (str): Form field name to look up.
-        key_error_handler (WidgetKeyErrorHandler, optional): Interface-specific
-            error handler for missing field names. Defaults to None.
-
-    Returns:
-        Widget: The matching widget.
-
-    Raises:
-        KeyError: Raised when the widget name is not present and no handler is
-            supplied.
-    """
-    try:
-        return wrapper.widgets[field]
-    except KeyError as exc:
-        return key_error_handler(f"Form field '{field}' does not exist.", exc)