PyPDFForm 4.6.2__tar.gz → 4.7.0__tar.gz

{pypdfform-4.6.2 → pypdfform-4.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.6.2
+Version: 4.7.0
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -31,6 +31,8 @@ Requires-Dist: black<27.0.0,>=25.11.0; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.12.0; extra == "dev"
 Requires-Dist: isort<9.0.0,>=7.0.0; extra == "dev"
 Requires-Dist: jsonschema<5.0.0,>=4.25.1; extra == "dev"
+Requires-Dist: mike<3.0.0,>=2.1.3; extra == "dev"
+Requires-Dist: mkdocs<2.0.0,>=1.6.1; extra == "dev"
 Requires-Dist: mkdocs-material<10.0.0,>=9.7.0; extra == "dev"
 Requires-Dist: pudb<2026.0.0,>=2025.1.3; extra == "dev"
 Requires-Dist: pylint<5.0.0,>=4.0.3; extra == "dev"
@@ -48,7 +50,7 @@ Dynamic: license-file
     <a href="https://pypi.org/project/PyPDFForm/"><img src="https://img.shields.io/pypi/v/pypdfform?label=version&color=magenta"></a>
     <a href="https://chinapandaman.github.io/PyPDFForm/"><img src="https://img.shields.io/github/v/release/chinapandaman/pypdfform?label=docs&color=cyan"></a>
     <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
-    <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
+    <a href="https://github.com/chinapandaman/PyPDFForm/blob/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
     <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
 </p>
@@ -102,6 +104,7 @@ The official documentation can be found on [the GitHub page](https://chinapandam
 
 ## Other Resources
 
+<!-- TODO: remove WIP when finish recording -->
 * [(WIP) Video Tutorials](https://youtube.com/playlist?list=PLNz_PBu1QA-gzYg5BvyOO98q15u5Xve1L&si=8MWasKEckBzY-NRQ)
 * [Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)
 

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/__init__.py

@@ -20,7 +20,7 @@ The library supports various PDF form features, including:
 PyPDFForm aims to simplify PDF form manipulation, making it accessible to developers of all skill levels.
 """
 
-__version__ = "4.6.2"
+__version__ = "4.7.0"
 
 from .annotations import Annotations
 from .assets.blank import BlankPage

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/annotations/__init__.py

@@ -12,6 +12,7 @@ annotations, facilitating their creation and manipulation within PDF documents.
 from dataclasses import dataclass
 
 from .link import LinkAnnotation
+from .stamp import RubberStampAnnotation
 from .text import TextAnnotation
 from .text_markup import (HighlightAnnotation, SquigglyAnnotation,
                           StrikeOutAnnotation, UnderlineAnnotation)
@@ -23,6 +24,7 @@ AnnotationTypes = (
     | UnderlineAnnotation
     | SquigglyAnnotation
     | StrikeOutAnnotation
+    | RubberStampAnnotation
 )
 
 
@@ -41,3 +43,4 @@ class Annotations:
     UnderlineAnnotation = UnderlineAnnotation
     SquigglyAnnotation = SquigglyAnnotation
     StrikeOutAnnotation = StrikeOutAnnotation
+    RubberStampAnnotation = RubberStampAnnotation

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/annotations/link.py

@@ -4,7 +4,7 @@
 This module defines the class for link annotations in PyPDFForm.
 
 It provides a structure for representing and interacting with PDF link
-annotations, which allow users to click and navigate to a URI.
+annotations, which allow users to click and navigate to a URI or an internal page.
 
 Classes:
     - `LinkAnnotation`: A dataclass representing the properties of a PDF link annotation.
@@ -13,7 +13,8 @@ Classes:
 from dataclasses import dataclass
 from typing import Optional
 
-from pypdf.generic import DictionaryObject, NameObject, TextStringObject
+from pypdf.generic import (ArrayObject, DictionaryObject, NameObject,
+                           NumberObject, TextStringObject)
 
 from ..constants import A, S
 from .base import Annotation
@@ -25,21 +26,24 @@ class LinkAnnotation(Annotation):
     A dataclass representing the properties of a PDF link annotation.
 
     This class extends the `Annotation` base class to specifically handle
-    link annotations, including the target URI.
+    link annotations, including the target URI or an internal page.
 
     Attributes:
         uri (str): The URI that the link annotation points to. Defaults to None.
+        page (int): The 1-based page number that the link annotation points to. Defaults to None.
     """
 
     _annotation_type: str = "/Link"
 
     uri: Optional[str] = None
+    page: Optional[int] = None
 
     def get_specific_properties(self) -> dict:
         """
         Gets properties specific to the link annotation.
 
-        This method extends the base properties with the URI action.
+        This method extends the base properties with either a URI action
+        or a destination for an internal page link.
 
         Returns:
             dict: A dictionary of PDF properties specific to the link annotation.
@@ -52,5 +56,9 @@ class LinkAnnotation(Annotation):
                     NameObject("/URI"): TextStringObject(self.uri),
                 }
             )
+        elif self.page is not None:
+            result[NameObject("/Dest")] = ArrayObject(
+                [NumberObject(self.page - 1), NameObject("/Fit")]
+            )
 
         return result

pypdfform-4.7.0/PyPDFForm/annotations/stamp.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+"""
+This module defines the `RubberStampAnnotation` class, which is used to represent
+a rubber stamp annotation in a PDF document.
+
+The `RubberStampAnnotation` class encapsulates the properties of a rubber stamp
+annotation, such as its location, dimensions, content, and the stamp name.
+"""
+
+from dataclasses import dataclass
+from typing import Optional
+
+from pypdf.generic import NameObject
+
+from .base import Annotation
+
+
+@dataclass
+class RubberStampAnnotation(Annotation):
+    """
+    Represents a rubber stamp annotation in a PDF document.
+
+    This dataclass extends the base `Annotation` class and defines the specific
+    attributes and metadata associated with a rubber stamp annotation.
+
+    Attributes:
+        _annotation_type (str): The PDF internal type of the annotation, which is "/Stamp".
+        approved (str): The identifier for an "Approved" stamp.
+        experimental (str): The identifier for an "Experimental" stamp.
+        not_approved (str): The identifier for a "NotApproved" stamp.
+        as_is (str): The identifier for an "AsIs" stamp.
+        expired (str): The identifier for an "Expired" stamp.
+        not_for_public_release (str): The identifier for a "NotForPublicRelease" stamp.
+        confidential (str): The identifier for a "Confidential" stamp.
+        final (str): The identifier for a "Final" stamp.
+        sold (str): The identifier for a "Sold" stamp.
+        departmental (str): The identifier for a "Departmental" stamp.
+        for_comment (str): The identifier for a "ForComment" stamp.
+        top_secret (str): The identifier for a "TopSecret" stamp.
+        draft (str): The identifier for a "Draft" stamp.
+        for_public_release (str): The identifier for a "ForPublicRelease" stamp.
+        name (Optional[str]): The name of the stamp to be used.
+    """
+
+    _annotation_type: str = "/Stamp"
+
+    approved = "/Approved"
+    experimental = "/Experimental"
+    not_approved = "/NotApproved"
+    as_is = "/AsIs"
+    expired = "/Expired"
+    not_for_public_release = "/NotForPublicRelease"
+    confidential = "/Confidential"
+    final = "/Final"
+    sold = "/Sold"
+    departmental = "/Departmental"
+    for_comment = "/ForComment"
+    top_secret = "/TopSecret"
+    draft = "/Draft"
+    for_public_release = "/ForPublicRelease"
+
+    name: Optional[str] = None
+
+    def get_specific_properties(self) -> dict:
+        """
+        Gets properties specific to the rubber stamp annotation.
+
+        This method extends the base properties with the stamp name if it is provided.
+
+        Returns:
+            dict: A dictionary of PDF properties specific to the rubber stamp annotation.
+        """
+        result = super().get_specific_properties()
+        if self.name is not None:
+            result[NameObject("/Name")] = NameObject(self.name)
+
+        return result

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/constants.py

@@ -15,13 +15,6 @@ Using constants improves code readability and maintainability by providing
 meaningful names for frequently used values and reducing the risk of typos.
 """
 
-from .middleware.checkbox import Checkbox
-from .middleware.dropdown import Dropdown
-from .middleware.image import Image
-from .middleware.radio import Radio
-from .middleware.signature import Signature
-from .middleware.text import Text
-
 VERSION_IDENTIFIERS = [
     b"%PDF-1.0",
     b"%PDF-1.1",
@@ -35,8 +28,6 @@ VERSION_IDENTIFIERS = [
 ]
 VERSION_IDENTIFIER_PREFIX = "%PDF-".encode("utf-8")
 
-WIDGET_TYPES = Text | Checkbox | Radio | Dropdown | Signature | Image
-
 DEPRECATION_NOTICE = "{} will be deprecated soon. Use {} instead."
 
 Title = "/Title"

pypdfform-4.6.2/PyPDFForm/ap.py → pypdfform-4.7.0/PyPDFForm/egress.py

@@ -1,10 +1,13 @@
 # -*- coding: utf-8 -*-
 """
-A module for handling PDF appearance streams.
-
-This module provides functionality to manage appearance streams in PDF forms,
-which are necessary for form fields to display correctly after being filled.
-It uses both pypdf and pikepdf for manipulation.
+A module for egress functions.
+
+This module provides functionalities that prepare the final PDF for output (egress),
+ensuring that it is properly formatted and ready for the end-user. This includes
+managing appearance streams (so form fields display correctly after being filled),
+handling the /NeedAppearances flag, and preserving or updating document-level
+properties like metadata, title, and OpenAction scripts. These functions are typically
+called right before the final PDF byte stream is returned by the wrapper module.
 """
 
 from functools import lru_cache
@@ -66,18 +69,20 @@ def appearance_streams_handler(pdf: bytes, generate_appearance_streams: bool) ->
     return result
 
 
-@lru_cache
-def preserve_pdf_properties(pdf: bytes, title: str, script: str) -> bytes:
+def preserve_pdf_properties(
+    pdf: bytes, title: str, script: str, metadata: dict
+) -> bytes:
     """
-    Preserves and updates PDF properties such as title and OpenAction scripts.
+    Preserves and updates PDF properties such as metadata, title, and OpenAction scripts.
 
-    This function allows setting or updating the PDF's title in its metadata and
+    This function allows setting or updating the PDF's title and metadata, and
     attaching a JavaScript script that executes when the PDF is opened.
 
     Args:
         pdf (bytes): The PDF file content as a bytes stream.
         title (str): The title to be set in the PDF metadata.
         script (str): JavaScript code to be executed when the PDF is opened.
+        metadata (dict): The original metadata to preserve.
 
     Returns:
         bytes: The modified PDF content as a bytes stream.
@@ -86,11 +91,14 @@ def preserve_pdf_properties(pdf: bytes, title: str, script: str) -> bytes:
     writer = PdfWriter()
     writer.append(reader)
 
-    if title:
-        metadata = reader.metadata or {}
-        metadata[NameObject(Title)] = TextStringObject(title)
+    if title or metadata:
+        _metadata = reader.metadata or {}
+        if metadata:
+            _metadata.update(metadata)
+        if title:
+            _metadata[NameObject(Title)] = TextStringObject(title)
 
-        writer.add_metadata(metadata)
+        writer.add_metadata(_metadata)
 
     if script:
         open_action = DictionaryObject()

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/filler.py

@@ -14,9 +14,10 @@ from typing import Dict, cast
 from pypdf import PdfReader, PdfWriter
 from pypdf.generic import DictionaryObject
 
-from .constants import WIDGET_TYPES, Annots
+from .constants import Annots
 from .hooks import flatten_field
 from .image import get_draw_image_resolutions, get_image_dimensions
+from .middleware import WIDGET_TYPES
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/middleware/__init__.py

@@ -17,6 +17,8 @@ from .radio import Radio
 from .signature import Signature
 from .text import Text
 
+WIDGET_TYPES = Text | Checkbox | Radio | Dropdown | Signature | Image
+
 
 @dataclass
 class Widgets:

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/middleware/base.py

@@ -21,23 +21,6 @@ class Widget:
     as name, value, and schema definition.
     """
 
-    SET_ATTR_TRIGGER_HOOK_MAP = {
-        "x": "update_field_x",
-        "y": "update_field_y",
-        "width": "update_field_width",
-        "height": "update_field_height",
-        "readonly": "flatten_field",
-        "required": "update_field_required",
-        "hidden": "update_field_hidden",
-        "tooltip": "update_field_tooltip",
-        "on_hovered_over_javascript": "update_field_on_hovered_over_javascript",
-        "on_hovered_off_javascript": "update_field_on_hovered_off_javascript",
-        "on_mouse_pressed_javascript": "update_field_on_mouse_pressed_javascript",
-        "on_mouse_released_javascript": "update_field_on_mouse_released_javascript",
-        "on_focused_javascript": "update_field_on_focused_javascript",
-        "on_blurred_javascript": "update_field_on_blurred_javascript",
-    }
-
     def __init__(
         self,
         name: str,
@@ -51,6 +34,22 @@ class Widget:
             value (Any): The initial value of the widget. Defaults to None.
         """
         super().__init__()
+        self.SET_ATTR_TRIGGER_HOOK_MAP = {
+            "x": "update_field_x",
+            "y": "update_field_y",
+            "width": "update_field_width",
+            "height": "update_field_height",
+            "readonly": "flatten_field",
+            "required": "update_field_required",
+            "hidden": "update_field_hidden",
+            "tooltip": "update_field_tooltip",
+            "on_hovered_over_javascript": "update_field_on_hovered_over_javascript",
+            "on_hovered_off_javascript": "update_field_on_hovered_off_javascript",
+            "on_mouse_pressed_javascript": "update_field_on_mouse_pressed_javascript",
+            "on_mouse_released_javascript": "update_field_on_mouse_released_javascript",
+            "on_focused_javascript": "update_field_on_focused_javascript",
+            "on_blurred_javascript": "update_field_on_blurred_javascript",
+        }
         self.attr_set_tracker = {}
 
         self._name = name
@@ -88,7 +87,11 @@ class Widget:
             name (str): The name of the attribute.
             value (Any): The value of the attribute.
         """
-        if name in self.SET_ATTR_TRIGGER_HOOK_MAP and value is not None:
+        if (
+            hasattr(self, "SET_ATTR_TRIGGER_HOOK_MAP")
+            and name in self.SET_ATTR_TRIGGER_HOOK_MAP
+            and value is not None
+        ):
             self.hooks_to_trigger.append((self.SET_ATTR_TRIGGER_HOOK_MAP[name], value))
 
         if (

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/template.py

@@ -16,8 +16,8 @@ from pypdf import PdfReader, PdfWriter
 from pypdf.generic import ArrayObject, DictionaryObject, NameObject
 
 from .annotations import AnnotationTypes
-from .constants import (COMB, MULTILINE, READ_ONLY, REQUIRED, WIDGET_TYPES,
-                        Annots)
+from .constants import COMB, MULTILINE, READ_ONLY, REQUIRED, Annots
+from .middleware import WIDGET_TYPES
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.radio import Radio
@@ -49,27 +49,6 @@ def get_metadata(pdf: bytes) -> dict:
     return reader.metadata or {}
 
 
-def set_metadata(pdf: bytes, metadata: dict) -> bytes:
-    """
-    Sets the metadata of a PDF.
-
-    Args:
-        pdf (bytes): The PDF stream to set metadata for.
-        metadata (dict): A dictionary containing the metadata to be set.
-
-    Returns:
-        bytes: The updated PDF stream with the new metadata.
-    """
-    reader = PdfReader(stream_to_io(pdf))
-    writer = PdfWriter(clone_from=reader)
-    writer.add_metadata(metadata)
-
-    with BytesIO() as f:
-        writer.write(f)
-        f.seek(0)
-        return f.read()
-
-
 def build_widgets(
     pdf_stream: bytes,
     use_full_widget_name: bool,

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/wrapper.py

@@ -27,9 +27,9 @@ from typing import (TYPE_CHECKING, BinaryIO, Dict, Optional, Sequence, TextIO,
 
 from .adapter import (fp_or_f_obj_or_f_content_to_content,
                       fp_or_f_obj_or_stream_to_stream)
-from .ap import appearance_streams_handler, preserve_pdf_properties
 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,
                    register_font_acroform)
@@ -38,7 +38,7 @@ from .middleware.dropdown import Dropdown
 from .middleware.signature import Signature
 from .middleware.text import Text
 from .template import (build_widgets, create_annotations, get_metadata,
-                       set_metadata, update_widget_keys)
+                       update_widget_keys)
 from .types import PdfArray
 from .utils import (generate_unique_suffix, get_page_streams, merge_pdfs,
                     remove_all_widgets)
@@ -362,9 +362,8 @@ class PdfWrapper:
         2. If `need_appearances` is enabled, it handles appearance streams and the
            `/NeedAppearances` flag, which may include removing XFA and explicitly
            generating appearance streams.
-        3. If `preserve_metadata` is enabled, it preserves the original metadata of the PDF.
-        4. If a title or on-open JavaScript is set, it updates the PDF properties
-           accordingly.
+        3. If `preserve_metadata`, title, or on-open JavaScript are set, it preserves
+           or updates the corresponding PDF properties accordingly.
 
         Returns:
             bytes: The processed PDF document content as a byte string.
@@ -376,15 +375,14 @@ class PdfWrapper:
                 result, getattr(self, "generate_appearance_streams")
             )  # cached
 
-        if getattr(self, "preserve_metadata"):
-            # TODO: refactor with preserve_pdf_properties
-            result = set_metadata(result, self._metadata)
-
-        if any([self.title, self.on_open_javascript]):
+        if any(
+            [getattr(self, "preserve_metadata"), self.title, self.on_open_javascript]
+        ):
             result = preserve_pdf_properties(
                 result,
                 self.title,
                 self.on_open_javascript,
+                self._metadata if getattr(self, "preserve_metadata") else None,
             )
 
         return result

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 4.6.2
+Version: 4.7.0
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -31,6 +31,8 @@ Requires-Dist: black<27.0.0,>=25.11.0; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.12.0; extra == "dev"
 Requires-Dist: isort<9.0.0,>=7.0.0; extra == "dev"
 Requires-Dist: jsonschema<5.0.0,>=4.25.1; extra == "dev"
+Requires-Dist: mike<3.0.0,>=2.1.3; extra == "dev"
+Requires-Dist: mkdocs<2.0.0,>=1.6.1; extra == "dev"
 Requires-Dist: mkdocs-material<10.0.0,>=9.7.0; extra == "dev"
 Requires-Dist: pudb<2026.0.0,>=2025.1.3; extra == "dev"
 Requires-Dist: pylint<5.0.0,>=4.0.3; extra == "dev"
@@ -48,7 +50,7 @@ Dynamic: license-file
     <a href="https://pypi.org/project/PyPDFForm/"><img src="https://img.shields.io/pypi/v/pypdfform?label=version&color=magenta"></a>
     <a href="https://chinapandaman.github.io/PyPDFForm/"><img src="https://img.shields.io/github/v/release/chinapandaman/pypdfform?label=docs&color=cyan"></a>
     <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
-    <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
+    <a href="https://github.com/chinapandaman/PyPDFForm/blob/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
     <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
 </p>
@@ -102,6 +104,7 @@ The official documentation can be found on [the GitHub page](https://chinapandam
 
 ## Other Resources
 
+<!-- TODO: remove WIP when finish recording -->
 * [(WIP) Video Tutorials](https://youtube.com/playlist?list=PLNz_PBu1QA-gzYg5BvyOO98q15u5Xve1L&si=8MWasKEckBzY-NRQ)
 * [Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)
 

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm.egg-info/SOURCES.txt

@@ -3,10 +3,10 @@ README.md
 pyproject.toml
 PyPDFForm/__init__.py
 PyPDFForm/adapter.py
-PyPDFForm/ap.py
 PyPDFForm/constants.py
 PyPDFForm/coordinate.py
 PyPDFForm/deprecation.py
+PyPDFForm/egress.py
 PyPDFForm/filler.py
 PyPDFForm/font.py
 PyPDFForm/hooks.py
@@ -25,6 +25,7 @@ PyPDFForm.egg-info/top_level.txt
 PyPDFForm/annotations/__init__.py
 PyPDFForm/annotations/base.py
 PyPDFForm/annotations/link.py
+PyPDFForm/annotations/stamp.py
 PyPDFForm/annotations/text.py
 PyPDFForm/annotations/text_markup.py
 PyPDFForm/assets/__init__.py

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm.egg-info/requires.txt

@@ -10,6 +10,8 @@ black<27.0.0,>=25.11.0
 coverage<8.0.0,>=7.12.0
 isort<9.0.0,>=7.0.0
 jsonschema<5.0.0,>=4.25.1
+mike<3.0.0,>=2.1.3
+mkdocs<2.0.0,>=1.6.1
 mkdocs-material<10.0.0,>=9.7.0
 pudb<2026.0.0,>=2025.1.3
 pylint<5.0.0,>=4.0.3

{pypdfform-4.6.2 → pypdfform-4.7.0}/README.md

@@ -6,7 +6,7 @@
     <a href="https://pypi.org/project/PyPDFForm/"><img src="https://img.shields.io/pypi/v/pypdfform?label=version&color=magenta"></a>
     <a href="https://chinapandaman.github.io/PyPDFForm/"><img src="https://img.shields.io/github/v/release/chinapandaman/pypdfform?label=docs&color=cyan"></a>
     <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
-    <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
+    <a href="https://github.com/chinapandaman/PyPDFForm/blob/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
     <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
 </p>
@@ -60,6 +60,7 @@ The official documentation can be found on [the GitHub page](https://chinapandam
 
 ## Other Resources
 
+<!-- TODO: remove WIP when finish recording -->
 * [(WIP) Video Tutorials](https://youtube.com/playlist?list=PLNz_PBu1QA-gzYg5BvyOO98q15u5Xve1L&si=8MWasKEckBzY-NRQ)
 * [Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)
 

{pypdfform-4.6.2 → pypdfform-4.7.0}/pyproject.toml

@@ -45,6 +45,8 @@ dev = [
     "coverage>=7.12.0,<8.0.0",
     "isort>=7.0.0,<9.0.0",
     "jsonschema>=4.25.1,<5.0.0",
+    "mike>=2.1.3,<3.0.0",
+    "mkdocs>=1.6.1,<2.0.0",
     "mkdocs-material>=9.7.0,<10.0.0",
     "pudb>=2025.1.3,<2026.0.0",
     "pylint>=4.0.3,<5.0.0",

{pypdfform-4.6.2 → pypdfform-4.7.0}/tests/test_functional.py

@@ -884,3 +884,132 @@ def test_annotate_no_annotations(pdf_samples, request):
 
         assert len(obj.read()) == len(expected)
         assert obj.read() == expected
+
+
+def test_rubber_stamp_annotation(template_stream, pdf_samples, request):
+    expected_path = os.path.join(pdf_samples, "test_rubber_stamp_annotation.pdf")
+    with open(expected_path, "rb+") as f:
+        obj = PdfWrapper(template_stream).annotate(
+            [
+                Annotations.RubberStampAnnotation(
+                    1,
+                    0,
+                    400,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.approved,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    100,
+                    400,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.experimental,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    200,
+                    400,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.not_approved,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    300,
+                    400,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.as_is,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    400,
+                    400,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.expired,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    0,
+                    500,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.not_for_public_release,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    100,
+                    500,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.confidential,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    200,
+                    500,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.final,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    300,
+                    500,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.sold,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    400,
+                    500,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.departmental,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    0,
+                    600,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.for_comment,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    100,
+                    600,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.top_secret,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    200,
+                    600,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.draft,
+                ),
+                Annotations.RubberStampAnnotation(
+                    1,
+                    300,
+                    600,
+                    width=50,
+                    height=50,
+                    name=Annotations.RubberStampAnnotation.for_public_release,
+                ),
+            ]
+        )
+
+        request.config.results["expected_path"] = expected_path
+        request.config.results["stream"] = obj.read()
+
+        expected = f.read()
+
+        assert len(obj.read()) == len(expected)
+        assert obj.read() == expected

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/middleware/checkbox.py

@@ -35,12 +35,12 @@ class Checkbox(Widget):
         Attributes:
             size (int): The size of the checkbox. Defaults to None.
         """
+        super().__init__(name, value)
         self.SET_ATTR_TRIGGER_HOOK_MAP.update(
             {
                 "size": "update_check_radio_size",
             }
         )
-        super().__init__(name, value)
 
         self.size: Optional[float] = None
 

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/middleware/dropdown.py

@@ -44,15 +44,15 @@ class Dropdown(Widget):
             font (str): The font of the dropdown field.
             choices (List[str]): The list of choices for the dropdown.
         """
+        super().__init__(name, value)
         self.SET_ATTR_TRIGGER_HOOK_MAP.update(
             {
                 "font": "update_text_field_font",
+                "choices": "update_dropdown_choices",
                 "font_size": "update_text_field_font_size",
                 "font_color": "update_text_field_font_color",
-                "choices": "update_dropdown_choices",
             }
         )
-        super().__init__(name, value)
 
         self.font: Optional[str] = None
         self.font_size: Optional[float] = None

{pypdfform-4.6.2 → pypdfform-4.7.0}/PyPDFForm/middleware/text.py

@@ -45,6 +45,7 @@ class Text(Widget):
             multiline (bool): Whether the text field is multiline. Defaults to None.
             max_length (int): The maximum length of the text field. Defaults to None.
         """
+        super().__init__(name, value)
         self.SET_ATTR_TRIGGER_HOOK_MAP.update(
             {
                 "font": "update_text_field_font",
@@ -56,7 +57,6 @@ class Text(Widget):
                 "max_length": "update_text_field_max_length",
             }
         )
-        super().__init__(name, value)
 
         self.font: Optional[str] = None
         self.font_size: Optional[float] = None