PyPDFForm 4.7.8__tar.gz → 4.7.9__tar.gz

{pypdfform-4.7.8 → pypdfform-4.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.7.8
+Version: 4.7.9
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -26,6 +26,8 @@ Requires-Dist: pikepdf<11.0.0,>=10.5.0
 Requires-Dist: pillow<13.0.0,>=12.0.0
 Requires-Dist: pypdf<7.0.0,>=6.9.0
 Requires-Dist: reportlab<5.0.0,>=4.4.6
+Provides-Extra: cli
+Requires-Dist: typer<1.0.0,>=0.24.1; extra == "cli"
 Provides-Extra: dev
 Requires-Dist: black<27.0.0,>=25.11.0; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.12.0; extra == "dev"

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm/__init__.py

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

pypdfform-4.7.9/PyPDFForm/cli/__init__.py

@@ -0,0 +1,166 @@
+# -*- coding: utf-8 -*-
+"""
+This module provides the command-line interface for PyPDFForm.
+
+It defines the CLI application using Typer, providing commands for
+interacting with PyPDFForm functionality from the terminal.
+"""
+
+from typing import Annotated
+
+import typer
+
+from .. import __version__
+from .update import update_cli
+
+cli_app = typer.Typer(
+    context_settings={"help_option_names": ["--help", "-h"]}, no_args_is_help=True
+)
+cli_app.add_typer(
+    update_cli,
+    name="update",
+    help="Subcommands for updating PDF files and their elements.",
+)
+
+
+def version_callback(value: bool) -> None:
+    """
+    Callback function to handle the version option.
+
+    This is triggered when the --version or -v flag is passed to the CLI.
+    It prints the current version of PyPDFForm and exits the application.
+
+    Args:
+        value (bool): The value passed to the version option. If True,
+            the version information is displayed and the application exits.
+    """
+    if value:
+        print(f"v{__version__}")
+        raise typer.Exit
+
+
+def need_appearances_callback(ctx: typer.Context, value: bool) -> None:
+    """
+    Callback function to handle the need_appearances option.
+
+    This is triggered when the --need-appearances flag is passed to the CLI.
+    It stores the value in the context object for use by subcommands.
+
+    Args:
+        ctx (typer.Context): The Typer context object used to pass data
+            between callbacks and commands.
+        value (bool): The value passed to the need_appearances option.
+            If True, PDF viewers will be instructed to generate appearance
+            streams for the output.
+    """
+    if not ctx.obj:
+        ctx.obj = {}
+    ctx.obj["need_appearances"] = value
+
+
+def generate_appearance_streams_callback(ctx: typer.Context, value: bool) -> None:
+    """
+    Callback function to handle the generate_appearance_streams option.
+
+    This is triggered when the --generate-appearance-streams flag is passed
+    to the CLI. It stores the value in the context object for use by subcommands.
+
+    Args:
+        ctx (typer.Context): The Typer context object used to pass data
+            between callbacks and commands.
+        value (bool): The value passed to the generate_appearance_streams
+            option. If True, appearance streams will be explicitly generated
+            for all form fields in output PDFs using pikepdf.
+    """
+    if not ctx.obj:
+        ctx.obj = {}
+    ctx.obj["generate_appearance_streams"] = value
+
+
+def preserve_metadata_callback(ctx: typer.Context, value: bool) -> None:
+    """
+    Callback function to handle the preserve_metadata option.
+
+    This is triggered when the --preserve-metadata flag is passed to the CLI.
+    It stores the value in the context object for use by subcommands.
+
+    Args:
+        ctx (typer.Context): The Typer context object used to pass data
+            between callbacks and commands.
+        value (bool): The value passed to the preserve_metadata option.
+            If True, metadata will be preserved in output PDFs.
+    """
+    if not ctx.obj:
+        ctx.obj = {}
+    ctx.obj["preserve_metadata"] = value
+
+
+def use_full_widget_name_callback(ctx: typer.Context, value: bool) -> None:
+    """
+    Callback function to handle the use_full_widget_name option.
+
+    This is triggered when the --use-full-widget-name flag is passed to the CLI.
+    It stores the value in the context object for use by subcommands.
+
+    Args:
+        ctx (typer.Context): The Typer context object used to pass data
+            between callbacks and commands.
+        value (bool): The value passed to the use_full_widget_name option.
+            If True, fully qualified names (including parent field names)
+            will be used when looking up form fields.
+    """
+    if not ctx.obj:
+        ctx.obj = {}
+    ctx.obj["use_full_widget_name"] = value
+
+
+@cli_app.callback(invoke_without_command=True, help="Welcome to the PyPDFForm CLI!")
+def main(
+    version: Annotated[  # pylint: disable=W0613
+        bool,
+        typer.Option(
+            "--version",
+            "-v",
+            callback=version_callback,
+            is_eager=True,
+            help="Show current version of the CLI and exit.",
+        ),
+    ] = False,
+    need_appearances: Annotated[  # pylint: disable=W0613
+        bool,
+        typer.Option(
+            "--need-appearances",
+            callback=need_appearances_callback,
+            help="Instruct PDF viewers to generate appearance streams for any output PDF.",
+        ),
+    ] = False,
+    generate_appearance_streams: Annotated[  # pylint: disable=W0613
+        bool,
+        typer.Option(
+            "--generate-appearance-streams",
+            callback=generate_appearance_streams_callback,
+            help="Generate appearance streams for any output PDF.",
+        ),
+    ] = False,
+    preserve_metadata: Annotated[  # pylint: disable=W0613
+        bool,
+        typer.Option(
+            "--preserve-metadata",
+            callback=preserve_metadata_callback,
+            help="Preserve PDF metadata in output.",
+        ),
+    ] = False,
+    use_full_widget_name: Annotated[  # pylint: disable=W0613
+        bool,
+        typer.Option(
+            "--use-full-widget-name",
+            callback=use_full_widget_name_callback,
+            help="Use fully qualified names when accessing form fields.",
+        ),
+    ] = False,
+) -> None:
+    # pylint: disable=C0116
+    ...
+
+
+__all__ = ["cli_app"]

pypdfform-4.7.9/PyPDFForm/cli/update.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# TODO: fix this docstring
+"""
+CLI commands for updating PDF metadata.
+
+This module provides command-line interface commands for modifying
+PDF file metadata such as title, author, subject, and other properties.
+These commands allow users to update PDF documents directly from
+the terminal without needing to use Python code.
+
+The commands in this module wrap the functionality provided by
+the PdfWrapper class, exposing it through a Typer-based CLI for
+ease of use.
+"""
+
+from typing import Annotated
+
+import typer
+
+from .. import PdfWrapper
+
+update_cli = typer.Typer(
+    context_settings={"help_option_names": ["--help", "-h"]}, no_args_is_help=True
+)
+
+
+@update_cli.command(no_args_is_help=True)
+def title(
+    ctx: typer.Context,
+    pdf: Annotated[str, typer.Argument(help="The local path to a PDF.")],
+    new_title: Annotated[
+        str, typer.Option("--title", "-t", help="The new title for the PDF.")
+    ],
+    output: Annotated[
+        str,
+        typer.Option(
+            "--output",
+            "-o",
+            help="The location to save the PDF to. Defaults to the original path if unspecified.",
+        ),
+    ] = None,
+) -> None:
+    """
+    Update the title of a PDF.
+    """
+    PdfWrapper(pdf, title=new_title, **ctx.obj).write(output or pdf)

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm/lib/watermark.py

@@ -260,7 +260,6 @@ def create_watermarks_and_draw(
         page_to_to_draw[each["page_number"]].append(each)
 
     pdf_file = PdfReader(BytesIO(pdf))
-    buff = BytesIO()
 
     for i, page in enumerate(pdf_file.pages):
         elements = page_to_to_draw[i + 1]
@@ -268,8 +267,7 @@ def create_watermarks_and_draw(
             result.append(b"")
             continue
 
-        buff.seek(0)
-        buff.flush()
+        buff = BytesIO()
 
         canvas = Canvas(
             buff,

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm/lib/widgets/base.py

@@ -177,7 +177,6 @@ class Widget:
         result = []
 
         pdf = PdfReader(BytesIO(stream))
-        watermark = BytesIO()
 
         widgets_by_page = {}
         for widget in widgets:
@@ -191,8 +190,9 @@ class Widget:
                 result.append(b"")
                 continue
 
-            watermark.seek(0)
-            watermark.flush()
+            # Use a fresh buffer per page to avoid stale trailing bytes
+            # when the current page watermark is smaller than a previous page.
+            watermark = BytesIO()
 
             canvas = Canvas(
                 watermark,

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm/lib/widgets/signature.py

@@ -120,12 +120,9 @@ class SignatureWidget:
             key = get_widget_key(annot.get_object(), False)
             annot_type_to_annot[key] = annot.get_object()
 
-        watermark = BytesIO()
-
         for i, p in enumerate(input_pdf.pages):
             # pylint: disable=R0801
-            watermark.seek(0)
-            watermark.flush()
+            watermark = BytesIO()
             canvas = Canvas(
                 watermark,
                 pagesize=(

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.7.8
+Version: 4.7.9
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -26,6 +26,8 @@ Requires-Dist: pikepdf<11.0.0,>=10.5.0
 Requires-Dist: pillow<13.0.0,>=12.0.0
 Requires-Dist: pypdf<7.0.0,>=6.9.0
 Requires-Dist: reportlab<5.0.0,>=4.4.6
+Provides-Extra: cli
+Requires-Dist: typer<1.0.0,>=0.24.1; extra == "cli"
 Provides-Extra: dev
 Requires-Dist: black<27.0.0,>=25.11.0; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.12.0; extra == "dev"

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm.egg-info/SOURCES.txt

@@ -5,8 +5,11 @@ PyPDFForm/__init__.py
 PyPDFForm.egg-info/PKG-INFO
 PyPDFForm.egg-info/SOURCES.txt
 PyPDFForm.egg-info/dependency_links.txt
+PyPDFForm.egg-info/entry_points.txt
 PyPDFForm.egg-info/requires.txt
 PyPDFForm.egg-info/top_level.txt
+PyPDFForm/cli/__init__.py
+PyPDFForm/cli/update.py
 PyPDFForm/lib/__init__.py
 PyPDFForm/lib/adapter.py
 PyPDFForm/lib/constants.py
@@ -56,6 +59,7 @@ PyPDFForm/lib/widgets/radio.py
 PyPDFForm/lib/widgets/signature.py
 PyPDFForm/lib/widgets/text.py
 tests/test_bulk_create_fields.py
+tests/test_cli.py
 tests/test_create_widget.py
 tests/test_draw_elements.py
 tests/test_dropdown.py

pypdfform-4.7.9/PyPDFForm.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pypdfform = PyPDFForm.cli:cli_app

{pypdfform-4.7.8 → pypdfform-4.7.9}/PyPDFForm.egg-info/requires.txt

@@ -5,6 +5,9 @@ pillow<13.0.0,>=12.0.0
 pypdf<7.0.0,>=6.9.0
 reportlab<5.0.0,>=4.4.6
 
+[cli]
+typer<1.0.0,>=0.24.1
+
 [dev]
 black<27.0.0,>=25.11.0
 coverage<8.0.0,>=7.12.0

{pypdfform-4.7.8 → pypdfform-4.7.9}/pyproject.toml

@@ -7,9 +7,7 @@ name = "PyPDFForm"
 dynamic = ["version"]
 description = "The Python library for PDF forms."
 readme = "README.md"
-authors = [
-    {name = "Jinge Li"}
-]
+authors = [{ name = "Jinge Li" }]
 license = "MIT"
 license-files = ["LICENSE"]
 classifiers = [
@@ -40,6 +38,7 @@ Homepage = "https://github.com/chinapandaman/PyPDFForm"
 Documentation = "https://chinapandaman.github.io/PyPDFForm/"
 
 [project.optional-dependencies]
+cli = ["typer>=0.24.1,<1.0.0"]
 dev = [
     "black>=25.11.0,<27.0.0",
     "coverage>=7.12.0,<8.0.0",
@@ -56,6 +55,9 @@ dev = [
     "ruff>=0.14.6,<1.0.0",
 ]
 
+[project.scripts]
+pypdfform = "PyPDFForm.cli:cli_app"
+
 [tool.coverage.run]
 include = ["PyPDFForm/*"]
 
@@ -129,7 +131,7 @@ reportAssignmentType = "error"
 reportOptionalSubscript = "error"
 
 [tool.setuptools.dynamic]
-version = {attr = "PyPDFForm.__version__"}
+version = { attr = "PyPDFForm.__version__" }
 
 [tool.setuptools.packages.find]
 include = ["PyPDFForm*"]

{pypdfform-4.7.8 → pypdfform-4.7.9}/tests/test_bulk_create_fields.py

@@ -1,10 +1,13 @@
 # -*- coding: utf-8 -*-
 
 import os
+from io import BytesIO
 
 import pytest
+from pypdf import PdfReader
 
-from PyPDFForm import Fields, PdfWrapper
+from PyPDFForm import BlankPage, Fields, PdfWrapper
+from PyPDFForm.lib.constants import Annots, Subtype, Widget
 
 
 @pytest.mark.posix_only
@@ -144,3 +147,51 @@ def test_bulk_create_fields_stress_max_mixed(pdf_samples, request):
 
         assert len(obj.read()) == len(expected)
         assert obj.read() == expected
+
+
+def test_bulk_create_fields_does_not_duplicate_widgets():
+    wrapper = PdfWrapper(BlankPage() * 2)
+
+    fields = []
+    y = 760.0
+    for i in range(35):
+        fields.append(
+            Fields.TextField(
+                f"p1_field_{i}",
+                1,
+                50.0,
+                y,
+                width=220.0,
+                height=16.0,
+                font_size=9.0,
+            )
+        )
+        y -= 20.0
+
+    y = 760.0
+    for i in range(4):
+        fields.append(
+            Fields.TextField(
+                f"p2_field_{i}",
+                2,
+                50.0,
+                y,
+                width=220.0,
+                height=16.0,
+                font_size=9.0,
+            )
+        )
+        y -= 24.0
+
+    output = wrapper.bulk_create_fields(fields).read()
+    reader = PdfReader(BytesIO(output))
+
+    widget_count = 0
+    for page in reader.pages:
+        annots = page.get(Annots) or []
+        for annot_ref in annots:
+            annot = annot_ref.get_object()
+            if str(annot.get(Subtype)) == Widget:
+                widget_count += 1
+
+    assert widget_count == len(fields)

pypdfform-4.7.9/tests/test_cli.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+from typer.testing import CliRunner
+
+from PyPDFForm import __version__
+from PyPDFForm.cli import cli_app
+
+runner = CliRunner()
+
+
+def test_root_command():
+    result = runner.invoke(cli_app)
+    assert result.exit_code == 2
+
+    assert "Welcome to the PyPDFForm CLI!" in result.output
+    assert "Usage:" in result.output
+    assert "main" not in result.output
+
+
+def test_root_command_with_version():
+    long = runner.invoke(cli_app, ["--version"])
+    short = runner.invoke(cli_app, ["-v"])
+
+    assert long.exit_code == 0
+    assert short.exit_code == 0
+
+    assert long.output == f"v{__version__}\n"
+    assert long.output == short.output
+
+
+def test_update_command():
+    result = runner.invoke(cli_app, ["update"])
+    assert result.exit_code == 2
+
+    assert "Usage:" in result.output