PyPDFForm 4.7.9__tar.gz → 4.7.10__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.7.9
+Version: 4.7.10
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -24,7 +24,7 @@ Requires-Dist: cryptography<47.0.0,>=46.0.3
 Requires-Dist: fonttools<5.0.0,>=4.60.1
 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: pypdf<6.10.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"

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

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

{pypdfform-4.7.9 → pypdfform-4.7.10}/PyPDFForm/cli/__init__.py

@@ -11,11 +11,17 @@ from typing import Annotated
 import typer
 
 from .. import __version__
+from .coordinate import coordinate_cli
 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(
+    coordinate_cli,
+    name="coordinate",
+    help="Subcommands for interacting with PDF coordinates and dimensions.",
+)
 cli_app.add_typer(
     update_cli,
     name="update",
@@ -114,7 +120,7 @@ def use_full_widget_name_callback(ctx: typer.Context, value: bool) -> None:
     ctx.obj["use_full_widget_name"] = value
 
 
-@cli_app.callback(invoke_without_command=True, help="Welcome to the PyPDFForm CLI!")
+@cli_app.callback(invoke_without_command=True, help="PyPDFForm command-line interface.")
 def main(
     version: Annotated[  # pylint: disable=W0613
         bool,
@@ -123,7 +129,7 @@ def main(
             "-v",
             callback=version_callback,
             is_eager=True,
-            help="Show current version of the CLI and exit.",
+            help="Show the current version of the CLI and exit.",
         ),
     ] = False,
     need_appearances: Annotated[  # pylint: disable=W0613
@@ -147,7 +153,7 @@ def main(
         typer.Option(
             "--preserve-metadata",
             callback=preserve_metadata_callback,
-            help="Preserve PDF metadata in output.",
+            help="Preserve PDF metadata in the output.",
         ),
     ] = False,
     use_full_widget_name: Annotated[  # pylint: disable=W0613

pypdfform-4.7.10/PyPDFForm/cli/coordinate.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+"""
+CLI commands for interacting with PDF coordinates.
+
+This module provides command-line interface commands for working with
+PDF coordinates and dimensions, such as generating a coordinate grid view.
+"""
+
+from typing import Annotated
+
+import typer
+
+from .. import PdfWrapper
+
+coordinate_cli = typer.Typer(
+    context_settings={"help_option_names": ["--help", "-h"]}, no_args_is_help=True
+)
+
+
+@coordinate_cli.command(no_args_is_help=True)
+def grid(
+    ctx: typer.Context,
+    pdf: Annotated[str, typer.Argument(help="Path to the input PDF file.")],
+    output: Annotated[
+        str,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Path to save the output PDF. Defaults to the original path if not specified.",
+        ),
+    ] = None,
+    red: Annotated[
+        float,
+        typer.Option(
+            "--red",
+            "-r",
+            help="Red channel of the RGB color.",
+        ),
+    ] = None,
+    green: Annotated[
+        float,
+        typer.Option(
+            "--green",
+            "-g",
+            help="Green channel of the RGB color.",
+        ),
+    ] = None,
+    blue: Annotated[
+        float,
+        typer.Option(
+            "--blue",
+            "-b",
+            help="Blue channel of the RGB color.",
+        ),
+    ] = None,
+    margin: Annotated[
+        float,
+        typer.Option(
+            "--margin",
+            "-m",
+            help="Margin of the grid view in points.",
+        ),
+    ] = None,
+) -> None:
+    """
+    Generate a coordinate grid view for a PDF.
+    """
+    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
+    PdfWrapper(pdf, **ctx.obj).generate_coordinate_grid(**params).write(output or pdf)

{pypdfform-4.7.9 → pypdfform-4.7.10}/PyPDFForm/cli/update.py

@@ -1,12 +1,11 @@
 # -*- coding: utf-8 -*-
-# TODO: fix this docstring
 """
-CLI commands for updating PDF metadata.
+CLI commands for updating PDFs.
 
 This module provides command-line interface commands for modifying
-PDF file metadata such as title, author, subject, and other properties.
+PDF files, such as updating metadata or other elements.
 These commands allow users to update PDF documents directly from
-the terminal without needing to use Python code.
+the terminal without needing to write Python code.
 
 The commands in this module wrap the functionality provided by
 the PdfWrapper class, exposing it through a Typer-based CLI for
@@ -27,20 +26,20 @@ update_cli = typer.Typer(
 @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.")],
+    pdf: Annotated[str, typer.Argument(help="Path to the input PDF file.")],
     new_title: Annotated[
-        str, typer.Option("--title", "-t", help="The new title for the PDF.")
+        str, typer.Option("--title", "-t", help="The new title for the PDF file.")
     ],
     output: Annotated[
         str,
         typer.Option(
             "--output",
             "-o",
-            help="The location to save the PDF to. Defaults to the original path if unspecified.",
+            help="Path to save the output PDF. Defaults to the original path if not specified.",
         ),
     ] = None,
 ) -> None:
     """
-    Update the title of a PDF.
+    Update the title of a PDF file.
     """
     PdfWrapper(pdf, title=new_title, **ctx.obj).write(output or pdf)

{pypdfform-4.7.9 → pypdfform-4.7.10}/PyPDFForm/lib/middleware/base.py

@@ -62,6 +62,7 @@ class Widget:
         self.hooks_to_trigger: list = []
 
         # coordinate & dimension
+        self.page_number: Optional[int] = None
         self.x: Optional[float | List[float]] = None
         self.y: Optional[float | List[float]] = None
         self.width: Optional[float | List[float]] = None

{pypdfform-4.7.9 → pypdfform-4.7.10}/PyPDFForm/lib/template.py

@@ -73,28 +73,32 @@ def build_widgets(
     """
     results = {}
 
-    for widgets in get_widgets_by_page(pdf_stream).values():
+    for page_num, widgets in get_widgets_by_page(pdf_stream).items():
         for widget in widgets:
-            _process_widget(widget, use_full_widget_name, results)
+            _process_widget(widget, page_num, use_full_widget_name, results)
 
     return results
 
 
 def _process_widget(
-    widget: dict, use_full_widget_name: bool, results: Dict[str, WIDGET_TYPES]
+    widget: dict,
+    page_number: int,
+    use_full_widget_name: bool,
+    results: Dict[str, WIDGET_TYPES],
 ) -> None:
     """
     Processes a single widget and adds it to the results dictionary.
 
     Args:
         widget (dict): The widget dictionary from the PDF.
+        page_number (int): The 1-indexed page number the widget appears on.
         use_full_widget_name (bool): Whether to use the full widget name.
         results (Dict[str, WIDGET_TYPES]): The dictionary of widgets being built.
     """
     key = get_widget_key(widget, use_full_widget_name)
     _widget = construct_widget(widget, key)
     if _widget is not None:
-        _populate_common_properties(widget, _widget)
+        _populate_common_properties(widget, page_number, _widget)
 
         if isinstance(_widget, Text):
             _populate_text_properties(widget, _widget)
@@ -111,15 +115,19 @@ def _process_widget(
             results[key] = _widget
 
 
-def _populate_common_properties(widget: dict, _widget: WIDGET_TYPES) -> None:
+def _populate_common_properties(
+    widget: dict, page_number: int, _widget: WIDGET_TYPES
+) -> None:
     """
     Populates common properties for a widget.
 
     Args:
         widget (dict): The widget dictionary from the PDF.
+        page_number (int): The 1-indexed page number the widget appears on.
         _widget (WIDGET_TYPES): The widget object to populate.
     """
     # widget property extractions don't trigger hooks in this function
+    _widget.__dict__["page_number"] = page_number
     _widget.__dict__["tooltip"] = extract_widget_property(
         widget, WIDGET_DESCRIPTION_PATTERNS, None, str
     )

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.7.9
+Version: 4.7.10
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -24,7 +24,7 @@ Requires-Dist: cryptography<47.0.0,>=46.0.3
 Requires-Dist: fonttools<5.0.0,>=4.60.1
 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: pypdf<6.10.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"

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

@@ -9,6 +9,7 @@ PyPDFForm.egg-info/entry_points.txt
 PyPDFForm.egg-info/requires.txt
 PyPDFForm.egg-info/top_level.txt
 PyPDFForm/cli/__init__.py
+PyPDFForm/cli/coordinate.py
 PyPDFForm/cli/update.py
 PyPDFForm/lib/__init__.py
 PyPDFForm/lib/adapter.py

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

@@ -2,7 +2,7 @@ cryptography<47.0.0,>=46.0.3
 fonttools<5.0.0,>=4.60.1
 pikepdf<11.0.0,>=10.5.0
 pillow<13.0.0,>=12.0.0
-pypdf<7.0.0,>=6.9.0
+pypdf<6.10.0,>=6.9.0
 reportlab<5.0.0,>=4.4.6
 
 [cli]

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

@@ -29,7 +29,7 @@ dependencies = [
     "fonttools>=4.60.1,<5.0.0",
     "pikepdf>=10.5.0,<11.0.0",
     "pillow>=12.0.0,<13.0.0",
-    "pypdf>=6.9.0,<7.0.0",
+    "pypdf>=6.9.0,<6.10.0", # TODO: revert this
     "reportlab>=4.4.6,<5.0.0",
 ]
 
@@ -139,4 +139,5 @@ include = ["PyPDFForm*"]
 [tool.pytest.ini_options]
 markers = [
     "posix_only", # mainly because of zlib vs zlib-ng
+    "cli_test",
 ]

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

@@ -62,6 +62,21 @@ def test_bulk_create_fields_stress_max(pdf_samples, request):
             obj += PdfWrapper(os.path.join(pdf_samples, "dummy.pdf"))
         obj.bulk_create_fields(fields)
 
+        prefix_to_page = {
+            "text_": 1,
+            "check_": 2,
+            "dropdown_": 3,
+            "radio_": 4,
+            "image_": 5,
+            "signature_": 6,
+        }
+
+        for k, v in obj.widgets.items():
+            for each, page in prefix_to_page.items():
+                if k.startswith(each):
+                    assert v.page_number == page
+                    break
+
         request.config.results["expected_path"] = expected_path
         request.config.results["stream"] = obj.read()
 

{pypdfform-4.7.9 → pypdfform-4.7.10}/tests/test_cli.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+import pytest
 from typer.testing import CliRunner
 
 from PyPDFForm import __version__
@@ -8,15 +9,17 @@ from PyPDFForm.cli import cli_app
 runner = CliRunner()
 
 
+@pytest.mark.cli_test
 def test_root_command():
     result = runner.invoke(cli_app)
     assert result.exit_code == 2
 
-    assert "Welcome to the PyPDFForm CLI!" in result.output
+    assert "PyPDFForm command-line interface." in result.output
     assert "Usage:" in result.output
     assert "main" not in result.output
 
 
+@pytest.mark.cli_test
 def test_root_command_with_version():
     long = runner.invoke(cli_app, ["--version"])
     short = runner.invoke(cli_app, ["-v"])
@@ -28,6 +31,15 @@ def test_root_command_with_version():
     assert long.output == short.output
 
 
+@pytest.mark.cli_test
+def test_coordinate_command():
+    result = runner.invoke(cli_app, ["coordinate"])
+    assert result.exit_code == 2
+
+    assert "Usage:" in result.output
+
+
+@pytest.mark.cli_test
 def test_update_command():
     result = runner.invoke(cli_app, ["update"])
     assert result.exit_code == 2

{pypdfform-4.7.9 → pypdfform-4.7.10}/tests/test_functional.py

@@ -747,31 +747,37 @@ def test_widget_coord_resolution():
         ]
     )
 
+    assert obj.widgets["text"].page_number == 1
     assert obj.widgets["text"].x == 50
     assert obj.widgets["text"].y == 100
     assert obj.widgets["text"].width == 200
     assert obj.widgets["text"].height == 150
 
+    assert obj.widgets["check"].page_number == 1
     assert obj.widgets["check"].x == 150
     assert obj.widgets["check"].y == 200
     assert obj.widgets["check"].width == 60
     assert obj.widgets["check"].height == 60
 
+    assert obj.widgets["radio"].page_number == 1
     assert obj.widgets["radio"].x == [400, 500, 600]
     assert obj.widgets["radio"].y == [450, 550, 650]
     assert obj.widgets["radio"].width == 10
     assert obj.widgets["radio"].height == 10
 
+    assert obj.widgets["dropdown"].page_number == 1
     assert obj.widgets["dropdown"].x == 400
     assert obj.widgets["dropdown"].y == 100
     assert obj.widgets["dropdown"].width == 250
     assert obj.widgets["dropdown"].height == 200
 
+    assert obj.widgets["image"].page_number == 1
     assert obj.widgets["image"].x == 300
     assert obj.widgets["image"].y == 400
     assert obj.widgets["image"].width == 400
     assert obj.widgets["image"].height == 300
 
+    assert obj.widgets["signature"].page_number == 1
     assert obj.widgets["signature"].x == 500
     assert obj.widgets["signature"].y == 600
     assert obj.widgets["signature"].width == 600