PyPDFForm 2.2.7__tar.gz → 2.3.1__tar.gz

{pypdfform-2.2.7 → pypdfform-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.2.7
+Version: 2.3.1
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -49,15 +49,6 @@ Dynamic: license-file
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important Announcements
-
-Hello fellow Python developers! With the release of v2.0.0, there are some important changes I'm making to the library:
-
-* Since I started developing the library, versioning releases has been quite unorthodox, and there isn't any convention I followed. Starting with v2.0.0, PyPDFForm will version releases following the conventions defined by [Semantic Versioning](https://semver.org/).
-* PyPDFForm now renders PDF form widgets! Ever since its ancestral stage, the library has only been able to render the data you filled into a PDF form. Now if you fill a PDF form using `PdfWrapper`, the result will render the whole widget instead of just the value that got filled. If you would like to disable this behavior, please refer to the docs [here](https://chinapandaman.github.io/PyPDFForm/fill/#disable-rendering-widgets).
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/__init__.py

@@ -5,7 +5,7 @@ This package provides tools for filling PDF forms, drawing text and images,
 and manipulating PDF form elements programmatically.
 """
 
-__version__ = "2.2.7"
+__version__ = "2.3.1"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/filler.py

@@ -333,10 +333,8 @@ def enable_adobe_mode(reader: PdfReader, writer: PdfWriter, adobe_mode: bool) ->
         writer.root_object.update(
             {NameObject(AcroForm): IndirectObject(len(writer.root_object), 0, writer)}
         )
-    writer.root_object[AcroForm][NameObject(NeedAppearances)] = BooleanObject(  # noqa
-        True
-    )
-    writer.root_object[AcroForm][NameObject(Fields)] = ArrayObject()  # noqa
+    writer.root_object[AcroForm][NameObject(NeedAppearances)] = BooleanObject(True)
+    writer.root_object[AcroForm][NameObject(Fields)] = ArrayObject()
 
 
 def simple_fill(
@@ -370,7 +368,7 @@ def simple_fill(
     radio_button_tracker = {}
 
     for page in out.pages:
-        for annot in page.get(Annots, []):  # noqa
+        for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
             key = extract_widget_property(
                 annot.get_object(), WIDGET_KEY_PATTERNS, None, str

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/patterns.py

@@ -149,7 +149,7 @@ def simple_update_checkbox_value(annot: DictionaryObject, check: bool = False) -
         check: Whether the checkbox should be checked (True) or unchecked (False)
     """
 
-    for each in annot[AP][N]:  # noqa
+    for each in annot[AP][N]:
         if (check and str(each) != Off) or (not check and str(each) == Off):
             annot[NameObject(AS)] = NameObject(each)
             annot[NameObject(V)] = NameObject(each)
@@ -169,12 +169,12 @@ def simple_update_radio_value(annot: DictionaryObject) -> None:
     """
 
     if Opt in annot[Parent]:
-        del annot[Parent][Opt]  # noqa
+        del annot[Parent][Opt]
 
-    for each in annot[AP][N]:  # noqa
+    for each in annot[AP][N]:
         if str(each) != Off:
             annot[NameObject(AS)] = NameObject(each)
-            annot[NameObject(Parent)][NameObject(V)] = NameObject(each)  # noqa
+            annot[NameObject(Parent)][NameObject(V)] = NameObject(each)
             break
 
 
@@ -191,7 +191,7 @@ def simple_update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> N
     """
 
     if Parent in annot and T not in annot:
-        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(  # noqa
+        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(
             widget.choices[widget.value]
         )
         annot[NameObject(AP)] = TextStringObject(widget.choices[widget.value])
@@ -214,9 +214,7 @@ def simple_update_text_value(annot: DictionaryObject, widget: Text) -> None:
     """
 
     if Parent in annot and T not in annot:
-        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(  # noqa
-            widget.value
-        )
+        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(widget.value)
         annot[NameObject(AP)] = TextStringObject(widget.value)
     else:
         annot[NameObject(V)] = TextStringObject(widget.value)
@@ -234,8 +232,8 @@ def simple_flatten_radio(annot: DictionaryObject) -> None:
         annot: PDF radio button annotation dictionary to flatten
     """
 
-    annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(  # noqa
-        int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) | READ_ONLY  # noqa
+    annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+        int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) | READ_ONLY
     )
 
 
@@ -251,12 +249,12 @@ def simple_flatten_generic(annot: DictionaryObject) -> None:
     """
 
     if Parent in annot and Ff not in annot:
-        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(  # noqa
-            int(annot.get(NameObject(Ff), 0)) | READ_ONLY  # noqa
+        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+            int(annot.get(NameObject(Ff), 0)) | READ_ONLY
         )
     else:
         annot[NameObject(Ff)] = NumberObject(
-            int(annot.get(NameObject(Ff), 0)) | READ_ONLY  # noqa
+            int(annot.get(NameObject(Ff), 0)) | READ_ONLY
         )
 
 
@@ -272,9 +270,9 @@ def update_annotation_name(annot: DictionaryObject, val: str) -> None:
     """
 
     if Parent in annot and T not in annot:
-        annot[NameObject(Parent)][NameObject(T)] = TextStringObject(val)  # noqa
+        annot[NameObject(Parent)][NameObject(T)] = TextStringObject(val)
     else:
-        annot[NameObject(T)] = TextStringObject(val)  # noqa
+        annot[NameObject(T)] = TextStringObject(val)
 
 
 def update_created_text_field_alignment(annot: DictionaryObject, val: int) -> None:
@@ -303,9 +301,7 @@ def update_created_text_field_multiline(annot: DictionaryObject, val: bool) -> N
     """
 
     if val:
-        annot[NameObject(Ff)] = NumberObject(
-            int(annot[NameObject(Ff)]) | MULTILINE  # noqa
-        )
+        annot[NameObject(Ff)] = NumberObject(int(annot[NameObject(Ff)]) | MULTILINE)
 
 
 NON_ACRO_FORM_PARAM_TO_FUNC = {

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/template.py

@@ -39,21 +39,30 @@ from .utils import (extract_widget_property, find_pattern_match, handle_color,
 
 
 def set_character_x_paddings(
-    pdf_stream: bytes, widgets: Dict[str, WIDGET_TYPES]
+    pdf_stream: bytes,
+    widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
 ) -> Dict[str, WIDGET_TYPES]:
-    """Calculates and sets character spacing for comb text fields.
+    """Calculates and sets character spacing for comb text fields in PDF forms.
+
+    This function processes each widget in the PDF form and calculates the horizontal spacing
+    between characters for comb text fields (fixed-width text fields). The spacing is stored
+    in the widget's character_paddings property.
 
     Args:
-        pdf_stream: PDF form as bytes
-        widgets: Dictionary of widget middleware objects
+        pdf_stream (bytes): PDF form as bytes
+        widgets (Dict[str, WIDGET_TYPES]): Dictionary of widget middleware objects
+        use_full_widget_name (bool): Whether to use full widget names including parent names
 
     Returns:
-        Dict[str, WIDGET_TYPES]: Updated widgets with character paddings
+        Dict[str, WIDGET_TYPES]: Updated widget dictionary with character paddings set for comb fields
     """
 
     for _widgets in get_widgets_by_page(pdf_stream).values():
         for widget in _widgets:
             key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
+            if use_full_widget_name:
+                key = get_widget_full_key(widget)
             _widget = widgets[key]
 
             if isinstance(_widget, Text) and _widget.comb is True:
@@ -166,23 +175,35 @@ def dropdown_to_text(dropdown: Dropdown) -> Text:
 def update_text_field_attributes(
     template_stream: bytes,
     widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
 ) -> None:
-    """Updates text field properties based on PDF template settings.
+    """Update text field properties in a PDF form template.
 
-    Handles:
-    - Font detection and sizing
-    - Color properties
-    - Paragraph wrapping
-    - Auto font size adjustment
+    Processes text field widgets in the template to update their visual attributes including:
+    - Font properties (family, size, color)
+    - Text alignment and wrapping behavior
+    - Auto-sizing of text to fit within field bounds
+    - Multi-line text field formatting
 
     Args:
-        template_stream: PDF form as bytes
-        widgets: Dictionary of widget middleware objects
+        template_stream: Raw bytes of the PDF template containing form fields
+        widgets: Dictionary mapping field names to widget objects to update
+        use_full_widget_name: If True, uses full hierarchical widget names including parent keys.
+            When False (default), uses simple field names.
+
+    Returns:
+        None: Modifies widget objects in-place
+
+    Note:
+        This function modifies the widget objects in-place and does not return anything.
+        Changes include font properties, text alignment, and auto-wrapping settings.
     """
 
     for _widgets in get_widgets_by_page(template_stream).values():
         for _widget in _widgets:
             key = extract_widget_property(_widget, WIDGET_KEY_PATTERNS, None, str)
+            if use_full_widget_name:
+                key = get_widget_full_key(_widget)
 
             if isinstance(widgets[key], Text):
                 should_adjust_font_size = False
@@ -569,7 +590,7 @@ def update_widget_keys(
         new_key = new_keys[i]
         tracker = -1
         for page in out.pages:
-            for annot in page.get(Annots, []):  # noqa
+            for annot in page.get(Annots, []):
                 annot = cast(DictionaryObject, annot.get_object())
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/watermark.py

@@ -380,7 +380,7 @@ def copy_watermark_widgets(
         watermark_file = PdfReader(stream_to_io(watermark))
         for j, page in enumerate(watermark_file.pages):
             widgets_to_copy_pdf[j] = []
-            for annot in page.get(Annots, []):  # noqa
+            for annot in page.get(Annots, []):
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str
                 )
@@ -393,7 +393,7 @@ def copy_watermark_widgets(
     for i, page in enumerate(out.pages):
         if i in widgets_to_copy:
             page[NameObject(Annots)] = (
-                (page[NameObject(Annots)] + ArrayObject(widgets_to_copy[i]))  # noqa
+                (page[NameObject(Annots)] + ArrayObject(widgets_to_copy[i]))
                 if Annots in page
                 else ArrayObject(widgets_to_copy[i])
             )

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/widgets/base.py

@@ -83,7 +83,7 @@ class Widget:
                     )
                 self.acro_form_params[param] = value
             elif user_input in self.NONE_DEFAULTS:
-                self.acro_form_params[param] = None  # noqa
+                self.acro_form_params[param] = None
 
         for each in self.ALLOWED_NON_ACRO_FORM_PARAMS:
             if each in kwargs:
@@ -154,7 +154,7 @@ def handle_non_acro_form_params(pdf: bytes, key: str, params: list) -> bytes:
     out.append(pdf_file)
 
     for page in out.pages:
-        for annot in page.get(Annots, []):  # noqa
+        for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
             _key = extract_widget_property(
                 annot.get_object(), WIDGET_KEY_PATTERNS, None, str

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/widgets/signature.py

@@ -101,12 +101,12 @@ class SignatureWidget:
 
         input_pdf = PdfReader(stream_to_io(stream))
         page_count = len(input_pdf.pages)
-        pdf = PdfReader(stream_to_io(BEDROCK_PDF))  # noqa
+        pdf = PdfReader(stream_to_io(BEDROCK_PDF))
         out = PdfWriter()
         out.append(pdf)
 
         for page in out.pages:
-            for annot in page.get(Annots, []):  # noqa
+            for annot in page.get(Annots, []):
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str
                 )

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm/wrapper.py

@@ -432,9 +432,13 @@ class PdfWrapper(FormWrapper):
             if isinstance(value, Dropdown):
                 self.widgets[key] = dropdown_to_text(value)
 
-        update_text_field_attributes(self.stream, self.widgets)
+        update_text_field_attributes(
+            self.stream, self.widgets, getattr(self, "use_full_widget_name")
+        )
         if self.read():
-            self.widgets = set_character_x_paddings(self.stream, self.widgets)
+            self.widgets = set_character_x_paddings(
+                self.stream, self.widgets, getattr(self, "use_full_widget_name")
+            )
 
         self.stream = remove_all_widgets(
             fill(self.stream, self.widgets, getattr(self, "use_full_widget_name"))

{pypdfform-2.2.7 → pypdfform-2.3.1}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.2.7
+Version: 2.3.1
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -49,15 +49,6 @@ Dynamic: license-file
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important Announcements
-
-Hello fellow Python developers! With the release of v2.0.0, there are some important changes I'm making to the library:
-
-* Since I started developing the library, versioning releases has been quite unorthodox, and there isn't any convention I followed. Starting with v2.0.0, PyPDFForm will version releases following the conventions defined by [Semantic Versioning](https://semver.org/).
-* PyPDFForm now renders PDF form widgets! Ever since its ancestral stage, the library has only been able to render the data you filled into a PDF form. Now if you fill a PDF form using `PdfWrapper`, the result will render the whole widget instead of just the value that got filled. If you would like to disable this behavior, please refer to the docs [here](https://chinapandaman.github.io/PyPDFForm/fill/#disable-rendering-widgets).
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

{pypdfform-2.2.7 → pypdfform-2.3.1}/README.md

@@ -8,15 +8,6 @@
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important Announcements
-
-Hello fellow Python developers! With the release of v2.0.0, there are some important changes I'm making to the library:
-
-* Since I started developing the library, versioning releases has been quite unorthodox, and there isn't any convention I followed. Starting with v2.0.0, PyPDFForm will version releases following the conventions defined by [Semantic Versioning](https://semver.org/).
-* PyPDFForm now renders PDF form widgets! Ever since its ancestral stage, the library has only been able to render the data you filled into a PDF form. Now if you fill a PDF form using `PdfWrapper`, the result will render the whole widget instead of just the value that got filled. If you would like to disable this behavior, please refer to the docs [here](https://chinapandaman.github.io/PyPDFForm/fill/#disable-rendering-widgets).
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

{pypdfform-2.2.7 → pypdfform-2.3.1}/pyproject.toml

@@ -106,7 +106,7 @@ select = [
     "YTT",
     "W",
 ]
-ignore = ["B009", "E501", "N999", "TC006"]
+ignore = ["B009", "E501", "N999", "Q000", "TC006"]
 
 [tool.pyright]
 typeCheckingMode = "basic"