PyPDFForm 5.1.1__tar.gz → 5.2.0__tar.gz

{pypdfform-5.1.1 → pypdfform-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 5.1.1
+Version: 5.2.0
 Summary: The Python library & CLI for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -34,9 +34,7 @@ Provides-Extra: cli
 Requires-Dist: typer<1.0.0,>=0.26.1; extra == "cli"
 Requires-Dist: jsonschema<5.0.0,>=4.26.0; extra == "cli"
 Provides-Extra: dev
-Requires-Dist: black<27.0.0,>=26.5.1; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.14.1; extra == "dev"
-Requires-Dist: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
 Requires-Dist: mkdocs<2.0.0,>=1.6.1; extra == "dev"
 Requires-Dist: mkdocs-material<10.0.0,>=9.7.6; extra == "dev"

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/__init__.py

@@ -18,7 +18,7 @@ from Python code or from the command line.
 
 import logging
 
-__version__ = "5.1.1"
+__version__ = "5.2.0"
 
 from .lib.annotations import Annotations
 from .lib.assets.blank import BlankPage

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/cli/common.py

@@ -53,6 +53,13 @@ OPTIONAL_OUTPUT_PDF = Annotated[
     ),
 ]
 FIELD_NAME = Annotated[str, typer.Option("--field", help="Form field name.")]
+FIELD_NAMES = Annotated[
+    list[str],
+    typer.Option(
+        "--field",
+        help="Form field name. Repeat this option to select multiple fields.",
+    ),
+]
 
 
 def json_file_option(help_text: str):

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/cli/create.py

@@ -14,11 +14,15 @@ from typing import Annotated
 
 import typer
 
-from .. import (Annotations, BlankPage, Fields, PdfArray, PdfWrapper,
-                RawElements)
-from .common import (INPUT_PDF, OPTIONAL_OUTPUT_PDF, REQUIRED_OUTPUT_PDF,
-                     cli_bad_parameter, create_elements_from_file,
-                     json_file_option)
+from .. import Annotations, BlankPage, Fields, PdfArray, PdfWrapper, RawElements
+from .common import (
+    INPUT_PDF,
+    OPTIONAL_OUTPUT_PDF,
+    REQUIRED_OUTPUT_PDF,
+    cli_bad_parameter,
+    create_elements_from_file,
+    json_file_option,
+)
 from .schemas.create import ANNOTATION_SCHEMA, FIELD_SCHEMA, RAW_SCHEMA
 
 create_cli = typer.Typer(

pypdfform-5.2.0/PyPDFForm/cli/remove.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+"""
+This module defines CLI commands for removing PDF form content.
+
+It exposes the `remove` command group for deleting existing form fields.
+Commands in this module load the target PDF, validate requested form field
+names, apply the matching `PdfWrapper` operation, and write the modified PDF to
+either the requested output path or the original file.
+"""
+
+import typer
+
+from .. import PdfWrapper
+from .common import FIELD_NAMES, INPUT_PDF, OPTIONAL_OUTPUT_PDF, get_widget
+
+remove_cli = typer.Typer(
+    context_settings={"help_option_names": ["--help", "-h"]}, no_args_is_help=True
+)
+
+
+@remove_cli.command(no_args_is_help=True)
+def field(
+    ctx: typer.Context,
+    pdf: INPUT_PDF,
+    fields: FIELD_NAMES,
+    output: OPTIONAL_OUTPUT_PDF = None,
+) -> None:
+    """Remove form fields from a PDF."""
+    obj = PdfWrapper(str(pdf), **ctx.obj)
+    for field_name in fields:
+        get_widget(obj, field_name, "--field")
+
+    obj.remove_fields(fields).write(output or pdf)

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/cli/root.py

@@ -2,16 +2,17 @@
 """
 This module defines the root command-line interface for PyPDFForm.
 
-It creates the Typer application, attaches the `create`, `inspect`, and `update`
-command groups, and exposes top-level options shared by those commands. The root
-callback collects global flags in the Typer context so each subcommand can
-initialize `PdfWrapper` with consistent settings.
+It creates the Typer application, attaches the `create`, `inspect`, `update`,
+and `remove` command groups, and exposes top-level options shared by those
+commands. The root callback collects global flags in the Typer context so each
+subcommand can initialize `PdfWrapper` with consistent settings.
 
 Commands:
     - `fill`: Fill an existing PDF form from JSON data.
     - `create`: Create PDFs, fields, annotations, raw elements, and grid views.
     - `inspect`: Print form metadata and field data as JSON.
     - `update`: Modify PDF metadata, field names, properties, geometry, and scripts.
+    - `remove`: Remove PDF form fields.
 """
 
 from pathlib import Path
@@ -20,10 +21,10 @@ from typing import Annotated
 import typer
 
 from .. import PdfWrapper, Widgets, __version__
-from .common import (INPUT_PDF, OPTIONAL_OUTPUT_PDF, json_file_option,
-                     load_json_file)
+from .common import INPUT_PDF, OPTIONAL_OUTPUT_PDF, json_file_option, load_json_file
 from .create import create_cli
 from .inspect import inspect_cli
+from .remove import remove_cli
 from .update import update_cli
 
 cli_app = typer.Typer(
@@ -44,6 +45,11 @@ cli_app.add_typer(
     name="update",
     help="Update PDF metadata, fields, and scripts.",
 )
+cli_app.add_typer(
+    remove_cli,
+    name="remove",
+    help="Remove PDF form content.",
+)
 
 
 def version_callback(value: bool) -> None:
@@ -68,7 +74,7 @@ def version_callback(value: bool) -> None:
 
 @cli_app.callback(
     invoke_without_command=True,
-    help="Create, fill, inspect, and update PDF forms.",
+    help="Work with PDF forms from the command line.",
 )
 def main(
     ctx: typer.Context,
@@ -111,7 +117,7 @@ def main(
         ),
     ] = False,
 ) -> None:
-    """Create, fill, inspect, and update PDF forms."""
+    """Work with PDF forms from the command line."""
     ctx.obj = {
         "need_appearances": need_appearances,
         "generate_appearance_streams": generate_appearance_streams,

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/cli/update.py

@@ -17,9 +17,16 @@ import typer
 
 from .. import PdfWrapper
 from ..lib.constants import PdfVersion
-from .common import (FIELD_NAME, INPUT_PDF, OPTIONAL_OUTPUT_PDF,
-                     cli_bad_parameter, get_widget, handle_font_registration,
-                     json_file_option, load_json_file)
+from .common import (
+    FIELD_NAME,
+    INPUT_PDF,
+    OPTIONAL_OUTPUT_PDF,
+    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(

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/annotations/__init__.py

@@ -14,8 +14,12 @@ from dataclasses import dataclass
 from .link import LinkAnnotation
 from .stamp import RubberStampAnnotation
 from .text import TextAnnotation
-from .text_markup import (HighlightAnnotation, SquigglyAnnotation,
-                          StrikeOutAnnotation, UnderlineAnnotation)
+from .text_markup import (
+    HighlightAnnotation,
+    SquigglyAnnotation,
+    StrikeOutAnnotation,
+    UnderlineAnnotation,
+)
 
 AnnotationTypes = (
     TextAnnotation

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/annotations/base.py

@@ -11,8 +11,13 @@ Classes:
 
 from dataclasses import dataclass
 
-from pypdf.generic import (ArrayObject, DictionaryObject, FloatObject,
-                           NameObject, TextStringObject)
+from pypdf.generic import (
+    ArrayObject,
+    DictionaryObject,
+    FloatObject,
+    NameObject,
+    TextStringObject,
+)
 
 from ..constants import Annot, Contents, Rect, Subtype, Type
 

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/annotations/link.py

@@ -12,8 +12,13 @@ Classes:
 from dataclasses import dataclass
 from typing import Optional
 
-from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
-                           NumberObject, TextStringObject)
+from pypdf.generic import (
+    ArrayObject,
+    DictionaryObject,
+    NameObject,
+    NumberObject,
+    TextStringObject,
+)
 
 from ..constants import A, S
 from .base import Annotation

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/egress.py

@@ -17,8 +17,7 @@ from pikepdf import Pdf
 from pypdf import PdfReader, PdfWriter
 from pypdf.generic import DictionaryObject, NameObject, TextStringObject
 
-from .constants import (JS, XFA, AcroForm, JavaScript, OpenAction, Root, S,
-                        Title)
+from .constants import JS, XFA, AcroForm, JavaScript, OpenAction, Root, S, Title
 
 
 @lru_cache

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/filler.py

@@ -24,9 +24,13 @@ from .middleware.image import Image
 from .middleware.radio import Radio
 from .middleware.signature import Signature
 from .middleware.text import Text
-from .patterns import (get_widget_key, update_checkbox_value,
-                       update_dropdown_value, update_radio_value,
-                       update_text_value)
+from .patterns import (
+    get_widget_key,
+    update_checkbox_value,
+    update_dropdown_value,
+    update_radio_value,
+    update_text_value,
+)
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
 
 

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/font.py

@@ -16,20 +16,52 @@ from zlib import compress
 
 from fontTools.ttLib import TTFont as FT_TTFont
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import (ArrayObject, DictionaryObject, FloatObject,
-                           NameObject, NumberObject, StreamObject)
+from pypdf.generic import (
+    ArrayObject,
+    DictionaryObject,
+    FloatObject,
+    NameObject,
+    NumberObject,
+    StreamObject,
+)
 from reportlab.pdfbase.pdfmetrics import _fonts
 from reportlab.pdfbase.ttfonts import TTFError, TTFont
 
 from .assets.blank import BlankPage
-from .constants import (DEFAULT_ASSUMED_GLYPH_WIDTH, DR, EM_TO_PDF_FACTOR,
-                        ENCODING_TABLE_SIZE, FIRST_CHAR_CODE, FONT_NAME_PREFIX,
-                        LAST_CHAR_CODE, AcroForm, BaseFont, Encoding, Fields,
-                        Filter, FirstChar, FlateDecode, Font, FontCmap,
-                        FontDescriptor, FontFile2, FontHead, FontHmtx,
-                        FontName, FontNotdef, LastChar, Length, Length1,
-                        MissingWidth, Resources, Subtype, TrueType, Type,
-                        Widths, WinAnsiEncoding)
+from .constants import (
+    DEFAULT_ASSUMED_GLYPH_WIDTH,
+    DR,
+    EM_TO_PDF_FACTOR,
+    ENCODING_TABLE_SIZE,
+    FIRST_CHAR_CODE,
+    FONT_NAME_PREFIX,
+    LAST_CHAR_CODE,
+    AcroForm,
+    BaseFont,
+    Encoding,
+    Fields,
+    Filter,
+    FirstChar,
+    FlateDecode,
+    Font,
+    FontCmap,
+    FontDescriptor,
+    FontFile2,
+    FontHead,
+    FontHmtx,
+    FontName,
+    FontNotdef,
+    LastChar,
+    Length,
+    Length1,
+    MissingWidth,
+    Resources,
+    Subtype,
+    TrueType,
+    Type,
+    Widths,
+    WinAnsiEncoding,
+)
 from .raw.text import RawText
 from .watermark import create_watermarks_and_draw
 
@@ -287,7 +319,9 @@ def register_font_acroform(
     font_dict_ref = writer._add_object(font_dict)  # type: ignore # noqa: SLF001 # # pylint: disable=W0212
 
     if AcroForm not in writer._root_object:  # type: ignore # noqa: SLF001 # # pylint: disable=W0212
-        writer._root_object[NameObject(AcroForm)] = DictionaryObject({NameObject(Fields): ArrayObject([])})  # type: ignore # noqa: SLF001 # # pylint: disable=W0212
+        writer._root_object[NameObject(AcroForm)] = DictionaryObject(  # type: ignore # noqa: SLF001 # pylint: disable=W0212
+            {NameObject(Fields): ArrayObject([])}
+        )
     acroform = writer._root_object[AcroForm]  # type: ignore # noqa: SLF001 # # pylint: disable=W0212
 
     if DR not in acroform:

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/hooks.py

@@ -14,15 +14,47 @@ from io import BytesIO
 from typing import TextIO, cast
 
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import (ArrayObject, DictionaryObject, FloatObject,
-                           NameObject, NumberObject, TextStringObject)
+from pypdf.generic import (
+    ArrayObject,
+    DictionaryObject,
+    FloatObject,
+    NameObject,
+    NumberObject,
+    TextStringObject,
+)
 
 from .adapter import fp_or_f_obj_or_f_content_to_content
-from .constants import (AA, COMB, DA, FONT_COLOR_IDENTIFIER,
-                        FONT_SIZE_IDENTIFIER, HIDDEN, JS, MULTILINE, READ_ONLY,
-                        REQUIRED, TU, Action, Annots, Bl, D, E, F, Ff, Fo,
-                        JavaScript, MaxLen, Opt, Parent, Q, Rect, S, Type, U,
-                        X)
+from .constants import (
+    AA,
+    COMB,
+    DA,
+    FONT_COLOR_IDENTIFIER,
+    FONT_SIZE_IDENTIFIER,
+    HIDDEN,
+    JS,
+    MULTILINE,
+    READ_ONLY,
+    REQUIRED,
+    TU,
+    Action,
+    Annots,
+    Bl,
+    D,
+    E,
+    F,
+    Ff,
+    Fo,
+    JavaScript,
+    MaxLen,
+    Opt,
+    Parent,
+    Q,
+    Rect,
+    S,
+    Type,
+    U,
+    X,
+)
 from .patterns import get_widget_key
 
 

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/patterns.py

@@ -10,12 +10,45 @@ for updating these widgets.
 
 from typing import Tuple
 
-from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
-                           NumberObject, TextStringObject)
-
-from .constants import (AP, AS, DV, FT, HIDDEN, IMAGE_FIELD_IDENTIFIER, JS,
-                        SLASH, TU, A, Btn, Ch, F, Ff, I, MaxLen, N, Off, Opt,
-                        Parent, Q, Rect, Sig, Subtype, T, Tx, V, Widget, Yes)
+from pypdf.generic import (
+    ArrayObject,
+    DictionaryObject,
+    NameObject,
+    NumberObject,
+    TextStringObject,
+)
+
+from .constants import (
+    AP,
+    AS,
+    DV,
+    FT,
+    HIDDEN,
+    IMAGE_FIELD_IDENTIFIER,
+    JS,
+    SLASH,
+    TU,
+    A,
+    Btn,
+    Ch,
+    F,
+    Ff,
+    I,
+    MaxLen,
+    N,
+    Off,
+    Opt,
+    Parent,
+    Q,
+    Rect,
+    Sig,
+    Subtype,
+    T,
+    Tx,
+    V,
+    Widget,
+    Yes,
+)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/template.py

@@ -22,12 +22,22 @@ from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.radio import Radio
 from .middleware.text import Text
-from .patterns import (WIDGET_DESCRIPTION_PATTERNS, WIDGET_TYPE_PATTERNS,
-                       check_field_flag, get_checkbox_value,
-                       get_dropdown_choices, get_dropdown_value,
-                       get_field_hidden, get_field_rect, get_radio_value,
-                       get_text_field_alignment, get_text_field_max_length,
-                       get_text_value, get_widget_key, update_annotation_name)
+from .patterns import (
+    WIDGET_DESCRIPTION_PATTERNS,
+    WIDGET_TYPE_PATTERNS,
+    check_field_flag,
+    get_checkbox_value,
+    get_dropdown_choices,
+    get_dropdown_value,
+    get_field_hidden,
+    get_field_rect,
+    get_radio_value,
+    get_text_field_alignment,
+    get_text_field_max_length,
+    get_text_value,
+    get_widget_key,
+    update_annotation_name,
+)
 from .utils import extract_widget_property, find_pattern_match
 
 
@@ -366,6 +376,51 @@ def create_annotations(
         return f.read()
 
 
+def remove_widgets_by_keys(
+    pdf: bytes, keys: List[str], use_full_widget_name: bool = False
+) -> bytes:
+    """
+    Removes specific widgets from a PDF by their keys.
+
+    This function removes any widget annotation whose key matches one of the
+    provided keys. If no keys are provided, the original PDF stream is returned
+    unchanged.
+
+    Args:
+        pdf (bytes): The PDF stream to remove widgets from.
+        keys (List[str]): A list of widget keys to remove.
+        use_full_widget_name (bool): Whether to match widgets by their full
+            names, including parent names.
+
+    Returns:
+        bytes: The updated PDF stream with the matching widgets removed.
+    """
+    if not keys:
+        return pdf
+
+    writer = PdfWriter(BytesIO(pdf))
+
+    for page in writer.pages:
+        needs_update = False
+        page_annots = ArrayObject([])
+
+        for annot in page.get(Annots, []):
+            annot = cast(DictionaryObject, annot.get_object())
+            key = get_widget_key(annot.get_object(), use_full_widget_name)
+            if key not in keys:
+                page_annots.append(annot)
+            else:
+                needs_update = True
+
+        if needs_update:
+            page[NameObject(Annots)] = page_annots
+
+    with BytesIO() as f:
+        writer.write(f)
+        f.seek(0)
+        return f.read()
+
+
 def update_widget_keys(
     template: bytes,
     widgets: Dict[str, WIDGET_TYPES],

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/widgets/signature.py

@@ -19,8 +19,7 @@ from io import BytesIO
 from typing import List, Optional, Type
 
 from pypdf import PdfReader, PdfWriter
-from pypdf.generic import (ArrayObject, FloatObject, NameObject,
-                           TextStringObject)
+from pypdf.generic import ArrayObject, FloatObject, NameObject, TextStringObject
 from reportlab.pdfgen.canvas import Canvas
 
 from ..assets.bedrock import BEDROCK_PDF

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm/lib/wrapper.py

@@ -22,30 +22,61 @@ from collections import defaultdict
 from dataclasses import asdict
 from functools import cached_property
 from os import PathLike
-from typing import (TYPE_CHECKING, BinaryIO, Dict, Optional, Sequence, TextIO,
-                    Tuple)
-
-from .adapter import (fp_or_f_obj_or_f_content_to_content,
-                      fp_or_f_obj_or_stream_to_stream)
+from typing import (
+    TYPE_CHECKING,
+    BinaryIO,
+    Dict,
+    List,
+    Optional,
+    Sequence,
+    TextIO,
+    Tuple,
+)
+
+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 .egress import appearance_streams_handler, preserve_pdf_properties
 from .filler import fill
-from .font import (get_all_available_fonts, register_font_acroform,
-                   temporary_font_registration, validate_font)
+from .font import (
+    get_all_available_fonts,
+    register_font_acroform,
+    temporary_font_registration,
+    validate_font,
+)
 from .hooks import trigger_widget_hooks
 from .middleware.dropdown import Dropdown
 from .middleware.signature import Signature
 from .middleware.text import Text
-from .template import (build_widgets, create_annotations, get_metadata,
-                       update_widget_keys)
+from .template import (
+    build_widgets,
+    create_annotations,
+    get_metadata,
+    remove_widgets_by_keys,
+    update_widget_keys,
+)
 from .types import PdfArray
-from .utils import (generate_unique_suffix, get_page_streams, merge_pdfs,
-                    remove_all_widgets)
-from .watermark import (copy_watermark_widgets, create_watermarks_and_draw,
-                        merge_watermarks_with_pdf)
-from .widgets import (CheckBoxField, DropdownField, ImageField, RadioGroup,
-                      SignatureField)
+from .utils import (
+    generate_unique_suffix,
+    get_page_streams,
+    merge_pdfs,
+    remove_all_widgets,
+)
+from .watermark import (
+    copy_watermark_widgets,
+    create_watermarks_and_draw,
+    merge_watermarks_with_pdf,
+)
+from .widgets import (
+    CheckBoxField,
+    DropdownField,
+    ImageField,
+    RadioGroup,
+    SignatureField,
+)
 
 if TYPE_CHECKING:
     from .annotations import AnnotationTypes
@@ -665,6 +696,27 @@ class PdfWrapper:
 
         return self
 
+    def remove_fields(self, keys: List[str]) -> PdfWrapper:
+        """
+        Removes form fields from the PDF by their keys.
+
+        This method removes any fields whose keys are included in `keys` and
+        refreshes the wrapper's widget metadata after the PDF stream is updated.
+
+        Args:
+            keys (List[str]): A list of form field keys to remove.
+
+        Returns:
+            PdfWrapper: The `PdfWrapper` object, allowing for method chaining.
+        """
+
+        self._stream = remove_widgets_by_keys(
+            self._read(), keys, getattr(self, "use_full_widget_name")
+        )
+        self._init_helper()
+
+        return self
+
     def update_widget_key(
         self, old_key: str, new_key: str, index: int = 0
     ) -> PdfWrapper:

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 5.1.1
+Version: 5.2.0
 Summary: The Python library & CLI for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -34,9 +34,7 @@ Provides-Extra: cli
 Requires-Dist: typer<1.0.0,>=0.26.1; extra == "cli"
 Requires-Dist: jsonschema<5.0.0,>=4.26.0; extra == "cli"
 Provides-Extra: dev
-Requires-Dist: black<27.0.0,>=26.5.1; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.14.1; extra == "dev"
-Requires-Dist: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
 Requires-Dist: mkdocs<2.0.0,>=1.6.1; extra == "dev"
 Requires-Dist: mkdocs-material<10.0.0,>=9.7.6; extra == "dev"

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ PyPDFForm/cli/common.py
 PyPDFForm/cli/create.py
 PyPDFForm/cli/entry.py
 PyPDFForm/cli/inspect.py
+PyPDFForm/cli/remove.py
 PyPDFForm/cli/root.py
 PyPDFForm/cli/update.py
 PyPDFForm/cli/schemas/__init__.py

{pypdfform-5.1.1 → pypdfform-5.2.0}/PyPDFForm.egg-info/requires.txt

@@ -10,9 +10,7 @@ typer<1.0.0,>=0.26.1
 jsonschema<5.0.0,>=4.26.0
 
 [dev]
-black<27.0.0,>=26.5.1
 coverage<8.0.0,>=7.14.1
-isort<9.0.0,>=8.0.1
 mike<3.0.0,>=2.2.0
 mkdocs<2.0.0,>=1.6.1
 mkdocs-material<10.0.0,>=9.7.6

{pypdfform-5.1.1 → pypdfform-5.2.0}/pyproject.toml

@@ -45,9 +45,7 @@ Documentation = "https://chinapandaman.github.io/PyPDFForm/"
 # update `CLI_DEPENDENCIES` in `PyPDFForm/cli/entry.py` when changing cli dependencies
 cli = ["typer>=0.26.1,<1.0.0", "jsonschema>=4.26.0,<5.0.0"]
 dev = [
-    "black>=26.5.1,<27.0.0",
     "coverage>=7.14.1,<8.0.0",
-    "isort>=8.0.1,<9.0.0",
     "mike>=2.2.0,<3.0.0",
     "mkdocs>=1.6.1,<2.0.0",
     "mkdocs-material>=9.7.6,<10.0.0",

{pypdfform-5.1.1 → pypdfform-5.2.0}/tests/test_font_widths.py

@@ -13,9 +13,16 @@ from fontTools.ttLib import TTLibError
 from pypdf import PdfWriter
 
 from PyPDFForm import PdfWrapper
-from PyPDFForm.lib.constants import (DEFAULT_ASSUMED_GLYPH_WIDTH, DR,
-                                     ENCODING_TABLE_SIZE, AcroForm, Font,
-                                     FontDescriptor, MissingWidth, Widths)
+from PyPDFForm.lib.constants import (
+    DEFAULT_ASSUMED_GLYPH_WIDTH,
+    DR,
+    ENCODING_TABLE_SIZE,
+    AcroForm,
+    Font,
+    FontDescriptor,
+    MissingWidth,
+    Widths,
+)
 from PyPDFForm.lib.font import compute_font_glyph_widths
 
 

{pypdfform-5.1.1 → pypdfform-5.2.0}/tests/test_functional.py

@@ -834,6 +834,19 @@ def test_hidden_sejda(sejda_template, pdf_samples, request):
         assert obj.read() == expected
 
 
+def test_remove_fields_update_widgets(template_stream):
+    obj = PdfWrapper(template_stream)
+    obj.remove_fields(["test", "test_2", "check_2"])
+
+    assert "test" not in obj.widgets
+    assert "test_2" not in obj.widgets
+    assert "check_2" not in obj.widgets
+
+
+def test_remove_fields_no_keys_specified(template_stream):
+    assert PdfWrapper(template_stream).remove_fields([]).read() == template_stream
+
+
 def test_merge(template_stream):
     pdf_list = PdfArray()
     for i in range(20):

{pypdfform-5.1.1 → pypdfform-5.2.0}/tests/test_js.py

@@ -44,25 +44,25 @@ def test_text_field_scripts(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "js", "test_text_field_scripts.pdf")
     with open(expected_path, "rb+") as f:
         pdf = PdfWrapper(template_stream)
-        pdf.widgets["test"].on_hovered_over_javascript = (
-            'this.getField("test").value = "hoverover";'
-        )
-        pdf.widgets["test"].on_hovered_off_javascript = (
-            'this.getField("test").value = "hoveroff";'
-        )
-        pdf.widgets["test"].on_mouse_pressed_javascript = (
-            'this.getField("test").value = "pressed";'
-        )
-        pdf.widgets["test"].on_mouse_released_javascript = (
-            'this.getField("test").value = "released";'
-        )
-
-        pdf.widgets["test_2"].on_focused_javascript = (
-            'this.getField("test_2").value = "focused";'
-        )
-        pdf.widgets["test_2"].on_blurred_javascript = (
-            'this.getField("test_2").value = "defocused";'
-        )
+        pdf.widgets[
+            "test"
+        ].on_hovered_over_javascript = 'this.getField("test").value = "hoverover";'
+        pdf.widgets[
+            "test"
+        ].on_hovered_off_javascript = 'this.getField("test").value = "hoveroff";'
+        pdf.widgets[
+            "test"
+        ].on_mouse_pressed_javascript = 'this.getField("test").value = "pressed";'
+        pdf.widgets[
+            "test"
+        ].on_mouse_released_javascript = 'this.getField("test").value = "released";'
+
+        pdf.widgets[
+            "test_2"
+        ].on_focused_javascript = 'this.getField("test_2").value = "focused";'
+        pdf.widgets[
+            "test_2"
+        ].on_blurred_javascript = 'this.getField("test_2").value = "defocused";'
 
         request.config.results["expected_path"] = expected_path
         request.config.results["stream"] = pdf.read()
@@ -77,25 +77,25 @@ def test_checkbox_scripts(template_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "js", "test_checkbox_scripts.pdf")
     with open(expected_path, "rb+") as f:
         pdf = PdfWrapper(template_stream)
-        pdf.widgets["check"].on_hovered_over_javascript = (
-            'this.getField("test").value = "hoverover";'
-        )
-        pdf.widgets["check"].on_hovered_off_javascript = (
-            'this.getField("test").value = "hoveroff";'
-        )
-        pdf.widgets["check"].on_mouse_pressed_javascript = (
-            'this.getField("test").value = "pressed";'
-        )
-        pdf.widgets["check"].on_mouse_released_javascript = (
-            'this.getField("test").value = "released";'
-        )
-
-        pdf.widgets["check_2"].on_focused_javascript = (
-            'this.getField("test_2").value = "focused";'
-        )
-        pdf.widgets["check_2"].on_blurred_javascript = (
-            'this.getField("test_2").value = "defocused";'
-        )
+        pdf.widgets[
+            "check"
+        ].on_hovered_over_javascript = 'this.getField("test").value = "hoverover";'
+        pdf.widgets[
+            "check"
+        ].on_hovered_off_javascript = 'this.getField("test").value = "hoveroff";'
+        pdf.widgets[
+            "check"
+        ].on_mouse_pressed_javascript = 'this.getField("test").value = "pressed";'
+        pdf.widgets[
+            "check"
+        ].on_mouse_released_javascript = 'this.getField("test").value = "released";'
+
+        pdf.widgets[
+            "check_2"
+        ].on_focused_javascript = 'this.getField("test_2").value = "focused";'
+        pdf.widgets[
+            "check_2"
+        ].on_blurred_javascript = 'this.getField("test_2").value = "defocused";'
 
         request.config.results["expected_path"] = expected_path
         request.config.results["stream"] = pdf.read()
@@ -110,25 +110,25 @@ def test_radio_scripts(template_with_radiobutton_stream, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "js", "test_radio_scripts.pdf")
     with open(expected_path, "rb+") as f:
         pdf = PdfWrapper(template_with_radiobutton_stream)
-        pdf.widgets["radio_1"].on_hovered_over_javascript = (
-            'this.getField("test").value = "hoverover";'
-        )
-        pdf.widgets["radio_1"].on_hovered_off_javascript = (
-            'this.getField("test").value = "hoveroff";'
-        )
-        pdf.widgets["radio_1"].on_mouse_pressed_javascript = (
-            'this.getField("test").value = "pressed";'
-        )
-        pdf.widgets["radio_1"].on_mouse_released_javascript = (
-            'this.getField("test").value = "released";'
-        )
-
-        pdf.widgets["radio_2"].on_focused_javascript = (
-            'this.getField("test_2").value = "focused";'
-        )
-        pdf.widgets["radio_2"].on_blurred_javascript = (
-            'this.getField("test_2").value = "defocused";'
-        )
+        pdf.widgets[
+            "radio_1"
+        ].on_hovered_over_javascript = 'this.getField("test").value = "hoverover";'
+        pdf.widgets[
+            "radio_1"
+        ].on_hovered_off_javascript = 'this.getField("test").value = "hoveroff";'
+        pdf.widgets[
+            "radio_1"
+        ].on_mouse_pressed_javascript = 'this.getField("test").value = "pressed";'
+        pdf.widgets[
+            "radio_1"
+        ].on_mouse_released_javascript = 'this.getField("test").value = "released";'
+
+        pdf.widgets[
+            "radio_2"
+        ].on_focused_javascript = 'this.getField("test_2").value = "focused";'
+        pdf.widgets[
+            "radio_2"
+        ].on_blurred_javascript = 'this.getField("test_2").value = "defocused";'
 
         request.config.results["expected_path"] = expected_path
         request.config.results["stream"] = pdf.read()
@@ -143,25 +143,25 @@ def test_dropdown_scripts(sample_template_with_dropdown, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "js", "test_dropdown_scripts.pdf")
     with open(expected_path, "rb+") as f:
         pdf = PdfWrapper(sample_template_with_dropdown)
-        pdf.widgets["dropdown_1"].on_hovered_over_javascript = (
-            'this.getField("test_1").value = "hoverover";'
-        )
-        pdf.widgets["dropdown_1"].on_hovered_off_javascript = (
-            'this.getField("test_1").value = "hoveroff";'
-        )
-        pdf.widgets["dropdown_1"].on_mouse_pressed_javascript = (
-            'this.getField("test_1").value = "pressed";'
-        )
-        pdf.widgets["dropdown_1"].on_mouse_released_javascript = (
-            'this.getField("test_1").value = "released";'
-        )
-
-        pdf.widgets["dropdown_1"].on_focused_javascript = (
-            'this.getField("test_2").value = "focused";'
-        )
-        pdf.widgets["dropdown_1"].on_blurred_javascript = (
-            'this.getField("test_2").value = "defocused";'
-        )
+        pdf.widgets[
+            "dropdown_1"
+        ].on_hovered_over_javascript = 'this.getField("test_1").value = "hoverover";'
+        pdf.widgets[
+            "dropdown_1"
+        ].on_hovered_off_javascript = 'this.getField("test_1").value = "hoveroff";'
+        pdf.widgets[
+            "dropdown_1"
+        ].on_mouse_pressed_javascript = 'this.getField("test_1").value = "pressed";'
+        pdf.widgets[
+            "dropdown_1"
+        ].on_mouse_released_javascript = 'this.getField("test_1").value = "released";'
+
+        pdf.widgets[
+            "dropdown_1"
+        ].on_focused_javascript = 'this.getField("test_2").value = "focused";'
+        pdf.widgets[
+            "dropdown_1"
+        ].on_blurred_javascript = 'this.getField("test_2").value = "defocused";'
 
         request.config.results["expected_path"] = expected_path
         request.config.results["stream"] = pdf.read()
@@ -176,25 +176,25 @@ def test_image_scripts(sample_template_with_image_field, pdf_samples, request):
     expected_path = os.path.join(pdf_samples, "js", "test_image_scripts.pdf")
     with open(expected_path, "rb+") as f:
         pdf = PdfWrapper(sample_template_with_image_field)
-        pdf.widgets["image_1"].on_hovered_over_javascript = (
-            'this.getField("test").value = "hoverover";'
-        )
-        pdf.widgets["image_1"].on_hovered_off_javascript = (
-            'this.getField("test").value = "hoveroff";'
-        )
-        pdf.widgets["image_1"].on_mouse_pressed_javascript = (
-            'this.getField("test").value = "pressed";'
-        )
-        pdf.widgets["image_1"].on_mouse_released_javascript = (
-            'this.getField("test").value = "released";'
-        )
-
-        pdf.widgets["image_1"].on_focused_javascript = (
-            'this.getField("test_2").value = "focused";'
-        )
-        pdf.widgets["image_1"].on_blurred_javascript = (
-            'this.getField("test_2").value = "defocused";'
-        )
+        pdf.widgets[
+            "image_1"
+        ].on_hovered_over_javascript = 'this.getField("test").value = "hoverover";'
+        pdf.widgets[
+            "image_1"
+        ].on_hovered_off_javascript = 'this.getField("test").value = "hoveroff";'
+        pdf.widgets[
+            "image_1"
+        ].on_mouse_pressed_javascript = 'this.getField("test").value = "pressed";'
+        pdf.widgets[
+            "image_1"
+        ].on_mouse_released_javascript = 'this.getField("test").value = "released";'
+
+        pdf.widgets[
+            "image_1"
+        ].on_focused_javascript = 'this.getField("test_2").value = "focused";'
+        pdf.widgets[
+            "image_1"
+        ].on_blurred_javascript = 'this.getField("test_2").value = "defocused";'
 
         request.config.results["expected_path"] = expected_path
         request.config.results["stream"] = pdf.read()

{pypdfform-5.1.1 → pypdfform-5.2.0}/tests/test_use_full_widget_name.py

@@ -45,3 +45,11 @@ def test_schema(sample_template_with_full_key):
     obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
     assert "Gain de 2 classes.0" in obj.schema["properties"]
     assert "0" not in obj.schema
+
+
+def test_remove_fields(sample_template_with_full_key):
+    obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
+    obj.remove_fields(["Gain de 2 classes.0"])
+
+    assert "Gain de 2 classes.0" not in obj.widgets
+    assert "0" not in obj.widgets